Zend_Http_Cookie Class Reference

Public Member Functions
	__construct ($name, $value, $domain, $expires=null, $path=null, $secure=false)
	getName ()
	getValue ()
	getDomain ()
	getPath ()
	getExpiryTime ()
	isSecure ()
	isExpired ($now=null)
	isSessionCookie ()
	match ($uri, $matchSessionCookies=true, $now=null)
	__toString ()

Static Public Member Functions
static	fromString ($cookieStr, $refUri=null, $encodeValue=true)
static	matchCookieDomain ($cookieDomain, $host)
static	matchCookiePath ($cookiePath, $path)

Protected Attributes
	$name
	$value
	$expires
	$domain
	$path
	$secure
	$encodeValue

Detailed Description

Definition at line 47 of file Cookie.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$name,
			$value,
			$domain,
			$expires = null,
			$path = null,
			$secure = false
	)

Cookie object constructor

Todo:

Add validation of each one of the parameters (legal domain, etc.)

Parameters

string	$name
string	$value
string	$domain
int	$expires
string	$path
bool	$secure

Definition at line 110 of file Cookie.php.

    {
        if (preg_match("/[=,; \t\r\n\013\014]/", $name)) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception("Cookie name cannot contain these characters: =,; \\t\\r\\n\\013\\014 ({$name})");
        }

        if (! $this->name = (string) $name) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception('Cookies must have a name');
        }

        if (! $this->domain = (string) $domain) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception('Cookies must have a domain');
        }

        $this->value = (string) $value;
        $this->expires = ($expires === null ? null : (int) $expires);
        $this->path = ($path ? $path : '/');
        $this->secure = $secure;
    }

Member Function Documentation

__toString()

__toString

(

)

Get the cookie as a string, suitable for sending as a "Cookie" header in an HTTP request

Returns

string

Definition at line 266 of file Cookie.php.

    {
        if ($this->encodeValue) {
            return $this->name . '=' . urlencode($this->value) . ';';
        }
        return $this->name . '=' . $this->value . ';';
    }

fromString()

static fromString (   $cookieStr,   $refUri = null,   $encodeValue = true  )

static

Generate a new Cookie object from a cookie string (for example the value of the Set-Cookie HTTP header)

Parameters

string	$cookieStr
Zend_Uri_Http | string	$refUri	Reference URI for default values (domain, path)
boolean	$encodeValue	Whether or not the cookie's value should be passed through urlencode/urldecode

Returns

Zend_Http_Cookie A new Zend_Http_Cookie object or false on failure.

The expiration is past Tue, 19 Jan 2038 03:14:07 UTC the maximum for 32-bit signed integer. Zend_Date can get around that limit.

See also

Zend_Date

Definition at line 284 of file Cookie.php.

    {
        // Set default values
        if (is_string($refUri)) {
            $refUri = Zend_Uri_Http::factory($refUri);
        }

        $name    = '';
        $value   = '';
        $domain  = '';
        $path    = '';
        $expires = null;
        $secure  = false;
        $parts   = explode(';', $cookieStr);

        // If first part does not include '=', fail
        if (strpos($parts[0], '=') === false) return false;

        // Get the name and value of the cookie
        list($name, $value) = explode('=', trim(array_shift($parts)), 2);
        $name  = trim($name);
        if ($encodeValue) {
            $value = urldecode(trim($value));
        }

        // Set default domain and path
        if ($refUri instanceof Zend_Uri_Http) {
            $domain = $refUri->getHost();
            $path = $refUri->getPath();
            $path = substr($path, 0, strrpos($path, '/'));
        }

        // Set other cookie parameters
        foreach ($parts as $part) {
            $part = trim($part);
            if (strtolower($part) == 'secure') {
                $secure = true;
                continue;
            }

            $keyValue = explode('=', $part, 2);
            if (count($keyValue) == 2) {
                list($k, $v) = $keyValue;
                switch (strtolower($k))    {
                    case 'expires':
                        if(($expires = strtotime($v)) === false) {
                            #require_once 'Zend/Date.php';

                            $expireDate = new Zend_Date($v);
                            $expires = $expireDate->getTimestamp();
                        }
                        break;

                    case 'path':
                        $path = $v;
                        break;

                    case 'domain':
                        $domain = $v;
                        break;

                    default:
                        break;
                }
            }
        }

        if ($name !== '') {
            $ret = new self($name, $value, $domain, $expires, $path, $secure);
            $ret->encodeValue = ($encodeValue) ? true : false;
            return $ret;
        } else {
            return false;
        }
    }

getDomain()

getDomain

(

)

Get cookie domain

Returns

string

Definition at line 158 of file Cookie.php.

    {
        return $this->domain;
    }

