Previous Next

Zend_Http_Cookie and Zend_Http_CookieJar

Introduction

Zend_Http_Cookie, comme son nom l'indique, est une classe qui représente un cookie HTTP. Elle propose des méthodes d'analyse de la chaîne de réponse HTTP, de collection des cookies, et d'accès à leurs propriétés. Il est aussi possible avec cette classe de vérifier si les paramètres d'un cookie correspondent à un scénario précis, par exemple une URL spécifique, un certain temps d'expiration, la présence ou non de HTTPS, etc...

Zend_Http_CookieJar est un objet utilisé en général avec Zend_Http_Client pour fournir une collection d'objets Zend_Http_Cookie. L'idée principale est d'attacher un objet Zend_Http_CookieJar à un objet Zend_Http_Client, de manière à ce que toutes les requêtes de celui-ci utilisent les cookies présents dans l'objet CookieJar. Ainsi, lorsque le client enverra une autre requête, il demandera à l'objet CookieJar tous les cookies concernant cette requête. Ceci est très pratique dans des cas comme envoyer un cookie de session entre plusieurs requêtes HTTP successives. De plus, l'objet Zend_Http_CookieJar peut être sérialisé et mis en session.

Instancier des objets Zend_Http_Cookie

L'instanciation se fait de deux manières différentes :

  • Via son constructeur, de cette façon : new Zend_Http_Cookie(string $name, string $value, string $domain, [int $expires, [string $path, [boolean $secure]]]);

    • $name: Nom du cookie (par ex. "PHPSESSID") (requis)

    • $value: La valeur du cookie (requis)

    • $domain: Le domaine de validité du cookie (par ex. ".example.com") (requis)

    • $expires: Temps d'expiration du cookie, un timestamp UNIX (optionnel, défaut à null). Si non fourni, le cookie sera considéré comme "cookie de session", avec pas de temps d'expiration.

    • $path: Chemin de validité du cookie, par ex. "/foo/bar/" (optionnel, défaut : "/")

    • $secure: Booléen, Si le cookie doit être transmis via connexion sécurisée (HTTPS) uniquement (optionnel, défaut à FALSE)

  • En appelant la méthode statique fromString(), avec une chaîne de caractères représentant un cookie tel que défini dans les en-têtes HTTP "Set-Cookie" (réponse) ou "Cookie" (requête). Dans ce cas la valeur du cookie doit être encodée. Lorsque la chaîne de caractères représentant un cookie ne comporte pas de partie "domain", vous devez fournir alors un URI selon lequel le cookie cherchera son domaine et son chemin.

Example #1 Créer un objet Zend_Http_Cookie

// D'abord, en utilisant son constructeur.
// ce cookie expirera dans 2 heures
$cookie = new Zend_Http_Cookie('foo',
                               'bar',
                               '.example.com',
                               time() + 7200,
                               '/path');

// En prenant l'en-tête de réponse HTTP 'Set-Cookie'
// Ce cookie n'expirera pas et ne sera envoyé que
// sur des connexions sécurisées
$cookie = Zend_Http_Cookie::fromString(
                'foo=bar; domain=.example.com; path=/path; secure');

// Si le domaine n'est pas présent, spécifiez le manuellement :
$cookie = Zend_Http_Cookie::fromString(
                'foo=bar; secure;', 'http://www.example.com/path');

Note:

