Cookie¶

Paramétrage du controller¶

Voici un certain nombre de variables du controller qui vous permettent de configurer la manière dont les cookies sont créés et gérés. Définir ces variables spéciales dans la méthode beforeFilter() de votre controller vous permet de modifier le fonctionnement du component Cookie.

Les extraits de code de controller suivants montrent comment inclure le component Cookie et paramétrer les variables du controller nécessaires pour écrire un cookie nommé “baker_id” pour le domaine “example.com” qui a besoin d’une connexion sécurisée, qui est disponible au chemin “/bakers/preferences/”, qui expire dans une heure, et est uniquement en HTTP.

public $components = array('Cookie');

public function beforeFilter() {
    parent::beforeFilter();
    $this->Cookie->name = 'baker_id';
    $this->Cookie->time = 3600;  // ou '1 hour'
    $this->Cookie->path = '/bakers/preferences/';
    $this->Cookie->domain = 'example.com';
    $this->Cookie->secure = true;  // ex. seulement envoyé si on utilise un HTTPS sécurisé
    $this->Cookie->key = 'qSI232qs*&sXOw!adre@34SAv!@*(XSL#$%)asGb$@11~_+!@#HKis~#^';
    $this->Cookie->httpOnly = true;
    $this->Cookie->type('aes');
}

Ensuite, regardons comment utiliser les différentes méthodes du Component Cookie.

Utiliser le Component¶

Le Component Cookie offre plusieurs méthodes pour travailler avec les Cookies.

CookieComponent::write(mixed $key, mixed $value = null, boolean $encrypt = true, mixed $expires = null)¶

La méthode write() est le cœur du composant Cookie, $key est le nom de la variable désirée, et $value est l’information à stocker:

$this->Cookie->write('nom', 'Rémy');

Vous pouvez également grouper vos variables en utilisant la notation point “.” dans les paramètres de clé:

$this->Cookie->write('User.name', 'Larry');
$this->Cookie->write('User.role', 'Lead');

Si vous voulez écrire plus d’une valeur dans le cookie en une fois, vous pouvez passer un tableau:

$this->Cookie->write('User',
    array('name' => 'Larry', 'role' => 'Lead')
);

Toutes les valeurs dans le cookie sont chiffrées par défaut. Si vous voulez stocker vos valeurs en texte clair, définissez le troisième paramètre de la méthode write() à false. Vous devriez vous rappeler de définir le mode de chiffrement à “aes” pour vous assurer que les valeurs sont chiffrées de façon sécurisée:

$this->Cookie->write('name', 'Larry', false);

Le dernier paramètre à écrire est $expires - le nombre de secondes avant que le cookie n’expire. Par convention, ce paramètre peut aussi être passé comme une chaîne de caractères que la fonction strtotime() de PHP comprend:

// Les deux cookies expirent dans une heure.
$this->Cookie->write('first_name', 'Larry', false, 3600);
$this->Cookie->write('last_name', 'Masters', false, '1 hour');

CookieComponent::read(mixed $key = null)¶

Cette méthode est utilisée pour lire la valeur d’une variable de cookie avec le nom spécifié dans $key.

// Sortie "Larry"
echo $this->Cookie->read('name');

// Vous pouvez aussi utiliser la notation par point pour lire
echo $this->Cookie->read('User.name');

// Pour prendre les variables que vous aviez groupées en utilisant
// la notation par point comme tableau, faites quelque chose comme
$this->Cookie->read('User');

// ceci retourne quelque chose comme array('name' => 'Larry', 'role' => 'Lead')

CookieComponent::check($key)¶

Paramètres:

• $key (string) – La clé à vérifier.

Utilisé pour vérifier si une clé/chemin existe et a une valeur non null.

Nouveau dans la version 2.3: CookieComponent::check() a été ajoutée dans la version 2.3

CookieComponent::delete(mixed $key)¶

Efface une variable de cookie dont le nom est défini dans $key. Fonctionne avec la notation par point:

// Efface une variable
$this->Cookie->delete('bar');

// Efface la variable bar du cookie, mais seulement dans foo.
$this->Cookie->delete('foo.bar');

CookieComponent::destroy()¶

Détruit le cookie actuel.

CookieComponent::type($type)¶

Vous permet de changer le schéma de chiffrement. Par défaut, le schéma “cipher” est utilisé pour une compatibilité rétroactive. Cependant, vous devriez toujours utiliser les schémas “rijndael” ou “aes”.

Modifié dans la version 2.2: Le type “rijndael” a été ajouté.

Nouveau dans la version 2.5: Le type “aes” a été ajouté.