class SessionFactory

セッションの初期化処理を抽象化するファクトリークラス.

このクラスはセッションの維持方法を管理するクラスです. 他のセッション管理クラスとは若干異なります.

EC-CUBE2.1.1ベータ版から、 管理画面>基本情報>パラメーター管理で、セッションの維持方法を ・Cookieを使用する場合 ・リクエストパラメーターを使用する場合 の2種類が選択できますが、どちらの設定であっても下記のように呼び出すことで 適切にセッションを開始することができます.

$sessionFactory = \Eccube\Framework\SessionFactory::getInstance() $sessionFactory->initSession();

Methods

static SessionFactory
getInstance()

パラメーター管理で設定したセッション維持設定に従って適切なオブジェクトを返す.

initSession()

セッションの初期化を行う.

boolean|null
useCookie()

Cookieを使用するかどうかを返す.

bool
sfSessOpen(string $save_path, string $session_name)

セッションを開始する.

bool
sfSessClose()

セッションを閉じる.

string
sfSessRead(string $id)

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

bool
sfSessWrite(string $id, string $sess_data)

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

bool
sfSessDestroy(string $id)

セッションを破棄する.

bool
sfSessGc(integer $maxlifetime)

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

Details

at line 56
static SessionFactory getInstance()

パラメーター管理で設定したセッション維持設定に従って適切なオブジェクトを返す.

Return Value

SessionFactory

at line 91
initSession()

セッションの初期化を行う.

at line 110
boolean|null useCookie()

Cookieを使用するかどうかを返す.

Return Value

boolean|null

at line 121
bool sfSessOpen(string $save_path, string $session_name)

セッションを開始する.

Parameters

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

Return Value

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

at line 131
bool sfSessClose()

セッションを閉じる.

Return Value

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

at line 142
string sfSessRead(string $id)

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

Parameters

string $id セッションID

Return Value

string セッションデータの値

at line 160
bool sfSessWrite(string $id, string $sess_data)

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

Parameters

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

Return Value

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

at line 192
bool sfSessDestroy(string $id)

セッションを破棄する.

Parameters

string $id セッションID

Return Value

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

at line 208
bool sfSessGc(integer $maxlifetime)

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

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

Parameters

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

Return Value

bool