Sessions

1Présentation

Le système de session permet de stocker temporairement des variables, qui sont liées à un visiteur. L'intérêt est de faire des traitements dans un contrôleur en fonction des traitements effectuée précédemment dans les contrôleurs exécutés préalablement.
Chaque session est liée à un navigateur par le biais d'un cookie déposé au premier accès. Cela est transparent car géré par le framework.

L'objet de gestion des sessions est créé automatiquement par Temma, si la configuration le prévoit.

2Configuration

Dans le fichier etc/temma.php, il est possible de définir la manière dont les sessions sont stockées (voir la documentation de la configuration).

Attention, si aucune source n'est spécifiée, Temma utilise le mécanisme de sessions natif de PHP. Il faut savoir que PHP stocke les données de session dans des fichiers, qui sont verrouillés lors de leur accès. Donc une seule requête peut y accéder à la fois, ce qui peut créer des verrouillages si vous avez des requêtes qui durent longtemps (par exemple si vous utilisez des contrôleurs d'événements).

3Objet Session

Dans les contrôleurs, l'objet de session est disponible en écrivant :

$this->_session

Dans les autres objets gérés par le composant d'injection de dépendances, l'objet de session est accessible en écrivant :

$this->_loader->session

4Lecture de données

Pour lire des données depuis la session, il suffit d'utiliser l'objet comme un tableau associatif :

$currentUser = $this->_session['user'];

Pour savoir si une variable de session existe, ou si elle est vide :

// est-ce que la variable est définie ?
if (isset($this->_session['myVariable']))
    doSomething();

// est-ce que la variable est vide ?
if (empty($this->_session['myOtherVariable']))
    doSomethingElse();

// variable non définie : utilisation d'une valeur par défaut
$var = $this->_session['myVariable'] ?? 'defaultValue';

// variable non définie ou vide : valeur par défaut
$var = $this->_session['myVariable'] ?: 'defaultValue';

Avec la méthode get(), il est possible de lire une variable de session, en spécifiant une valeur par défaut qui est retournée si la donnée n'est pas présente en session :

$var = $this->_session->get('myVariable', 'Valeur par défaut');

Il est possible de récupérer toutes les variables de session avec la méthode getAll() :

$sessVariables = $this->_session->getAll();
$currentUser = $sessVariables['user'];
$basket = $sessVariables['basket'];

Il est aussi possible d'extraire un donnée de la session, c'est à dire de la lire et de l'effacer de la session en un seul appel à la méthode extract() :

$value = $this->_session->extract('myVariable');

// est équivalent à
$value = $this->_session['myVariable'];
unset($this->_session['myVariable']);

// extract() peut aussi prendre une valeur par défaut
$value = $this->_session->extract('myVariable', 'default value');

5Écriture de données

Pour créer ou modifier une variable de session :

$this->_session['myVariable'] = $value;

Si la valeur assignée à la variable vaut null, la variable est effacée de la session.

Pour lire et écrire des données, l'objet de gestion des sessions s'utilise comme un tableau. Mais cela ne permet pas d'écrire directement des valeurs sur des tableaux multi-dimensionnels.
Pour modifier un tableau multi-dimensionnel, il faut donc commencer par récupérer le tableau complet, le modifier, puis écraser la variable de session :

// cela ne fonctionne pas
$this->_session['user']['name'] = 'Einstein';

// il faut procéder ainsi
$user = $this->_session['user'];
$user['name'] = 'Einstein';
$this->_session['user'] = $user;

6Effacement de données

Pour détruire une variable de session :

unset($this->_session['myVariable']);

Pour effacer toutes les variables de la session :

$this->_session->clean();