Http/CookieJar.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Http
subpackage: CookieJar
version: $Id: CookieJar.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Http_CookieJar

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Http_CookieJar
jump to top

Implements
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
link: for some specs.
package: Zend_Http
subpackage: CookieJar
Constants: COOKIE_OBJECT; COOKIE_STRING_ARRAY; COOKIE_STRING_CONCAT
Properties: $cookies; $_rawCookies
Methods: __construct; addCookie; addCookiesFromResponse; getAllCookies; getMatchingCookies; getCookie; _flattenCookiesArray; _matchDomain; _matchPath; fromResponse; count; getIterator; isEmpty; reset

Description

A Zend_Http_CookieJar object is designed to contain and maintain HTTP cookies, and should be used along with Zend_Http_Client in order to manage cookies across HTTP requests and responses.

The class contains an array of Zend_Http_Cookie objects. Cookies can be added to the jar automatically from a request or manually. Then, the jar can find and return the cookies needed for a specific HTTP request.

A special parameter can be passed to all methods of this class that return cookies: Cookies can be returned either in their native form (as Zend_Http_Cookie objects) or as strings - the later is suitable for sending as the value of the "Cookie" header in an HTTP request. You can also choose, when returning more than one cookie, whether to get an array of strings (by passing Zend_Http_CookieJar::COOKIE_STRING_ARRAY) or one unified string for all cookies (by passing Zend_Http_CookieJar::COOKIE_STRING_CONCAT).

Constants

COOKIE_OBJECT
jump to class

 COOKIE_OBJECT = '0'

Return cookie(s) as a Zend_Http_Cookie object

Details

value: 0

COOKIE_STRING_ARRAY
jump to class

 COOKIE_STRING_ARRAY = '1'

Return cookie(s) as a string (suitable for sending in an HTTP request)

Details

value: 1

COOKIE_STRING_CONCAT
jump to class

 COOKIE_STRING_CONCAT = '2'

Return all cookies as one long string (suitable for sending in an HTTP request)

Details

value: 2

Properties

$_rawCookies
jump to class

array $_rawCookies = 'array'

The Zend_Http_Cookie array

Details

$_rawCookies: array
visibility: protected
default: array
final: false
static: false

$cookies
jump to class

array $cookies = 'array'

Array storing cookies

Cookies are stored according to domain and path: $cookies + www.mydomain.com + / - cookie1 - cookie2 + /somepath - othercookie + www.otherdomain.net + / - alsocookie

Details

$cookies: array
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
          
          )
        
        :

Construct a new CookieJar object

Details

visibility: public
final: false
static: false

_flattenCookiesArray
jump to class

_flattenCookiesArray(
          Zend_Http_Cookie|array $ptr, int $ret_as
              =
              self
          )
        
        :
        array|string

Helper function to recursivly flatten an array. Shoud be used when exporting the cookies array (or parts of it)

Arguments

$ptr: Zend_Http_Cookiearray
$ret_as: int
What value to return

Output

array|string

Details

visibility: protected
final: false
static: false

_matchDomain
jump to class

_matchDomain(
          string $domain
          )
        
        :
        array

Return a subset of the cookies array matching a specific domain

Arguments

$domain: string

Output

array

Details

visibility: protected
final: false
static: false

_matchPath
jump to class

_matchPath(
           $domains, string $path
          )
        
        :
        array

Return a subset of a domain-matching cookies that also match a specified path

Arguments

$domains
$path: string

Output

array

Details

visibility: protected
final: false
static: false

addCookie
jump to class

addCookie(
          Zend_Http_Cookie|string $cookie, Zend_Uri_Http|string $ref_uri
              =
              null
          )
        
        :

Add a cookie to the jar. Cookie should be passed either as a Zend_Http_Cookie object or as a string - in which case an object is created from the string.

Arguments

$cookie: Zend_Http_Cookiestring
$ref_uri: Zend_Uri_Httpstring
Optional reference URI (for domain, path, secure)

Details

visibility: public
final: false
static: false

addCookiesFromResponse
jump to class

addCookiesFromResponse(
          Zend_Http_Response $response, Zend_Uri_Http|string $ref_uri
          )
        
        :

Parse an HTTP response, adding all the cookies set in that response to the cookie jar.

Arguments

$response: Zend_Http_Response
$ref_uri: Zend_Uri_Httpstring
Requested URI

Details

visibility: public
final: false
static: false

count
jump to class

Required by Countable interface

