Zend_Http_CookieJar Class Reference

Inheritance diagram for Zend_Http_CookieJar:

Public Member Functions
	__construct ()
	addCookie ($cookie, $ref_uri=null, $encodeValue=true)
	addCookiesFromResponse ($response, $ref_uri, $encodeValue=true)
	getAllCookies ($ret_as=self::COOKIE_OBJECT)
	getMatchingCookies ($uri, $matchSessionCookies=true, $ret_as=self::COOKIE_OBJECT, $now=null)
	getCookie ($uri, $cookie_name, $ret_as=self::COOKIE_OBJECT)
	count ()
	getIterator ()
	isEmpty ()
	reset ()

Static Public Member Functions
static	fromResponse (Zend_Http_Response $response, $ref_uri)

Data Fields
const	COOKIE_OBJECT = 0
const	COOKIE_STRING_ARRAY = 1
const	COOKIE_STRING_CONCAT = 2
const	COOKIE_STRING_CONCAT_STRICT = 3

Protected Member Functions
	_flattenCookiesArray ($ptr, $ret_as=self::COOKIE_OBJECT)
	_matchDomain ($domain)
	_matchPath ($domains, $path)

Protected Attributes
	$cookies = array()
	$_rawCookies = array()

Detailed Description

Definition at line 60 of file CookieJar.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Construct a new CookieJar object

Definition at line 117 of file CookieJar.php.

    { }

Member Function Documentation

_flattenCookiesArray()

_flattenCookiesArray (   $ptr,   $ret_as = self::COOKIE_OBJECT  )

protected

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

Parameters

Zend_Http_Cookie | array	$ptr
int	$ret_as	What value to return

Returns

array|string

Definition at line 288 of file CookieJar.php.

                                                                               {
        if (is_array($ptr)) {
            $ret = ($ret_as == self::COOKIE_STRING_CONCAT || $ret_as == self::COOKIE_STRING_CONCAT_STRICT) ? '' : array();
            foreach ($ptr as $item) {
                if ($ret_as == self::COOKIE_STRING_CONCAT_STRICT) {
                    $postfix_combine = (!is_array($item) ? ' ' : '');
                    $ret .= $this->_flattenCookiesArray($item, $ret_as) . $postfix_combine;
                } elseif ($ret_as == self::COOKIE_STRING_CONCAT) {
                    $ret .= $this->_flattenCookiesArray($item, $ret_as);
                } else {
                    $ret = array_merge($ret, $this->_flattenCookiesArray($item, $ret_as));
                }
            }
            return $ret;
        } elseif ($ptr instanceof Zend_Http_Cookie) {
            switch ($ret_as) {
                case self::COOKIE_STRING_ARRAY:
                    return array($ptr->__toString());
                    break;

                case self::COOKIE_STRING_CONCAT_STRICT:
                    // break intentionally omitted

                case self::COOKIE_STRING_CONCAT:
                    return $ptr->__toString();
                    break;

                case self::COOKIE_OBJECT:
                default:
                    return array($ptr);
                    break;
            }
        }

        return null;
    }

_matchDomain()

_matchDomain (   $domain )

protected

Return a subset of the cookies array matching a specific domain

Parameters

string

$domain

Returns

array

Definition at line 331 of file CookieJar.php.

    {
        $ret = array();

        foreach (array_keys($this->cookies) as $cdom) {
            if (Zend_Http_Cookie::matchCookieDomain($cdom, $domain)) {
                $ret[$cdom] = $this->cookies[$cdom];
            }
        }

        return $ret;
    }

_matchPath()

_matchPath (   $domains,   $path  )

protected

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

Parameters

array	$dom_array
string	$path

Returns

array