getExpiryTime()

getExpiryTime

(

)

Get the expiry time of the cookie, or null if no expiry time is set

Returns

int|null

Definition at line 178 of file Cookie.php.

    {
        return $this->expires;
    }

getName()

getName

(

)

Get Cookie name

Returns

string

Definition at line 138 of file Cookie.php.

    {
        return $this->name;
    }

getPath()

getPath

(

)

Get the cookie path

Returns

string

Definition at line 168 of file Cookie.php.

    {
        return $this->path;
    }

getValue()

getValue

(

)

Get cookie value

Returns

string

Definition at line 148 of file Cookie.php.

    {
        return $this->value;
    }

isExpired()

isExpired

(

$now = null

)

Check whether the cookie has expired

Always returns false if the cookie is a session cookie (has no expiry time)

Parameters

int

$now

Timestamp to consider as "now"

Returns

boolean

Definition at line 201 of file Cookie.php.

    {
        if ($now === null) $now = time();
        if (is_int($this->expires) && $this->expires < $now) {
            return true;
        } else {
            return false;
        }
    }

isSecure()

isSecure

(

)

Check whether the cookie should only be sent over secure connections

Returns

boolean

Definition at line 188 of file Cookie.php.

    {
        return $this->secure;
    }

isSessionCookie()

isSessionCookie

(

)

Check whether the cookie is a session cookie (has no expiry time set)

Returns

boolean

Definition at line 216 of file Cookie.php.

    {
        return ($this->expires === null);
    }

match()

match	(		$uri,
			$matchSessionCookies = true,
			$now = null
	)

Checks whether the cookie should be sent or not in a specific scenario

Parameters

string | Zend_Uri_Http	$uri	URI to check against (secure, domain, path)
boolean	$matchSessionCookies	Whether to send session cookies
int	$now	Override the current time when checking for expiry time

Returns

boolean

Definition at line 229 of file Cookie.php.

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

        // Make sure we have a valid Zend_Uri_Http object
        if (! ($uri->valid() && ($uri->getScheme() == 'http' || $uri->getScheme() =='https'))) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception('Passed URI is not a valid HTTP or HTTPS URI');
        }

        // Check that the cookie is secure (if required) and not expired
        if ($this->secure && $uri->getScheme() != 'https') return false;
        if ($this->isExpired($now)) return false;
        if ($this->isSessionCookie() && ! $matchSessionCookies) return false;

        // Check if the domain matches
        if (! self::matchCookieDomain($this->getDomain(), $uri->getHost())) {
            return false;
        }

        // Check that path matches using prefix match
        if (! self::matchCookiePath($this->getPath(), $uri->getPath())) {
            return false;
        }

        // If we didn't die until now, return true.
        return true;
    }

matchCookieDomain()

static matchCookieDomain (   $cookieDomain,   $host  )

static

Check if a cookie's domain matches a host name.

Used by Zend_Http_Cookie and Zend_Http_CookieJar for cookie matching

Parameters

string	$cookieDomain
string	$host

Returns

boolean

Definition at line 377 of file Cookie.php.

    {
        if (! $cookieDomain) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception("\$cookieDomain is expected to be a cookie domain");
        }

        if (! $host) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception("\$host is expected to be a host name");
        }

        $cookieDomain = strtolower($cookieDomain);
        $host = strtolower($host);

        if ($cookieDomain[0] == '.') {
            $cookieDomain = substr($cookieDomain, 1);
        }

        // Check for either exact match or suffix match
        return ($cookieDomain == $host ||
                preg_match('/\.' . preg_quote($cookieDomain) . '$/', $host));
    }

matchCookiePath()

static matchCookiePath (   $cookiePath,   $path  )

static

Check if a cookie's path matches a URL path

Used by Zend_Http_Cookie and Zend_Http_CookieJar for cookie matching

Parameters

string	$cookiePath
string	$path

Returns

boolean

Definition at line 410 of file Cookie.php.

    {
        if (! $cookiePath) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception("\$cookiePath is expected to be a cookie path");
        }

        if (! $path) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception("\$path is expected to be a host name");
        }

        return (strpos($path, $cookiePath) === 0);
    }

Field Documentation

$domain

$domain

protected

Definition at line 75 of file Cookie.php.

$encodeValue

$encodeValue

protected

Definition at line 96 of file Cookie.php.

$expires

$expires

protected

Definition at line 68 of file Cookie.php.

$name

$name

protected

Definition at line 54 of file Cookie.php.

$path

$path

protected

Definition at line 82 of file Cookie.php.

$secure

$secure

protected

Definition at line 89 of file Cookie.php.

$value

$value

protected

Definition at line 61 of file Cookie.php.

---

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

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