Output

int

Details

visibility: public
final: false
static: false

fromResponse
jump to class

fromResponse(
          Zend_Http_Response $response,  $ref_uri
          )
        
        :
        Zend_Http_CookieJar

Create a new CookieJar object and automatically load into it all the cookies set in an Http_Response object. If $uri is set, it will be considered as the requested URI for setting default domain and path of the cookie.

Arguments

$response: Zend_Http_Response
HTTP Response object
$ref_uri

Output

Zend_Http_CookieJar

Details

visibility: public
final: false
static: true
todo: Add the $uri functionality.

getAllCookies
jump to class

getAllCookies(
          int $ret_as
              =
              self
          )
        
        :
        array|string

Get all cookies in the cookie jar as an array

Arguments

$ret_as: int
Whether to return cookies as objects of Zend_Http_Cookie or as strings

Output

array|string

Details

visibility: public
final: false
static: false

getCookie
jump to class

getCookie(
          Zend_Uri_Http|string $uri, string $cookie_name, int $ret_as
              =
              self
          )
        
        :
        Zend_Http_Cookie|string

Get a specific cookie according to a URI and name

Arguments

$uri: Zend_Uri_Httpstring
The uri (domain and path) to match
$cookie_name: string
The cookie's name
$ret_as: int
Whether to return cookies as objects of Zend_Http_Cookie or as strings

Output

Zend_Http_Cookie|string

Details

visibility: public
final: false
static: false

getIterator
jump to class

getIterator(
          
          )
        
        :
        ArrayIterator

Required by IteratorAggregate interface

Output

ArrayIterator

Details

visibility: public
final: false
static: false

getMatchingCookies
jump to class

getMatchingCookies(
          string|Zend_Uri_Http $uri, boolean $matchSessionCookies
              =
              true, int $ret_as
              =
              self, int $now
              =
              null
          )
        
        :
        array|string

Return an array of all cookies matching a specific request according to the request URI, whether session cookies should be sent or not, and the time to consider as "now" when checking cookie expiry time.

Arguments

$uri: stringZend_Uri_Http
URI to check against (secure, domain, path)
$matchSessionCookies: boolean
Whether to send session cookies
$ret_as: int
Whether to return cookies as objects of Zend_Http_Cookie or as strings
$now: int
Override the current time when checking for expiry time

Output

array|string

Details

visibility: public
final: false
static: false

isEmpty
jump to class

isEmpty(
          
          )
        
        :
        bool

Tells if the jar is empty of any cookie

Output

bool

Details

visibility: public
final: false
static: false

reset
jump to class

reset(
          
          )
        
        :
        Zend_Http_CookieJar

Empties the cookieJar of any cookie

Output

Zend_Http_CookieJar

Details

visibility: public
final: false
static: false

API Documentation

Http/CookieJar.php

Description

Zend_Http_CookieJarjump to top

Description

Constants

COOKIE_OBJECTjump to class

Details

COOKIE_STRING_ARRAYjump to class

Details

COOKIE_STRING_CONCATjump to class

Details

Properties

$_rawCookiesjump to class

Details

$cookiesjump to class

Details

Methods

__constructjump to class

Details

_flattenCookiesArrayjump to class

Arguments

Output

Details

_matchDomainjump to class

Arguments

Output

Details

_matchPathjump to class

Arguments

Output

Details

addCookiejump to class

Arguments

Details

addCookiesFromResponsejump to class

Arguments

Details

countjump to class

Output

Details

fromResponsejump to class

Arguments

Output

Details

getAllCookiesjump to class

Arguments

Output

Details

getCookiejump to class

Arguments

Output

Details

getIteratorjump to class

Output

Details

getMatchingCookiesjump to class

Arguments

Output

Details

isEmptyjump to class

Output

Details

resetjump to class

Output

Details

Zend_Http_CookieJar
jump to top

COOKIE_OBJECT
jump to class

COOKIE_STRING_ARRAY
jump to class

COOKIE_STRING_CONCAT
jump to class

$_rawCookies
jump to class

$cookies
jump to class

__construct
jump to class

_flattenCookiesArray
jump to class

_matchDomain
jump to class

_matchPath
jump to class

addCookie
jump to class

addCookiesFromResponse
jump to class

count
jump to class

fromResponse
jump to class

getAllCookies
jump to class

getCookie
jump to class

getIterator
jump to class

getMatchingCookies
jump to class

isEmpty
jump to class

reset
jump to class