FuelPHP の Session クラスは、fuel/core/config/session.php
設定ファイルを通じて構成される。このファイルにはあらかじめデフォルト値が設定されている。fuel/app/config/session.php
を作成すると、fuel/core/config/session.php
よりも優先される。
パラメータ | 説明 |
---|---|
auto_initialize | trueに設定した場合、設定で定義された既定のドライバが自動的にロードされ、初期化される。手動で特定のセッション構成をロードしたい場合はfalseに設定する。 |
driver | ロードするセッションドライバの名前を指定する。'cookie'、'db'、'memcached'、'redis'又は'file'のうちいずれかを指定する。 |
flash_id | フラッシュIDを指定する。セッション内でフラッシュ変数はフラッシュIDとセッション変数名で識別される。変数名の衝突を避けるために、セッション変数名前空間として、このフラッシュIDを使うことができる。 |
flash_auto_expire | trueに設定すると、次のページリクエスト後に、フラッシュ変数を取得されたかどうかに関わらず、フラッシュ変数は自動的に期限切れになる。flaseに設定した場合、取得されるまでフラッシュ変数はセッション内に格納されたままとなる。 |
フラッシュ変数は、一度だけ使用されることを意図したセッション変数である。フラッシュ変数は、次の場合に削除される。
メソッド | 説明 |
---|---|
create | 新しいセッションの作成 |
delete | セッション変数の削除 |
delete_flash | フラッシュセッションのセッション変数の削除 |
destroy | セッションの破棄 |
get | セッション変数値の取得 |
get_flash | フラッシュセッションのセッション変数値の取得 |
keep_flash | フラッシュセッションの寿命を次のリクエストまで延ばす |
key | セッションIDの取得 |
rotate | セッションIDの変更 |
set | セッション変数の設定 |
set_flash | セッションフラッシュ変数を設定する。 |
static create()
新しいセッションを作成する。
static delete($variable)
$variable
で指定したセッション変数を削除する。
static delete_flash($variable)
フラッシュセッションにおいて、$variable
で指定したセッション変数を削除する。
static destroy()
セッションを破棄する。
static get($variable, $default = null)
$variable
で指定したセッション変数の値を返す。セッション変数が存在しない場合、$default
で指定したデフォルト値を返す。
static get_flash($variable, $default = null)
フラッシュセッションにおいて、$variable
で指定したセッション変数の値を返す。セッション変数が存在しない場合、$default
で指定したデフォルト値を返す。
static keep_flash($variable)
フラッシュセッションにおいて、$variable
で指定したセッション変数の寿命を次のリクエストまで延ばす。
static key()
セッションIDを返す。
static rotate()
セッションIDを変更する。
static set($variable, $value = null)
$variable
で指定したセッション変数に$value
で指定した値を設定する。
static set_flash($variable, $value = null)
フラッシュセッションにおいて、$variable
で指定したセッション変数に$value
で指定した値を設定する。