Definition at line 351 of file CookieJar.php.

    {
        $ret = array();

        foreach ($domains as $dom => $paths_array) {
            foreach (array_keys($paths_array) as $cpath) {
                if (Zend_Http_Cookie::matchCookiePath($cpath, $path)) {
                    if (! isset($ret[$dom])) {
                        $ret[$dom] = array();
                    }

                    $ret[$dom][$cpath] = $paths_array[$cpath];
                }
            }
        }

        return $ret;
    }

addCookie()

addCookie	(		$cookie,
			$ref_uri = null,
			$encodeValue = true
	)

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.

Parameters

Zend_Http_Cookie | string	$cookie
Zend_Uri_Http | string	$ref_uri	Optional reference URI (for domain, path, secure)
boolean	$encodeValue

Definition at line 128 of file CookieJar.php.

    {
        if (is_string($cookie)) {
            $cookie = Zend_Http_Cookie::fromString($cookie, $ref_uri, $encodeValue);
        }

        if ($cookie instanceof Zend_Http_Cookie) {
            $domain = $cookie->getDomain();
            $path = $cookie->getPath();
            if (! isset($this->cookies[$domain])) $this->cookies[$domain] = array();
            if (! isset($this->cookies[$domain][$path])) $this->cookies[$domain][$path] = array();
            $this->cookies[$domain][$path][$cookie->getName()] = $cookie;
            $this->_rawCookies[] = $cookie;
        } else {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception('Supplient argument is not a valid cookie string or object');
        }
    }

addCookiesFromResponse()

addCookiesFromResponse	(		$response,
			$ref_uri,
			$encodeValue = true
	)

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

Parameters

Zend_Http_Response	$response
Zend_Uri_Http | string	$ref_uri	Requested URI
boolean	$encodeValue

Definition at line 155 of file CookieJar.php.

    {
        if (! $response instanceof Zend_Http_Response) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception('$response is expected to be a Response object, ' .
                gettype($response) . ' was passed');
        }

        $cookie_hdrs = $response->getHeader('Set-Cookie');

        if (is_array($cookie_hdrs)) {
            foreach ($cookie_hdrs as $cookie) {
                $this->addCookie($cookie, $ref_uri, $encodeValue);
            }
        } elseif (is_string($cookie_hdrs)) {
            $this->addCookie($cookie_hdrs, $ref_uri, $encodeValue);
        }
    }

count()

count

(

)

Required by Countable interface

Returns

int

Definition at line 393 of file CookieJar.php.

    {
        return count($this->_rawCookies);
    }

fromResponse()

static fromResponse ( Zend_Http_Response  $response,   $ref_uri  )

static

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.

Parameters

Zend_Http_Response	$response	HTTP Response object
Zend_Uri_Http | string	$uri	The requested URI

Returns

Zend_Http_CookieJar

Todo:

Add the $uri functionality.

Definition at line 381 of file CookieJar.php.

    {
        $jar = new self();
        $jar->addCookiesFromResponse($response, $ref_uri);
        return $jar;
    }

getAllCookies()

getAllCookies

(

$ret_as = self::COOKIE_OBJECT

)

Get all cookies in the cookie jar as an array

Parameters

int

$ret_as

Whether to return cookies as objects of Zend_Http_Cookie or as strings

Returns

array|string

Definition at line 180 of file CookieJar.php.

    {
        $cookies = $this->_flattenCookiesArray($this->cookies, $ret_as);
        if($ret_as == self::COOKIE_STRING_CONCAT_STRICT) {
            $cookies = rtrim(trim($cookies), ';');
        }
        return $cookies;
    }

getCookie()

getCookie	(		$uri,
			$cookie_name,
			$ret_as = self::COOKIE_OBJECT
	)

Get a specific cookie according to a URI and name

Parameters

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

Returns

Zend_Http_Cookie|string

