EC-CUBE
Public メソッド | 変数
クラス SC_Helper_Session
SC_Helper_Sessionに対する継承グラフ
Inheritance graph
[凡例]

Public メソッド

 SC_Helper_Session ()
 sfSessOpen ($save_path, $session_name)
 sfSessClose ()
 sfSessRead ($id)
 sfSessWrite ($id, $sess_data)
 sfSessDestroy ($id)
 sfSessGc ($maxlifetime)
 getToken ()
 createToken ()
 isValidToken ($is_unset=false)
 destroyToken ()
 adminAuthorization ()

変数

 $objDb

関数

管理画面の認証を行う.

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

戻り値:
void

トランザクショントークン用の予測困難な文字列を生成して返す.

private

戻り値:
string トランザクショントークン用の文字列

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

戻り値:
void
getToken ( )

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

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

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

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

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

protected

戻り値:
string トランザクショントークンの文字列
isValidToken ( is_unset = false)

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

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

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

protected

引数:
boolean$is_unset妥当性検証後, トークンを unset する場合 true; デフォルト値は false
戻り値:
boolean トランザクショントークンが有効な場合 true

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

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

セッションを閉じる.

戻り値:
bool セッションが正常に終了した場合 true
sfSessDestroy ( id)

セッションを破棄する.

引数:
string$idセッションID
戻り値:
bool セッションを正常に破棄した場合 true
sfSessGc ( maxlifetime)

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

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

引数:
integer$maxlifetimeセッションの有効期限(使用しない)
sfSessOpen ( save_path,
session_name 
)

セッションを開始する.

引数:
string$save_pathセッションを保存するパス(使用しない)
string$session_nameセッション名(使用しない)
戻り値:
bool セッションが正常に開始された場合 true
sfSessRead ( id)

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

引数:
string$idセッションID
戻り値:
string セッションデータの値
sfSessWrite ( id,
sess_data 
)

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

引数:
string$idセッションID
string$sess_dataセッションデータの値
戻り値:
bool セッションの書き込みに成功した場合 true

このクラスの説明は次のファイルから生成されました:
 全て データ構造 ネームスペース 関数 変数