Lorsque vous utilisez la méthode statique Zend_Http_Cookie::fromString(), veillez à fournir un cookie URL encodé (tel que c'est le cas dans les en-têtes HTTP). Avec le constructeur en revanche, il est nécessaire d'utiliser une valeur non encodée.

La manipulation inverse est possible. Grâce à la méthode __toString(), vous pouvez récupérer une chaîne représentant le cookie, à partir de l'objet Zend_Http_Cookie. La chaîne alors retournée est la même que celle utilisée dans l'en-tête HTTP "Cookie", à savoir une chaîne encodée, terminée par un point-virgule (;) :

Example #2 Passer de l'objet Zend_Http_Cookie à la chaîne

// Création d'un nouveau cookie
$cookie = new Zend_Http_Cookie('foo',
                               'two words',
                               '.example.com',
                               time() + 7200,
                               '/path');

// Va afficher 'foo=two+words;' :
echo $cookie->__toString();

// Ceci est la même chose
echo (string) $cookie;

// En PHP 5.2 et plus, ceci fonctionne aussi :
echo $cookie;

Zend_Http_Cookie méthodes getter

Une fois l'objet Zend_Http_Cookie crée, il existe des méthodes 'getter' pour accéder aux différentes propriétés du cookie :

  • string getName(): Retourne le nom du cookie

  • string getValue(): Retourne la valeur réelle (décodée), du cookie

  • string getDomain(): Retourne le domaine du cookie

  • string getPath(): Retourne le chemin du cookie, par défaut '/'

  • int getExpiryTime(): Retourne la date d'expiration, comme timestamp UNIX. Si pas de date, NULL sera retourné.

Voici encore quelques méthodes de vérifications booléennes :

  • boolean isSecure(): Regarde si le cookie est un cookie sécurisé. Si c'est le cas, les navigateurs ont pour instruction de ne les envoyer que sur des connexions sécurisées (HTTPS).

  • boolean isExpired(int $time = null): Vérifie si le cookie est expirés. Si il n'y a pas de date d'expiration, cette méthode retournera toujours true. Si $time est fourni, alors la date du cookie sera comparée à ce $time, et non plus au temps actuel.

  • boolean isSessionCookie(): Vérifie si le cookie est un cookie dit 'de session'. C'est un cookie sans date d'expiration, sensé être détruit à la fin de la session de travail actuelle (à la fermeture du navigateur).

Example #3 Utilisation des méthodes getter de Zend_Http_Cookie

// Création d'un cookie
$cookie =
    Zend_Http_Cookie::fromString('foo=two+words;'
                               . ' domain=.example.com;'
                               . ' path=/somedir;'
                               . 'secure;'
                               . 'expires=Wednesday, 28-Feb-05 20:41:22 UTC');

echo $cookie->getName();   // Affiche 'foo'
echo $cookie->getValue();  // Affiche 'two words'
echo $cookie->getDomain(); // Affiche '.example.com'
echo $cookie->getPath();   // Affiche '/'

echo date('Y-m-d', $cookie->getExpiryTime());
// Affiche '2005-02-28'

echo ($cookie->isExpired() ? 'Yes' : 'No');
// Affiche 'Yes'

echo ($cookie->isExpired(strtotime('2005-01-01') ? 'Yes' : 'No');
// Affiche 'No'

echo ($cookie->isSessionCookie() ? 'Yes' : 'No');
// Affiche 'No'

Zend_Http_Cookie: Correspondance de scénario

La vraie valeur ajoutée d'un objet Zend_Http_Cookie est sa méthode match(). Celle-ci teste le cookie en rapport avec un scénario HTTP, pour savoir ci celui-ci doit être attaché à la requête ou pas. La syntaxe est la suivante : boolean Zend_Http_Cookie->match(mixed $uri, [boolean $matchSessionCookies, [int $now]]);

  • mixed $uri : un objet Zend_Uri_Http avec un domaine et un chemin à vérifier. Une chaîne représentant une URL peut aussi être utilisée. Le cookie sera déclaré bon si le schéma de l'URL (HTTP ou HTTPS) correspond, ainsi que le chemin (path).

  • boolean $matchSessionCookies : établit ou non une correspondance pour les cookies dits de session. Par défaut : true. Si mis à false, alors les cookies sans date d'expiration seront ignorés du processus.

  • int $now : timestamp UNIX passé pour vérifier l'expiration du cookie. Si non spécifié, alors le temps actuel sera pris en considération.

Example #4 Correspondance de cookies

// Création de l'objet cookie - d'abord un cookie sécurisé
$cookie = Zend_Http_Cookie::fromString(
            'foo=two+words; domain=.example.com; path=/somedir; secure;');

$cookie->match('https://www.example.com/somedir/foo.php');
// Retournera true

$cookie->match('http://www.example.com/somedir/foo.php');
// Retournera false, car la connexion n'est pas sécurisée

$cookie->match('https://otherexample.com/somedir/foo.php');
// Retournera false, le domaine est incorrect

$cookie->match('https://example.com/foo.php');
// Retournera false, le chemin est incorrect

$cookie->match('https://www.example.com/somedir/foo.php', false);
// Retournera false, car les cookies de session ne sont pas pris en compte

$cookie->match('https://sub.domain.example.com/somedir/otherdir/foo.php');
// Retournera true

// Création d'un autre objet cookie - cette fois non sécurisé,
// expire dans 2 heures
$cookie = Zend_Http_Cookie::fromString(
            'foo=two+words; domain=www.example.com; expires='
          . date(DATE_COOKIE, time() + 7200));

$cookie->match('http://www.example.com/');
// Retournera true

$cookie->match('https://www.example.com/');
// Will return true - non secure cookies can go
// over secure connexions as well!

$cookie->match('http://subdomain.example.com/');
// Retournera false, domaine incorrect

$cookie->match('http://www.example.com/', true, time() + (3 * 3600));
// Retournera false, car nous avons rajouter 3 heures au temps actuel

Classe Zend_Http_CookieJar : Instanciation

Dans la plupart des cas, il ne sera pas nécessaire d'instancier soi-même un objet Zend_Http_CookieJar. Si vous voulez un conteneur de cookie (CookieJar) attaché à votre objet Zend_Http_Client, appelez simplement Zend_Http_Client->setCookieJar(), et un nouveau conteneur, vide, y sera attaché. Plus tard, vous pourrez utiliser la méthode Zend_Http_Client->getCookieJar(), pour récupérer ce conteneur.

Si vous voulez tout de même instancier manuellement un objet CookieJar, appelez son constructeur avec "new Zend_Http_CookieJar()", sans paramètres. Sinon il est possible aussi de passer par la méthode statique Zend_Http_CookieJar::fromResponse() qui prend, elle, deux paramètres : un objet Zend_Http_Response et un URI de référence (un objet Zend_Uri_Http ou une chaîne). Cette méthode retourne alors un objet Zend_Http_CookieJar qui contiendra les cookies de la réponse HTTP passée. L'URI de référence servira à remplir les paramètres "domain" et "path" des cookies, si jamais ils n'ont pas été définis dans les en-têtes "Set-Cookie".

Ajouter des cookies à un objet Zend_Http_CookieJar

En temps normal, c'est l'objet Zend_Http_Client qui ajoutera des cookies dans l'objet CookieJar que vous lui aurez attaché. Vous pouvez en ajouter manuellement aussi :

  • Zend_Http_CookieJar->addCookie($cookie[, $ref_uri]): Ajoute un cookie au conteneur (Jar). $cookie peut être soit un objet Zend_Http_Cookie, soit une chaîne qui sera alors convertie de manière automatique en objet cookie. Si vous passez une chaîne, alors vous devriez aussi passer le paramètre $ref_uri qui représente l'URI de référence pour déterminer les paramètres "domain" et "path" du cookie.

  • Zend_Http_CookieJar->addCookiesFromResponse($response, $ref_uri): Ajoute tous les cookies présents dans une réponse HTTP au conteneur. La réponse HTTP doit être un objet Zend_Http_Response contenant au moins un en-tête "Set-Cookie". $ref_uri est un URI (un objet Zend_Uri_Http ou une chaîne), servant de référence pour remplir les paramètres du cookie "domain" et "path", si ceux-ci ne sont pas trouvés dans la réponse.

Récupérer les cookies présents dans un objet Zend_Http_CookieJar

Comme pour l'ajout de cookies, en théorie, vous n'aurez pas besoin de récupérer des cookies du conteneur, car l'objet Zend_Http_Client se chargera de les gérer lui-même et de les envoyer dans les bonnes requêtes. Cependant, il existe des méthodes pour récupérer des cookies depuis un conteneur (Jar) : getCookie(), getAllCookies(), et getMatchingCookies(). De plus, itérer sur le CookieJar vous permettra d'en extraire tous les objets Zend_Http_Cookie.

Il est important de noter que chacune de ces trois méthodes, prend un paramètre spécial destiné à déterminer le type que chaque méthode retournera. Ce paramètre peut avoir 3 valeurs:

  • Zend_Http_CookieJar::COOKIE_OBJECT: Retourne un objet Zend_Http_Cookie. Si plus d'un cookie devait être retourné, il s'agira alors d'un tableau d'objets cookie.

  • Zend_Http_CookieJar::COOKIE_STRING_ARRAY: Retourne les cookies comme des chaînes de caractères dans un format "foo=bar", correspondant au format de l'en-tête de requête HTTP "Cookie". Si plus d'un cookie devait être retourné, il s'agira alors d'un tableau de chaînes.

  • Zend_Http_CookieJar::COOKIE_STRING_CONCAT: Similaire à COOKIE_STRING_ARRAY, mais si plusieurs cookies devaient être retournés, alors il ne s'agira plus d'un tableau, mais d'une chaîne concaténant tous les cookies, séparés par des point-virgule (;). Ceci est très utile pour passer tous les cookies d'un coup, dans l'en-tête HTTP "Cookie".

Voici la structure des méthodes de récupération des cookies :

  • Zend_Http_CookieJar->getCookie($uri, $cookie_name[, $ret_as]): Retourne un cookie depuis le conteneur, selon son URI (domain et path), et son nom. $uri est un objet Zend_Uri_Http ou une chaîne. $cookie_name est une chaîne identifiant le cookie en question. $ret_as spécifie le type de retour, comme vu plus haut (par défaut COOKIE_OBJECT).

  • Zend_Http_CookieJar->getAllCookies($ret_as): Retourne tous les cookies du conteneur. $ret_as spécifie le type de retour, comme vu plus haut (par défaut COOKIE_OBJECT).

  • Zend_Http_CookieJar->getMatchingCookies($uri[, $matchSessionCookies[, $ret_as[, $now]]]): Retourne tous les cookies ayant une correspondance pour un scénario donné, à savoir un URI et une date d'expiration.

    • $uri est soit un objet Zend_Uri_Http soit une chaîne.

    • $matchSessionCookies est un booléen désignant si les cookies de session, c'est à dire sans date d'expiration, doivent être analysés aussi pour établir une correspondance. Par défaut : true.

    • $ret_as spécifie le type de retour, comme vu plus haut (par défaut COOKIE_OBJECT).

    • $now est un entier représentant un timestamp UNIX à considérer comme 'maintenant'. Ainsi tous les cookies expirant avant ce temps là, ne seront pas pris en compte. Si vous ne spécifiez pas ce paramètre, alors c'est le temps actuel qui sera pris comme référence.

    Vous pouvez en apprendre plus sur la correspondance des cookies ici : Zend_Http_Cookie: Correspondance de scénario.

Previous Next
Introduction to Zend Framework
Présentation
Installation
Zend_Acl
Introduction
Affiner les Contrôles d'Accès
Utilisation avancée
Zend_Amf
Introduction
Zend_Amf_Server
Zend_Application
Introduction
Zend_Application Quick Start
Théorie générale
Exemples
Core Functionality
Available Resource Plugins
Zend_Auth
Introduction
Authentification avec une table de base de données
Authentification "Digest"
Adaptateur d'authentification HTTP
LDAP Authentication
Authentification OpenID
Zend_Cache
Introduction
Aspect théorique
Les frontends Zend_Cache
Les backends Zend_Cache
Zend_Captcha
Introduction
Opération Captcha
Adaptateurs CAPTCHA
Zend_CodeGenerator
Introduction
Exemples Zend_CodeGenerator
Zend_CodeGenerator Réference
Zend_Config
Introduction
Aspect théorique
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
Introduction
Déclarer les règles Getopt
Extraire les options et les arguments
Configurer Zend_Console_Getopt
Zend_Controller
Zend_Controller - Démarrage rapide
Fondations de Zend_Controller
Le contrôleur frontal (Front Controller)
L'objet Requête
Routeur Standard
Le distributeur
Contrôleurs d'action
Aides d'action (Helper)
Objet de réponse
Plugins
Utilisation de conventions de dossiers modulaires
Exceptions avec MVC
Migrer depuis des versions précédentes
Zend_Currency
Introduction à Zend_Currency
How to Work with Currencies
Migrer depuis des versions antérieures
Zend_Date
Introduction
Aspect théorique
Méthodes de base
Zend_Date API Overview
Créer des dates
Constants for General Date Functions
Exemples concrets
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
Relations Zend_Db_Table
Zend_Debug
Afficher des informations
Zend_Dojo
Introduction
Zend_Dojo_Data: dojo.data Envelopes
Les aides de vues Dojo
Les éléments de formulaire et les décorateurs Dojo
Zend_Dom
Introduction
Zend_Dom_Query
Zend_Exception
Utiliser les exceptions
Zend_Feed
Introduction
Importer des flux
Obtenir des flux à partir de pages Web
Consommer un flux RSS
Consommer un flux Atom
Consommer une entrée Atom particulière
Modifier la structure du flux ou des entrées
Classes personnalisées pour les flux et entrées
Zend_File
Zend_File_Transfer
Validateurs pour Zend_File_Transfer
Filtres pour Zend_File_Transfer
Migrer à partir des versions précédentes
Zend_Filter
Introduction
Classes de filtre standards
Chaînes de filtrage
Écriture de filtres
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form démarrage rapide
Creating Form Elements Using Zend_Form_Element
Creating Forms Using Zend_Form
Créer un visuel personnalisé en utilisant Zend_Form_Decorator
Standard Form Elements Shipped With Zend Framework
Décorateurs standards fournis avec Zend Framework
Internationaliser un formulaire Zend_Form
Advanced Zend_Form Usage
Zend_Gdata
Introduction
Authentification par procédé AuthSub
Using the Book Search Data API
Authentification avec ClientLogin
Using Google Calendar
Using Google Documents List Data API
Using Google Health
Using Google Spreadsheets
Using Google Apps Provisioning
Using Google Base
Utilisation des albums Web Picasa
Using the YouTube Data API
Attraper les exceptions Gdata
Zend_Http
Introduction
Zend_Http_Client - Utilisation avancée
Zend_Http_Client - Adaptateurs de connexion
Zend_Http_Cookie and Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
Introduction
Zend_Json
Introduction
Utilisation de base
Utilisation avancée de Zend_Json
XML to JSON conversion
Zend_Json_Server - JSON-RPC server
Zend_Layout
Introduction
Zend_Layout - Démarrage rapide
Zend_Layout options de configuration
Zend_Layout, utilisation avancée
Zend_Ldap
Introduction
Zend_Loader
Charger les fichiers et les classes dynamiquement
L'autoloader
Autoloaders de ressources
Chargeur de Plugins
Zend_Locale
Introduction
Using Zend_Locale
Normalization and Localization
Working with Dates and Times
Supported locales
Migrer à partir des versions précédentes
Zend_Log
Présentation
Rédacteurs (Writers)
Formateurs (mise en forme)
Filtres
Zend_Mail
Introduction
Envoyer des émail en utilisant SMTP
Envoyer plusieurs émail par connexion SMTP
Utiliser différents transports
Émail HTML
Fichiers joints
Ajouter des destinataires
Contrôler les limites MIME
En-têtes additionnels
Jeux de caractères
Encodage
Authentification SMTP
Sécuriser les transports SMTP
Lire des émail
Zend_Measure
Introduction
Création d'une mesure
Récupérer des mesures
Manipuler des mesures
Types de mesures
Zend_Memory
Présentation
Manager de mémoire
Objet mémoire
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_Navigation
Introduction
Pages
Containers
Zend_OpenId
Introduction
Zend_OpenId_Consumer Basics
Zend_OpenId_Provider
Zend_Paginator
Introduction
Utilisation
Configuration
Utilisation avancée
Zend_Pdf
Introduction
Créer et charger des documents PDF
Sauvegarder les changement dans un document PDF
Les pages d'un document
Dessiner
Informations du document et métadonnées
Exemple d'utilisation du module Zend_Pdf
Zend_ProgressBar
Zend_ProgressBar
Zend_Reflection
Introduction
Zend_Reflection Exemples
Réference de Zend_Reflection
Zend_Registry
Utiliser le registre
Zend_Rest
Introduction
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
Vue d'ensemble
Créer des index
Searching an Index
Query Language
Query Construction API
Jeu de caractères
Extensibility
Agir avec Lucene Java
Avancé
Bonnes pratiques
Zend_Server
Introduction
Zend_Server_Reflection
Zend_Service
Introduction
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Amazon_Ec2
Zend_Service_Amazon_Ec2: Instances
Zend_Service_Amazon_Ec2: Windows Instances
Zend_Service_Amazon_Ec2: Reserved Instances
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Machine Images (AMI)
Zend_Service_Amazon_Ec2: Elastic Block Stroage (EBS)
Zend_Service_Amazon_Ec2: Elastic IP Addresses
Zend_Service_Amazon_Ec2: Keypairs
Zend_Service_Amazon_Ec2: Regions and Availability Zones
Zend_Service_Amazon_Ec2: Security Groups
Zend_Service_Amazon_S3
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
Introduction
Zend_Service_StrikeIron
Zend_Service_StrikeIron: Bundled Services
Zend_Service_StrikeIron: Advanced Uses
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_Yahoo
Zend_Session
Introduction
Usage basique
Utilisation avancée
Gestion générale de la session
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL
Auto découverte
Zend_Tag
Introduction
Zend_Tag_Cloud
Zend_Test
Introduction
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
Introduction
Utiliser Zend_TimeSync
Zend_Tool_Framework
Introduction
Using the CLI Tool
Architecture
Creating Providers to use with Zend_Tool_Framework
Shipped System Providers
Zend_Tool_Project
Zend_Tool_Project Introduction
Create A Project
Zend Tool Project Providers
Zend_Translate
Introduction
Adaptateurs pour Zend_Translate
Utiliser les adaptateurs de traduction
Migrer à partir des versions précédentes
Zend_Uri
Zend_Uri
Zend_Validate
Introduction
Classes de validation standard
Chaînes de validation
Écrire des validateurs
Validation Messages
Zend_Version
Lire la version de Zend Framework
Zend_View
Introduction
Scripts de contrôleur
Scripts de vue
Aides de vue
Zend_View_Abstract
Migration depuis les versions précédentes
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
Introduction
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Configuration système requise par Zend Framework
Introduction
Convention de codage PHP de Zend Framework
Vue d'ensemble
Formatage des fichiers PHP
Conventions de nommage
Style de codage
Zend Framework Performance Guide
Introduction
Chargement des classes
Zend_Db Performance
Internationalisation (i18n) and Localisation (l10n)
View Rendering
Informations de copyright