AuthSystemResolution
in package
認証系URLの解決結果を表す値オブジェクト
getAuthSystemTemplate() 相当の解決処理（resolveAuthSystemRequest()）が返す。 「テンプレートを表示する」「ログイン画面へリダイレクトする」「認証系URLに該当しない」の 3状態を AuthSystemResolutionType で表現し、リダイレクトという副作用は 呼び出し側（main.php）が isRedirect()/isTemplate() の判定を見て実行する。 TfaSecretKeyResult と同じ「private コンストラクタ + 名前付きファクトリ + isXxx() 判定」の形に揃える。
Table of Contents
Properties
- $type : AuthSystemResolutionType
- $redirectTo : string|null
- $template : string|null
Methods
- getRedirectTo() : "login"|"signin"
- リダイレクト先の認証ページを取得する。isRedirect() が false の状態で呼ぶと例外。
- getTemplate() : string
- 表示するテンプレートパスを取得する。isTemplate() が false の状態で呼ぶと例外。
- isNone() : bool
- 認証系URLに該当しない（通常のテンプレート処理へ進む）かどうか
- isRedirect() : bool
- 認証ページへリダイレクトすべきかどうか
- isTemplate() : bool
- 表示すべき有効なテンプレートが解決されたかどうか
- none() : self
- 認証系URLに該当しない（通常のテンプレート処理へ進む）解決結果を生成する
- redirect() : self
- 認証ページ（管理者ログイン/会員サインイン）へリダイレクトする解決結果を生成する
- template() : self
- テンプレートを表示する解決結果を生成する
- __construct() : mixed
Properties
$type read-only
public
AuthSystemResolutionType
$type
$redirectTo read-only
private
string|null
$redirectTo
$template read-only
private
string|null
$template
Methods
getRedirectTo()
リダイレクト先の認証ページを取得する。isRedirect() が false の状態で呼ぶと例外。
public
getRedirectTo() : "login"|"signin"
Return values
"login"|"signin"getTemplate()
表示するテンプレートパスを取得する。isTemplate() が false の状態で呼ぶと例外。
public
getTemplate() : string
Return values
stringisNone()
認証系URLに該当しない（通常のテンプレート処理へ進む）かどうか
public
isNone() : bool
Return values
boolisRedirect()
認証ページへリダイレクトすべきかどうか
public
isRedirect() : bool
Return values
boolisTemplate()
表示すべき有効なテンプレートが解決されたかどうか
public
isTemplate() : bool
tplConfig() が未設定キーに対して空文字を返しうるため、空文字は
「有効なテンプレートなし」として扱う（旧 getAuthSystemTemplate() 時代の
is_string($authPath) && $authPath !== '' と同じ判定基準を踏襲）。
Return values
boolnone()
認証系URLに該当しない（通常のテンプレート処理へ進む）解決結果を生成する
public
static none() : self
Return values
selfredirect()
認証ページ（管理者ログイン/会員サインイン）へリダイレクトする解決結果を生成する
public
static redirect("login"|"signin" $authPage) : self
Parameters
- $authPage : "login"|"signin"
-
リダイレクト先
Return values
selftemplate()
テンプレートを表示する解決結果を生成する
public
static template(string $path) : self
Parameters
- $path : string
-
表示するテンプレートパス
Return values
self__construct()
private
__construct(AuthSystemResolutionType $type, string|null $template, "login"|"signin"|null $redirectTo) : mixed
Parameters
- $type : AuthSystemResolutionType
- $template : string|null
-
表示するテンプレートパス（テンプレート表示の場合）。それ以外は null
- $redirectTo : "login"|"signin"|null
-
リダイレクト先の認証ページ（リダイレクトの場合）。それ以外は null