Definition at line 237 of file CookieJar.php.

    {
        if (is_string($uri)) {
            $uri = Zend_Uri::factory($uri);
        }

        if (! $uri instanceof Zend_Uri_Http) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception('Invalid URI specified');
        }

        // Get correct cookie path
        $path = $uri->getPath();
        $path = substr($path, 0, strrpos($path, '/'));
        if (! $path) $path = '/';

        if (isset($this->cookies[$uri->getHost()][$path][$cookie_name])) {
            $cookie = $this->cookies[$uri->getHost()][$path][$cookie_name];

            switch ($ret_as) {
                case self::COOKIE_OBJECT:
                    return $cookie;
                    break;

                case self::COOKIE_STRING_CONCAT_STRICT:
                    return rtrim(trim($cookie->__toString()), ';');
                    break;

                case self::COOKIE_STRING_ARRAY:
                case self::COOKIE_STRING_CONCAT:
                    return $cookie->__toString();
                    break;

                default:
                    #require_once 'Zend/Http/Exception.php';
                    throw new Zend_Http_Exception("Invalid value passed for \$ret_as: {$ret_as}");
                    break;
            }
        } else {
            return false;
        }
    }

getIterator()

getIterator

(

)

Required by IteratorAggregate interface

Returns

ArrayIterator

Definition at line 403 of file CookieJar.php.

    {
        return new ArrayIterator($this->_rawCookies);
    }

getMatchingCookies()

getMatchingCookies	(		$uri,
			$matchSessionCookies = true,
			$ret_as = self::COOKIE_OBJECT,
			$now = null
	)

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.

Parameters

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

Returns

array|string

Definition at line 200 of file CookieJar.php.

    {
        if (is_string($uri)) $uri = Zend_Uri::factory($uri);
        if (! $uri instanceof Zend_Uri_Http) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception("Invalid URI string or object passed");
        }

        // First, reduce the array of cookies to only those matching domain and path
        $cookies = $this->_matchDomain($uri->getHost());
        $cookies = $this->_matchPath($cookies, $uri->getPath());
        $cookies = $this->_flattenCookiesArray($cookies, self::COOKIE_OBJECT);

        // Next, run Cookie->match on all cookies to check secure, time and session mathcing
        $ret = array();
        foreach ($cookies as $cookie)
            if ($cookie->match($uri, $matchSessionCookies, $now))
                $ret[] = $cookie;

        // Now, use self::_flattenCookiesArray again - only to convert to the return format ;)
        $ret = $this->_flattenCookiesArray($ret, $ret_as);
        if($ret_as == self::COOKIE_STRING_CONCAT_STRICT) {
            $ret = rtrim(trim($ret), ';');
        }

        return $ret;
    }

isEmpty()

isEmpty

(

)

Tells if the jar is empty of any cookie

Returns

bool

Definition at line 413 of file CookieJar.php.

    {
        return count($this) == 0;
    }

reset()

reset

(

)

Empties the cookieJar of any cookie

Returns

Zend_Http_CookieJar

Definition at line 423 of file CookieJar.php.

    {
        $this->cookies = $this->_rawCookies = array();
        return $this;
    }

Field Documentation

$_rawCookies

$_rawCookies = array()

protected

Definition at line 111 of file CookieJar.php.

$cookies

$cookies = array()

protected

Definition at line 104 of file CookieJar.php.

COOKIE_OBJECT

const COOKIE_OBJECT = 0

Return cookie(s) as a Zend_Http_Cookie object

Definition at line 66 of file CookieJar.php.

COOKIE_STRING_ARRAY

const COOKIE_STRING_ARRAY = 1

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

Definition at line 72 of file CookieJar.php.

COOKIE_STRING_CONCAT

const COOKIE_STRING_CONCAT = 2

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

Definition at line 78 of file CookieJar.php.

COOKIE_STRING_CONCAT_STRICT

const COOKIE_STRING_CONCAT_STRICT = 3

Return all cookies as one long string (strict mode)

• Single space after the semi-colon separating each cookie
• Remove trailing semi-colon, if any

Definition at line 85 of file CookieJar.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Http/CookieJar.php