設定

HTTP駆動のアプリケーションはステートレスですから、リクエスト間に渡り情報を保存するセッションが提供されています。Laravelは美しく統一されたAPIで、様々なバックエンドのセッションを用意しています。人気のあるMemcachedRedis、データベースも始めからサポートしています。

セッションの設定はconfig/session.phpにあります。このファイルのオプションには詳しくコメントがついていますので、確認して下さい。ほとんどのアプリケーションでうまく動作できるように、Laravelはfileセッションドライバーをデフォルトとして設定しています。

Reidsセッションを使用する時には、Composerでpredis/predisパッケージ(~1.0)をインストールしておく必要があります。

注目: セッションに保存するデータを全て暗号化したい場合は、encrypt設定オプションをtureに設定します。

注意 cookieセッションドライバーを使用する場合は、HTTPカーネルからEncryptCookieミドルウェアを決して削除してはいけません。このミドルウェアを削除してしまうと、リモートコードインジェクションの脆弱性をアプリケーションに入れてしまうでしょう。

予約キー

Laravelは内部で、flashセッションキーを使用しています。そのため、この名前のセッションアイテムを追加しないでください。

セッションの使用

HTTPリクエストのsessionメソッド、Sessionファサード、sessionヘルパー関数など、セッションに多くの手段でアクセス可能です。sessionヘルパーを引数を指定せず実行すれば、セッションオブジェクト全体が取得できます。次のように使えます。

session()->regenerate();

セッションにアイテム保存

Session::put('key', 'value')

session(['key' => 'value']);

配列セッション値として保存

Session::push('user.teams', 'developers');

セッションからアイテム取得

$value = Session::get('key');

$value = session('key');

アイテムかデフォルト値の取得

$value = Session::get('key', 'default');

$value = Session::get('key', function() { return 'default'; });

アイテム取得後に削除

$value = Session::pull('key', 'default');

セッションから全データ取得

$data = Session::all();

アイテムの存在確認

if (Session::has('users'))
{
    //
}

セッションからアイテム削除

Session::forget('key');

セッションから全アイテム削除

Session::flush();

セッションIDの再生成

Session::regenerate();

フラッシュデーター

次のリクエストの間だけアイテムを保存しておきたいこともあります。Session::flashメソッドが使えます。

Session::flash('key', 'value');

現在のフラッシュデーターの寿命を次のリクエストまで延長

Session::reflash();

指定したフラッシュデーターの寿命を延長

Session::keep(['username', 'email']);

データベースセッション

databaseセッションを使用する場合、セッションに必要な項目を含んだテーブルを用意してください。以下にサンプルのSchema宣言を紹介します。

Schema::create('sessions', function($table)
{
    $table->string('id')->unique();
    $table->text('payload');
    $table->integer('last_activity');
});

もちろん、Artisanコマンドのsession:tableで、このマイグレーションを生成することも可能です!

php artisan session:table

composer dump-autoload

php artisan migrate

セッションドライバー

セッション「ドライバー」で、それぞれのリクエストのセッションデーターをどこに保存するかを定義します。Laravelでは、素晴らしいドライバーを始めから用意しています。

  • file - セッションをstorage/framework/sessionsに保存します。
  • cookie - セッションをセキュアに暗号化されたクッキーに保存します。
  • database - セッションをアプリケーションで使用されるデータベースに保存します。
  • memcached / redis - セッションを指定された、早いキャッシュベースの保存領域に保持します。
  • array - セッションは、単にPHPの配列として保存されるだけです。リクエスト間で持続しません。

注目: 配列(array)ドライバーは、通常ユニットテストを実行するため使用されます。そのため、そのため、セッションデーターは保持されません。