Session HTTP

Introduction

info

Les applications HTTP étant sans état, les sessions offrent un moyen de stocker des informations sur l'utilisateur à travers plusieurs requêtes.

Utilisation

Récupération des données

Il existe deux manières principales de travailler avec les données de session dans Bow : le helper global session et via une instance Bow\Http\Request.

Premièrement, examinons l'accès à la session via une instance Bow\Http\Request, qui peut être injectée sur une méthode de contrôleur. N'oubliez pas que les dépendances des méthodes du contrôleur sont automatiquement injectées via le conteneur Bow :

namespace App\Controllers;

use App\Controllers\Controller;
use App\Models\User;
use Bow\Http\Request;

class UserController extends Controller
{
  /**
   * Afficher un utilisateur
   *
   * @param Request $request
   * @param int $id
   * @return Response
   */
  public function show(Request $request, $id)
  {
    $value = $request->session()->get('key');

    //
  }
}

Lorsque vous récupérez un élément de la session, vous pouvez également transmettre une valeur par défaut comme deuxième argument de la méthode get. Cette valeur par défaut sera renvoyée si la clé spécifiée n'existe pas dans la session. Si vous transmettez une closure en tant que valeur par défaut à la méthode get et que la clé demandée n'existe pas, la closure sera exécutée et son résultat sera renvoyé:

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

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

Le helper global de session

Le helper session() est un lecteur (et un accesseur à l'instance) :

• session() — retourne l'instance Session.
• session('key') — retourne la valeur stockée (ou null).
• session('key', 'default') — idem, avec une valeur de repli.

$app->get('home', function () {
  // Récupérer une donnée de la session
  $value = session('key');

  // Spécifier une valeur par défaut
  $value = session('key', 'default');

  // Stocker une donnée : passez par l'instance
  session()->set('key', 'value');
  // ou : session()->put('key', 'value');
});

Pas de forme tableau

Contrairement à certains frameworks, session(['key' => 'value']) ne fonctionne pas dans Bow et lève une TypeError : le helper accepte uniquement ?string comme premier argument. Pour écrire, utilisez session()->set(...) ou session()->put(...).

Récupération de toutes les données de session

Si vous souhaitez récupérer toutes les données de la session, vous pouvez utiliser la méthode all:

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

Déterminer si un élément existe dans la session

Pour déterminer si un élément est présent dans la session, vous pouvez utiliser la méthode has. La méthode has renvoie true si l'élément est présent et n'est pas null :

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

Pour déterminer si un élément est présent dans la session, même si sa valeur est null, vous pouvez utiliser la méthode exists. La méthode exists renvoie true si l'élément est présent:

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

Stocker des données

Pour stocker des données dans la session, utilisez la méthode set (ou son alias put) sur l'instance de session :

// Via une instance de requête
$request->session()->set('key', 'value');
$request->session()->put('another', 42);

// Via le helper (qui retourne l'instance Session quand appelé sans clé)
session()->set('key', 'value');

Données flash

Information

Parfois, vous souhaiterez peut-être stocker des éléments dans la session uniquement pour la prochaine requête. Les données flash sont principalement utiles pour les messages d'état de courte durée.

Vous pouvez le faire en utilisant la méthode flash ou le helper flash. Les données stockées dans la session à l'aide de cette méthode ne seront disponibles que lors de la requête HTTP suivante, puis seront supprimées.

$request->session()->flash('status', 'Welcome !');

Si vous devez supprimer vos données flash, vous pouvez utiliser la méthode clearFlash :

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

Suppression de données

La méthode remove supprimera une donnée de la session. Si vous souhaitez supprimer toutes les données de la session, vous pouvez utiliser la méthode flush. Si par contre vous souhaitez supprimer toutes les informations sauf les informations de flash, vous pouvez utiliser la méthode clear :

// Supprimer une donnée de la session
$request->session()->remove('key');

// Supprimer toutes les informations sauf les informations de flash
$request->session()->clear();

// Supprimer toutes les données de la session
$request->session()->flush();

Il manque quelque chose ?

Si vous rencontrez des problèmes avec la documentation ou si vous avez des suggestions pour améliorer la documentation ou le projet en général, veuillez déposer une issue pour nous, ou envoyer un tweet mentionnant le compte Twitter @bowframework ou directement sur le github.