Sessions

class SessionComponent(ComponentCollection $collection, array $settings = array())

Le component session de CakePHP fournit le moyen de faire persister les données client entre les pages requêtées. Il agit comme une interface pour $_SESSION et offre aussi des méthodes pratiques pour de nombreuses fonctions relatives à $_SESSION.

Les sessions peuvent être paramétrées de différentes façons dans CakePHP. Pour plus d’information, vous devriez lire la documentation Session configuration

Interagir avec les données de Session

Le component Session est utilisé pour interagir avec les informations de session. Il inclut les fonctions CRUD basiques, mais aussi des fonctionnalités pour créer des messages de feedback aux utilisateurs.

Il est important de noter que ces structures en tableaux peuvent être créées dans la session en utilisant la notation avec points. Par exemple, User.username se référera au tableau suivant

array('User' =>
    array('username' => 'clark-kent@dailyplanet.com')
);

Les points sont utilisés pour indiquer les tableaux imbriqués. Cette notation est utilisée pour toutes les méthodes du component Session quelques soient le nom/la clé utilisé.

SessionComponent::write($name, $value)

Écrit dans la Session, en mettant $value dans $name. $name peut-être un tableau séparé par un point. Par exemple

$this->Session->write('Person.eyeColor', 'Green');

Cela écrit la valeur “Green” dans la session sous Person => eyeColor.

SessionComponent::read($name)

Retourne la valeur de $name dans la Session. Si $name vaut null, la session entière sera retournée. Par ex

$green = $this->Session->read('Person.eyeColor');

Récupère la valeur « Green » de la session. La lecture de données inexistante retournera null.

SessionComponent::consume($name)

Lit et supprime une valeur de Session. C’est utile quand vous voulez combiner la lecture et la suppression de valeurs en une seule opération.

SessionComponent::check($name)

Utilisée pour vérifier qu’une variable de Session a été créée. Retourne true si la variable existe et false dans le cas contraire.

SessionComponent::delete($name)

Supprime les données de Session de $name. Par ex

$this->Session->delete(“Person.eyeColor”);

Notre donnée de session n’a plus la valeur “Green” ni même l’index eyeColor attribué. Cependant, le model Person est toujours dans la Session. Pour supprimer de la session toutes les informations de Person, utilisez

$this->Session->delete('Person');
SessionComponent::destroy()

La méthode destroy supprimera le cookie de session et toutes les données de session stockées dans le fichier temporaire du système. Cela va détruire la session PHP et ainsi en créer une nouvelle.:

$this->Session->destroy();

Création de messages de notification

SessionComponent::setFlash(string $message, string $element = 'default', array $params = array(), string $key = 'flash')

Obsolète depuis la version 2.7.0: Vous devez utiliser Flash pour créer des messages flash. La méthode setFlash() sera retirée dans 3.0.0.

Souvent dans les applications web, vous aurez besoin d’afficher des messages de notification instantanés à l’utilisateur après avoir terminer un processus ou une réception de données. Dans CakePHP, ceci est appelé « messages flash ». Vous pouvez définir des messages flash avec le component Session et les afficher avec le helper session SessionHelper::flash(). Pour définir un message, utilisez setFlash:

// Dans le controller.
$this->Session->setFlash('Votre travail a été sauvegardé !');

Ceci créera un message instantané qui peut être affiché à l’utilisateur, en utilisant le Helper Session SessionHelper:

// Dans la vue.
echo $this->Session->flash();

// Ce qui générera en sortie.
<div id="flashMessage" class="message">
    Votre travail a été sauvegardé !
</div>

Vous pouvez utiliser des paramètres supplémentaires de setFlash() pour créer différentes sortes de messages flash. Par exemple, les erreurs et les notifications positives peuvent avoir des apparences différentes. CakePHP vous donne un moyen de le faire. En utilisant le paramètre $key vous pouvez stocker différents messages, qui peuvent être séparément récupérer en sortie.

// définit le message que ca va mal
$this->Session->setFlash('Ca va mal.', 'default', array(), 'mal');

// définit le message que ca va bien
$this->Session->setFlash('Ca va bien', 'default', array(), 'bien');

Dans la vue, ces messages peuvent être ressortis et stylisés différemment:

// dans la vue.
echo $this->Session->flash('bien');
echo $this->Session->flash('mal');

Le paramètre $element vous permet de contrôler quel élément (localisé dans /app/View/Elements) devra être utilisé pour rendre le message. Dans l’élément le message est disponible en tant que $message. D’abord nous paramétrons le flash dans notre controller:

$this->Session->setFlash('truc customisés', 'flash_custom');

Ensuite nous créons le fichier app/View/Elements/flash_custom.ctp et créons notre élément flash personnalisé:

<div id="myCustomFlash"><?php echo h($message); ?></div>

$params vous permet de passer des variables de vue supplémentaires au layout de rendu. Les paramètres peuvent être passés en affectant la div de rendu, par exemple en ajoutant « class » dans le tableau $params qui appliquera une classe à la div de sortie en utilisant $this->Session->flash() dans votre layout ou vue.

$this->Session->setFlash(
    'Message Exemple',
    'default',
    array('class' => 'classe_exemple')
);

La sortie en utilisant $this->Session->flash() avec l’exemple ci-dessus sera:

<div id="flashMessage" class="classe_exemple">Message Exemple</div>

Pour utiliser un élément depuis un plugin spécifiez le plugin dans le $params:

// Utilisera  /app/Plugin/Comment/View/Elements/flash_no_spam.ctp
$this->Session->setFlash(
    'Message!',
    'flash_no_spam',
    array('plugin' => 'Comment')
);

Note

Par défaut, CakePHP n’échappe pas le HTML des messages flash. Si vous utilisez une requête ou une donnée d’utilisateur dans vos messages flash, vous devrez les échapper avec h quand vous formatez vos messages.