API Documentation
\

\BEAR_Form_Token

BEAR_Form_Token

BEARフレームワークで使われる基底クラスです。

BEARのクラスはBEAR::factoryやBEAR::dependency()によって以下の順でインスタンス化されます。

1) コンストラクタで設定を行う 2) 設定に基づいてインジェクタで必要なサービスをプロパティに用意

Summary

Methods
Properties
Constants
__construct()
onInject()
setConfig()
getConfig()
setService()
newSessionToken()
getToken()
isTokenCsrfValid()
isTokenPoeValid()
No public properties found
SESSION_TOKEN
SESSION_POE
SESSION_CSRF_LEN
SESSION_POE_LEN
_exception()
_getRndToken()
$_config
$_tokenStrage
$_submitToken
N/A
No private methods found
No private properties found
N/A

Constants

SESSION_TOKEN

SESSION_TOKEN

セッショントークンキー名

SESSION_POE

SESSION_POE

POE(Post Once Exactly)用トークンキー配列セッションキー名

SESSION_CSRF_LEN

SESSION_CSRF_LEN

CSRFキーの長さ

SESSION_POE_LEN

SESSION_POE_LEN

POEキーの長さ

Properties

$_config

$_config : array

Class config

Type

array

$_submitToken

$_submitToken : string

Submit token

Type

string

Methods

__construct()

__construct(array  $config)

Universal constructor

設定を_configプロパティに代入します。

Parameters

array $config

ユーザー設定値

onInject()

onInject() : void

Inject

設定にしたがってサービスをインジェクトします。

setConfig()

setConfig(mixed  $config, mixed  $values = null) : self

Set config

Parameters

mixed $config

(string) 設定キー | (array) 設定配列
mixed $values

(string) $configの時の設定値

Returns

self

getConfig()

getConfig(string  $key = null) : mixed

Get config

Parameters

string $key

設定キー、指定なければ全ての設定を取得

Returns

mixed

setService()

setService(string  $name, mixed  $service) : void

Set service

Parameters

string $name

サービスキー
mixed $service

サービス

newSessionToken()

newSessionToken() : \BEAR_Ro

トークン作成

Returns

\BEAR_Ro

getToken()

getToken()

トークンの取得

isTokenCsrfValid()

isTokenCsrfValid() : boolean

サブミットされたトークンにCSRFの問題はないか

Returns

boolean

isTokenPoeValid()

isTokenPoeValid() : boolean

サブミットされたトークンにPOEの問題はないか

Returns

boolean

_exception()

_exception(string  $msg, array  $config = array()) : \BEAR_Exception

例外の作成

Parameters

string $msg

例外メッセージ
array $config

例外config

Returns

\BEAR_Exception

_getRndToken()

_getRndToken(string  $salt, integer  $length = null) : string

任意の長さの乱数文字列の取得

Parameters

string $salt
integer $length

Returns

string