Tfa
extends Facade
in package
Table of Contents
Properties
- $container : Container
- $instance : mixed
Methods
- __callStatic() : mixed
- authenticate() : TfaAuthResult
- checkAuthority() : bool
- checkCorrectTime() : bool
- clearInstance() : void
- テスト用: ファサードがキャッシュしている解決済みインスタンスを破棄する。
- createSecret() : string
- getInstance() : mixed
- get service instance
- getSecretForManual() : string
- getSecretForQRCode() : string
- hasValidSecretKey() : bool
- isAvailable() : bool
- isAvailableAccount() : bool
- setContainer() : void
- swap() : void
- テスト用: サービスインスタンスをスタブ等へ差し替える。
- verifyCode() : bool
- getServiceAlias() : string
- getServiceInstance() : mixed
- isCache() : bool
Properties
$container
protected
static Container
$container
$instance
protected
static mixed
$instance
Methods
__callStatic()
public
static __callStatic(string $method, array<string|int, mixed> $arguments) : mixed
Parameters
- $method : string
- $arguments : array<string|int, mixed>
authenticate()
public
static authenticate(int $uid, string $code) : TfaAuthResult
認証結果を取得
Parameters
- $uid : int
- $code : string
Return values
TfaAuthResultcheckAuthority()
public
static checkAuthority() : bool
権限をチェック
Return values
boolcheckCorrectTime()
public
static checkCorrectTime() : bool
サーバー時間が正しいかチェック
Return values
boolclearInstance()
テスト用: ファサードがキャッシュしている解決済みインスタンスを破棄する。
public
static clearInstance() : void
isCache() が true のファサードは解決済みインスタンスを静的プロパティ $instance に 保持するため、コンテナ側だけを差し替えても反映されない。本メソッドでキャッシュを 無効化し、次回アクセスでコンテナから再解決させる。
createSecret()
public
static createSecret() : string
秘密鍵を作成
Return values
stringgetInstance()
get service instance
public
static getInstance() : mixed
getSecretForManual()
public
static getSecretForManual(string $secret) : string
秘密鍵の手動入力用文字列を取得
Parameters
- $secret : string
Return values
stringgetSecretForQRCode()
public
static getSecretForQRCode(string $secret, string $label) : string
秘密鍵のQRコード画像を取得
Parameters
- $secret : string
- $label : string
Return values
stringhasValidSecretKey()
public
static hasValidSecretKey(int $uid) : bool
秘密鍵が登録済みかつ復号可能か判定
Parameters
- $uid : int
Return values
boolisAvailable()
public
static isAvailable() : bool
2段階認証が有効か判定
Return values
boolisAvailableAccount()
public
static isAvailableAccount(int $uid) : bool
2段階認証が有効なアカウントか判定
Parameters
- $uid : int
Return values
boolsetContainer()
public
static setContainer(Container $container) : void
Parameters
- $container : Container
swap()
テスト用: サービスインスタンスをスタブ等へ差し替える。
public
static swap(object $instance) : void
DI コンテナのエイリアスを差し替えたうえで、ファサードがキャッシュしている解決済み インスタンス（isCache() が true の場合）を破棄し、次回アクセス時に差し替え後の インスタンスを再解決させる。テスト後は元のインスタンスを渡して再度呼び出し復元する。
Parameters
- $instance : object
verifyCode()
public
static verifyCode(string $secret, string $code) : bool
コードを検証
Parameters
- $secret : string
- $code : string
Return values
boolgetServiceAlias()
protected
static getServiceAlias() : string
Return values
stringgetServiceInstance()
protected
static getServiceInstance(string $alias) : mixed
Parameters
- $alias : string
isCache()
protected
static isCache() : bool