Basics - 09. Session

Driver Prerequisites (Driver Voraussetzungen)

Database

Wenn Sie den database session driver verwenden, müssen Sie eine Tabelle erstellen, die die Sitzungselemente enthält. Nachfolgend finden Sie ein Beispiel für eine Schema-Deklaration für die Tabelle:

Schema::create('sessions', function ($table) {
    $table->string('id')->unique();
    $table->unsignedInteger('user_id')->nullable();
    $table->string('ip_address', 45)->nullable();
    $table->text('user_agent')->nullable();
    $table->text('payload');
    $table->integer('last_activity');
});

Sie können den Befehl session:table Artisan verwenden, um diese Migration zu generieren:

php artisan session:table

php artisan migrate

Redis

Bevor Sie Redis-Sitzungen mit Laravel verwenden können, müssen Sie das Paket predis/predis (~1.0) über den Composer installieren. Sie können Ihre Redis-Verbindungen in der database-configuration-file konfigurieren. In dem session-configuration-file kann mit der connection-option festgelegt werden, welche Redis-Verbindung von der Sitzung verwendet wird.

Using The Session

Retrieving Data

Es gibt zwei grundlegende Möglichkeiten, mit Sitzungsdaten in Laravel zu arbeiten: den globalen session-Helper und über eine request-Instanz. Zuerst betrachten wir den Zugriff auf die Sitzung über eine request-Instanz, die auf einer Controller-Methode typebezogen sein kann. Denken Sie daran, dass Abhängigkeiten von Steuerungsmethoden (controller method dependencies) automatisch über den Laravel-Service-Container injiziert werden:

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
    /**
     * Show the profile for the given user.
     *
     * @param  Request  $request
     * @param  int  $id
     * @return Response
     */
    public function show(Request $request, $id)
    {
        $value = $request->session()->get('key');

        //
    }
}

Wenn Sie ein Element aus der Sitzung abrufen, können Sie der Get-Methode auch einen Standardwert als zweites Argument übergeben. Dieser Standardwert wird zurückgegeben, wenn der angegebene Schlüssel in der Sitzung nicht vorhanden ist. Wenn Sie eine Closure als Standardwert an die get-Methode übergeben und der angeforderte Schlüssel nicht existiert, wird die Closure ausgeführt und ihr Ergebnis zurückgegeben:

$value = $request->session()->get('key', 'default');

$value = $request->session()->get('key', function () {
    return 'default';
});

The Global Session Helper

Sie können auch die globale Session-PHP-Funktion verwenden, um Daten in der Session abzurufen und zu speichern. Wenn der session-Helper mit einem einzelnen, Zeichenkettenargument aufgerufen wird, gibt er den Wert dieses session-Key zurück. Wenn der Helfer mit einem Array von Schlüssel/Wertpaaren (key/value pairs) aufgerufen wird, werden diese Werte in der Session gespeichert:

Route::get('home', function () {
    // Retrieve a piece of data from the session...
    $value = session('key');

    // Specifying a default value...
    $value = session('key', 'default');

    // Store a piece of data in the session...
    session(['key' => 'value']);
});

Retrieving All Session Data

Wenn Sie alle Daten in der Sitzung abrufen möchten, können Sie die all-Methode all verwenden:

$data = $request->session()->all();

Determining If An Item Exists In The Session

Um festzustellen, ob ein Element in der Sitzung vorhanden ist, können Sie die has-Methode verwenden. Die has-Methode gibt true zurück, wenn das Element vorhanden ist und nicht Null ist:

if ($request->session()->has('users')) {
    //
}

Um festzustellen, ob ein Element in der Session vorhanden ist, auch wenn sein Wert Null ist, können Sie die exists-Methode verwenden. Die exists-Methode gibt true zurück, wenn das Element vorhanden ist:

if ($request->session()->exists('users')) {
    //
}

Storing Data

Um Daten in der Sitzung zu speichern, verwenden Sie in der Regel die put-Methode oder den Session-Helfer:

// Via a request instance...
$request->session()->put('key', 'value');

// Via the global helper...
session(['key' => 'value']);

Pushing To Array Session Values

Die Push-Methode kann verwendet werden, um einen neuen Wert auf einen Session-Wert zu schieben, der ein Array ist. Wenn der Schlüssel user.teams beispielsweise ein Array mit Teamnamen enthält, können Sie wie gewohnt einen neuen Wert auf das Array schieben:

$request->session()->push('user.teams', 'developers');

Retrieving & Deleting An Item

Die Pull-Methode ruft ein Element ab und löscht es aus der Sitzung in einer einzigen Anweisung:

$value = $request->session()->pull('key', 'default');

Flash Data

Manchmal möchten Sie Elemente in der Sitzung nur für die nächste Anforderung speichern. Sie können dies mit der Flash-Methode tun. Daten, die in der Sitzung mit dieser Methode gespeichert wurden, sind nur während der nachfolgenden HTTP-Anfrage verfügbar und werden dann gelöscht. Flash-Daten sind vor allem für kurzlebige Statusmeldungen nützlich:

