Docs For Class SC_Helper

constructor SC_Helper_Session [line 27]

SC_Helper_Session SC_Helper_Session(
)

デフォルトコンストラクタ.

各関数をセッションハンドラに保存する

[ Top ]

method adminAuthorization [line 214]

void adminAuthorization(
)

管理画面の認証を行う.

mtb_auth_excludes へ登録されたページは, 認証を除外する.

[ Top ]

method destroyToken [line 203]

void destroyToken(
)

トランザクショントークンを破棄する.

[ Top ]

method getToken [line 153]

string getToken(
)

トランザクショントークンを生成し, 取得する.

悪意のある不正な画面遷移を防止するため, 予測困難な文字列を生成して返す. 同時に, この文字列をセッションに保存する.

この関数を使用するためには, 生成した文字列を次画面へ渡すパラメーターとして出力する必要がある.

例) <input type="hidden" name="transactionid" value="この関数の返り値" />

遷移先のページで, LC_Page::isValidToken() の返り値をチェックすることにより, 画面遷移の妥当性が確認できる.

Tags:

return:	トランザクショントークンの文字列
access:	protected

[ Top ]

method isValidToken [line 188]

boolean isValidToken(
[boolean
$is_unset = false])

トランザクショントークンの妥当性をチェックする.

生成されたトランザクショントークンの妥当性をチェックする. この関数を使用するためには, 前画面のページクラスで LC_Page::getToken() を呼んでおく必要がある.

トランザクショントークンは, SC_Helper_Session::getToken() が呼ばれた際に生成される. 引数 $is_unset が false の場合は, トークンの妥当性検証が不正な場合か, セッションが破棄されるまで, トークンを保持する. 引数 $is_unset が true の場合は, 妥当性検証後に破棄される.

Tags:

return:	トランザクショントークンが有効な場合 true
access:	protected

Parameters:

boolean

$is_unset

妥当性検証後, トークンを unset する場合 true; デフォルト値は false

[ Top ]

method sfSessClose [line 56]

bool sfSessClose(
)

セッションを閉じる.

Tags:

return:

セッションが正常に終了した場合 true

[ Top ]

method sfSessDestroy [line 114]

bool sfSessDestroy(
string
$id)

セッションを破棄する.

Tags:

return:

セッションを正常に破棄した場合 true

Parameters:

string

$id

セッションID

[ Top ]

method sfSessGc [line 127]

void sfSessGc(
integer
$maxlifetime)

ガーベジコレクションを実行する.

引数 $maxlifetime の代りに定数 MAX_LIFETIME を使用する.

Parameters:

integer

$maxlifetime

セッションの有効期限(使用しない)

[ Top ]

method sfSessOpen [line 47]

bool sfSessOpen(
string
$save_path, string
$session_name)

セッションを開始する.

Tags:

return:

セッションが正常に開始された場合 true

Parameters:

string	$save_path	セッションを保存するパス(使用しない)
string	$session_name	セッション名(使用しない)

[ Top ]

method sfSessRead [line 66]

string sfSessRead(
string
$id)

セッションのデータをDBから読み込む.

Tags:

return:

セッションデータの値

Parameters:

string

$id

セッションID

[ Top ]

method sfSessWrite [line 83]

bool sfSessWrite(
string
$id, string
$sess_data)

セッションのデータをDBに書き込む.

Tags:

return:

セッションの書き込みに成功した場合 true

Parameters:

string	$id	セッションID
string	$sess_data	セッションデータの値

[ Top ]

Class: SC_Helper_Session

Class Overview

Author(s):

Version:

Variables

Methods

Class Details

Tags:

Class Variables

$objDb =

Class Methods

constructor SC_Helper_Session [line 27]

method adminAuthorization [line 214]

method destroyToken [line 203]

method getToken [line 153]

Tags:

method isValidToken [line 188]

Tags:

Parameters:

method sfSessClose [line 56]

Tags:

method sfSessDestroy [line 114]

Tags:

Parameters:

method sfSessGc [line 127]

Parameters:

method sfSessOpen [line 47]

Tags:

Parameters:

method sfSessRead [line 66]

Tags:

Parameters:

method sfSessWrite [line 83]

Tags:

Parameters: