ValidateAuthUrl
メール認証のURLを検証するための機能
Table of Contents
Properties
Methods
- consumeToken() : bool
- 検証済みトークンを1回だけ原子的に消費する（単一使用の担保）
- getTokenKey() : string
- トークンのキーを取得
- getTokenType() : string
- トークンのタイプを取得
- isAuthUrl() : bool
- 現在のURLが認証URLかチェック
- removeToken() : void
- 使用したトークンを削除
- validateAuthUrl() : array<string|int, mixed>
- 認証URLを検証
- validateToken() : array<string|int, mixed>
- 認証URLのトークンと保存してあるトークンを比較
- validateUrl() : array<string|int, mixed>
- 認証URlを検証
Properties
$key
トークンのキーを削除要に保持
protected
string
$key
$token
消費対象の平文トークンを保持
protected
string
$token
= ''
$type
トークンのタイプを削除用に保持
protected
string
$type
Methods
consumeToken()
検証済みトークンを1回だけ原子的に消費する（単一使用の担保）
protected
consumeToken() : bool
validateToken() が保持した対象トークンだけを削除し、削除できた場合のみ true を返す。パスワード更新などの本処理を実行する前にこれで門番することで、 同一リンクの二重送信・使用後の再利用を防ぐ。
Return values
bool —消費できたら true、既に使用済み・不一致なら false
getTokenKey()
トークンのキーを取得
protected
abstract getTokenKey() : string
Return values
stringgetTokenType()
トークンのタイプを取得
protected
abstract getTokenType() : string
Return values
stringisAuthUrl()
現在のURLが認証URLかチェック
protected
isAuthUrl() : bool
Return values
boolremoveToken()
使用したトークンを削除
protected
removeToken() : void
token_value まで一致する対象トークンのみを削除する（consumeToken() に委譲し、 戻り値は見ない）。以前は key/type 一致だけで削除しており、同じ区分 （例: signup-confirmation）の他ユーザーのトークンまで巻き込んで消していた （CMS-7923）。消費の成否を判定したい場合は consumeToken() を直接使う。
validateAuthUrl()
認証URLを検証
protected
validateAuthUrl() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>validateToken()
認証URLのトークンと保存してあるトークンを比較
protected
validateToken(string $token) : array<string|int, mixed>
Parameters
- $token : string
Return values
array<string|int, mixed>validateUrl()
認証URlを検証
protected
validateUrl(string $key, string $salt, string $context) : array<string|int, mixed>
Parameters
- $key : string
- $salt : string
- $context : string