$request->session()->flash('status', 'Task was successful!');

Wenn Sie Ihre Flash-Daten für mehrere Anfragen aufbewahren müssen, können Sie die Reflash-Methode verwenden, die alle Flash-Daten für eine zusätzliche Anfrage speichert. Wenn Sie nur bestimmte Flash-Daten speichern müssen, können Sie die Keep-Methode verwenden:

$request->session()->reflash();

$request->session()->keep(['username', 'email']);

Deleting Data

Die forget-Methode entfernt ein Datenelement aus der Sitzung. Wenn Sie alle Daten aus der Sitzung entfernen möchten, können Sie die Flush-Methode verwenden:

// Forget a single key...
$request->session()->forget('key');

// Forget multiple keys...
$request->session()->forget(['key1', 'key2']);

$request->session()->flush();

Regenerating The Session ID

Die Wiederherstellung der Sitzungs-ID wird häufig durchgeführt, um zu verhindern, dass böswillige Benutzer einen Session-fixation auf Ihre Anwendung ausnutzen.

Laravel generiert die Sitzungs-ID während der Authentifizierung automatisch neu, wenn Sie den integrierten LoginController verwenden; wenn Sie jedoch die Sitzungs-ID manuell neu generieren müssen, können Sie die regenerate-Methode verwenden.

$request->session()->regenerate();

Adding Custom Session Drivers

Implementing The Driver

Ihr benutzerdefinierter Session-Treiber sollte das SessionHandlerInterface implementieren. Dieses Interface enthält nur einige einfache Methoden, die wir implementieren müssen. Eine stumpfe MongoDB-Implementierung sieht in etwa so aus:

<?php

namespace App\Extensions;

class MongoSessionHandler implements \SessionHandlerInterface
{
    public function open($savePath, $sessionName) {}
    public function close() {}
    public function read($sessionId) {}
    public function write($sessionId, $data) {}
    public function destroy($sessionId) {}
    public function gc($lifetime) {}
}

Da der Zweck dieser Methoden nicht leicht verständlich ist, lassen Sie uns kurz erläutern, was die einzelnen Methoden bewirken:

• Die open-Methode wird typischerweise in dateibasierten Session-Speichersystemen verwendet. Da Laravel mit einem file-Session-Driver ausgeliefert wird, müssen Sie fast nie etwas in diese Methode eingeben. Du kannst es als leeren Stumpf belassen. Es ist eine Tatsache des schlechten Interface-Designs (das wir später besprechen werden), dass PHP von uns verlangt, diese Methode zu implementieren.
• Auch die Close-Methode, wie die open-Methode, kann in der Regel nicht berücksichtigt werden. Für die meisten Driver (Treiber) ist es nicht erforderlich.
• Die read-Methode sollte die Zeichenkettenversion der Sessiondaten zurückgeben, die der angegebenen $sessionId zugeordnet sind. Beim Abrufen oder Speichern von Sessiondaten in Ihrem Treiber ist keine Serialisierung oder andere Kodierung erforderlich, da Laravel die Serialisierung für Sie durchführt.
• Die write-Methode sollte die angegebene $data Zeichenkette, die der $sessionId zugeordnet ist, in ein persistentes Speichersystem, wie MongoDB, Dynamo, etc. schreiben. Auch hier sollten Sie keine Serialisierung durchführen - Laravel hat das bereits für Sie erledigt.
• Die destroy-Methode sollte die mit der $sessionId verbundenen Daten aus dem persistenten Speicher entfernen.
• Die gc-Methode sollte alle Session-Daten zerstören, die älter sind als die angegebene $lifetime, die ein UNIX-Zeitstempel ist. Bei selbst ablaufenden Systemen wie Memcached und Redis kann diese Methode leer bleiben.

Registering The Driver

Sobald Ihr Treiber implementiert ist, sind Sie bereit, ihn im Framework zu registrieren. Um zusätzliche Treiber zum Laravels Session-Backend hinzuzufügen, können Sie die extend-Methode auf der Session-Facade verwenden. Sie sollten die Extend-Methode aus der Boot-Methode eines Service Provider aufrufen. Sie können dies über den bestehenden AppServiceProvider tun oder einen völlig neuen Provider anlegen:

<?php

namespace App\Providers;

use App\Extensions\MongoSessionHandler;
use Illuminate\Support\Facades\Session;
use Illuminate\Support\ServiceProvider;

class SessionServiceProvider extends ServiceProvider
{
    /**
     * Register bindings in the container.
     *
     * @return void
     */
    public function register()
    {
        //
    }

    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        Session::extend('mongo', function ($app) {
            // Return implementation of SessionHandlerInterface...
            return new MongoSessionHandler;
        });
    }
}

Nachdem der session driver registriert wurde, können Sie den Mongo-Treiber in Ihrer Konfigurationsdatei config/session.php verwenden.