a-blog cms PHP API Reference

CreateAuthUrl

認証URLを作成し、メール認証するための機能

Table of Contents

Methods

createAuthQueryParams()  : string
認証パラメータを組み立て
createAuthUrl()  : string
有効期限付きの認証用URLを作成
createToken()  : string
ランダムなトークンを生成
getBccAddress()  : string
認証メールのBCCアドレスを取得
getBodyHtmlMailTemplate()  : string
　認証メールの本文（HTML）テンプレートを取得
getBodyMailTemplate()  : string
認証メールの本文テンプレートを取得
getFromAddress()  : string
認証メールの送信元アドレスを取得
getSubjectMailTemplate()  : string
認証メールの件名テンプレートを取得
getTokenKey()  : string
トークンのキーを取得
getTokenType()  : string
トークンのタイプを取得
saveToken()  : void
あとで比較用にトークンを保存
send()  : bool
認証メールを送信

Methods

createAuthQueryParams()

認証パラメータを組み立て

protected createAuthQueryParams(string $token, int $lifetime) : string
Parameters
$token : string
$lifetime : int
Return values
string

createAuthUrl()

有効期限付きの認証用URLを作成

protected createAuthUrl(array<string|int, mixed> $urlContext, string $token, array<string|int, mixed> $data, int $lifetime) : string
Parameters
$urlContext : array<string|int, mixed>
$token : string
$data : array<string|int, mixed>
$lifetime : int
Return values
string

createToken()

ランダムなトークンを生成

protected createToken() : string
Return values
string

getBccAddress()

認証メールのBCCアドレスを取得

protected abstract getBccAddress() : string
Return values
string

getBodyHtmlMailTemplate()

　認証メールの本文（HTML）テンプレートを取得

protected abstract getBodyHtmlMailTemplate() : string
Return values
string

getBodyMailTemplate()

認証メールの本文テンプレートを取得

protected abstract getBodyMailTemplate() : string
Return values
string

getFromAddress()

認証メールの送信元アドレスを取得

protected abstract getFromAddress() : string
Return values
string

getSubjectMailTemplate()

認証メールの件名テンプレートを取得

protected abstract getSubjectMailTemplate() : string
Return values
string

getTokenKey()

トークンのキーを取得

protected abstract getTokenKey() : string
Return values
string

getTokenType()

トークンのタイプを取得

protected abstract getTokenType() : string
Return values
string

saveToken()

あとで比較用にトークンを保存

protected saveToken(string $token, array<string|int, mixed> $data, int $lifetime) : void
Parameters
$token : string
$data : array<string|int, mixed>
$lifetime : int

send()

認証メールを送信

protected send(string $to, Field_Validation $inputField, string $authUrl) : bool
Parameters
$to : string
$inputField : Field_Validation
$authUrl : string
Tags
throws
Exception
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results