Zend_Http_Header_SetCookie Class Reference

Public Member Functions
	__construct ($name=null, $value=null, $expires=null, $path=null, $domain=null, $secure=false, $httponly=false, $maxAge=null, $version=null)
	getFieldName ()
	getFieldValue ()
	setName ($name)
	getName ()
	setValue ($value)
	getValue ()
	setVersion ($version)
	getVersion ()
	setMaxAge ($maxAge)
	getMaxAge ()
	setExpires ($expires)
	getExpires ($inSeconds=false)
	setDomain ($domain)
	getDomain ()
	setPath ($path)
	getPath ()
	setSecure ($secure)
	isSecure ()
	setHttponly ($httponly)
	isHttponly ()
	isExpired ($now=null)
	isSessionCookie ()
	isValidForRequest ($requestDomain, $path, $isSecure=false)
	toString ()
	__toString ()
	toStringMultipleHeaders (array $headers)

Static Public Member Functions
static	fromString ($headerLine, $bypassHeaderFieldName=false)

Protected Attributes
	$name = null
	$value = null
	$version = null
	$maxAge = null
	$expires = null
	$domain = null
	$path = null
	$secure = null
	$httponly = null

Detailed Description

Definition at line 52 of file SetCookie.php.

Constructor & Destructor Documentation

__construct()

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

Cookie object constructor

Todo:

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

Parameters

string	$name
string	$value
int	$expires
string	$path
string	$domain
bool	$secure
bool	$httponly
string	$maxAge
int	$version

Returns

SetCookie

Definition at line 189 of file SetCookie.php.

    {
        $this->type = 'Cookie';

        if ($name) {
            $this->setName($name);
        }

        if ($value) {
            $this->setValue($value); // in parent
        }

        if ($version) {
            $this->setVersion($version);
        }

        if ($maxAge) {
            $this->setMaxAge($maxAge);
        }

        if ($domain) {
            $this->setDomain($domain);
        }

        if ($expires) {
            $this->setExpires($expires);
        }

        if ($path) {
            $this->setPath($path);
        }

        if ($secure) {
            $this->setSecure($secure);
        }

        if ($httponly) {
            $this->setHttponly($httponly);
        }
    }

Member Function Documentation

__toString()

__toString

(

)

Definition at line 533 of file SetCookie.php.

    {
        return $this->toString();
    }

fromString()

static fromString (   $headerLine,   $bypassHeaderFieldName = false  )

static

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

Exceptions

Zend_Http_Header_Exception_InvalidArgumentException

Parameters

	$headerLine
bool	$bypassHeaderFieldName

Returns

array|SetCookie

Definition at line 126 of file SetCookie.php.

    {
        list($name, $value) = explode(': ', $headerLine, 2);

        // check to ensure proper header type for this factory
        if (strtolower($name) !== 'set-cookie') {
            throw new Zend_Http_Header_Exception_InvalidArgumentException('Invalid header line for Set-Cookie string: "' . $name . '"');
        }

        $multipleHeaders = preg_split('#(?<!Sun|Mon|Tue|Wed|Thu|Fri|Sat),\s*#', $value);
        $headers = array();
        foreach ($multipleHeaders as $headerLine) {
            $header = new self();
            $keyValuePairs = preg_split('#;\s*#', $headerLine);
            foreach ($keyValuePairs as $keyValue) {
                if (strpos($keyValue, '=')) {
                    list($headerKey, $headerValue) = preg_split('#=\s*#', $keyValue, 2);
                } else {
                    $headerKey = $keyValue;
                    $headerValue = null;
                }

                // First K=V pair is always the cookie name and value
                if ($header->getName() === NULL) {
                    $header->setName($headerKey);
                    $header->setValue($headerValue);
                    continue;
                }

                // Process the remanining elements
                switch (str_replace(array('-', '_'), '', strtolower($headerKey))) {
                    case 'expires' : $header->setExpires($headerValue); break;
                    case 'domain'  : $header->setDomain($headerValue); break;
                    case 'path'    : $header->setPath($headerValue); break;
                    case 'secure'  : $header->setSecure(true); break;
                    case 'httponly': $header->setHttponly(true); break;
                    case 'version' : $header->setVersion((int) $headerValue); break;
                    case 'maxage'  : $header->setMaxAge((int) $headerValue); break;
                    default:
                        // Intentionally omitted
                }
            }
            $headers[] = $header;
        }
        return count($headers) == 1 ? array_pop($headers) : $headers;
    }

getDomain()

getDomain

(

)

Returns

string

Definition at line 422 of file SetCookie.php.

    {
        return $this->domain;
    }

getExpires()

getExpires

(

$inSeconds = false

)

Returns

int

Definition at line 398 of file SetCookie.php.

    {
        if ($this->expires == null) {
            return;
        }
        if ($inSeconds) {
            return $this->expires;
        }
        return gmdate('D, d-M-Y H:i:s', $this->expires) . ' GMT';
    }

getFieldName()

getFieldName

(

)

Returns

string 'Set-Cookie'

Definition at line 233 of file SetCookie.php.

    {
        return 'Set-Cookie';
    }

getFieldValue()

getFieldValue

(

)

Exceptions

Zend_Http_Header_Exception_RuntimeException

Returns

string

Definition at line 242 of file SetCookie.php.

    {
        if ($this->getName() == '') {
            throw new Zend_Http_Header_Exception_RuntimeException('A cookie name is required to generate a field value for this cookie');
        }

        $value = $this->getValue();
        if (strpos($value,'"')!==false) {
            $value = '"'.urlencode(str_replace('"', '', $value)).'"';
        } else {
            $value = urlencode($value);
        }
        $fieldValue = $this->getName() . '=' . $value;

        $version = $this->getVersion();
        if ($version!==null) {
            $fieldValue .= '; Version=' . $version;
        }

        $maxAge = $this->getMaxAge();
        if ($maxAge!==null) {
            $fieldValue .= '; Max-Age=' . $maxAge;
        }

        $expires = $this->getExpires();
        if ($expires) {
            $fieldValue .= '; Expires=' . $expires;
        }

        $domain = $this->getDomain();
        if ($domain) {
            $fieldValue .= '; Domain=' . $domain;
        }

        $path = $this->getPath();
        if ($path) {
            $fieldValue .= '; Path=' . $path;
        }

        if ($this->isSecure()) {
            $fieldValue .= '; Secure';
        }

        if ($this->isHttponly()) {
            $fieldValue .= '; HttpOnly';
        }

        return $fieldValue;
    }

getMaxAge()

getMaxAge

(

)

Get Max-Age

Returns

integer

Definition at line 373 of file SetCookie.php.

    {
        return $this->maxAge;
    }

getName()

getName

(

)

Returns

string

Definition at line 309 of file SetCookie.php.

    {
        return $this->name;
    }

getPath()

getPath

(

)

Returns

string

Definition at line 440 of file SetCookie.php.

    {
        return $this->path;
    }

getValue()

getValue

(

)

Returns

string

Definition at line 327 of file SetCookie.php.

    {
        return $this->value;
    }

getVersion()

getVersion

(

)

Get version

Returns

integer

Definition at line 350 of file SetCookie.php.

    {
        return $this->version;
    }

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 487 of file SetCookie.php.

    {
        if ($now === null) {
            $now = time();
        }

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

isHttponly()

isHttponly

(

)

Returns

bool

Definition at line 474 of file SetCookie.php.

    {
        return $this->httponly;
    }

isSecure()

isSecure

(

)

Returns

boolean

Definition at line 457 of file SetCookie.php.

    {
        return $this->secure;
    }

isSessionCookie()

isSessionCookie

(

)

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

Returns

boolean

Definition at line 505 of file SetCookie.php.

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

isValidForRequest()

isValidForRequest	(		$requestDomain,
			$path,
			$isSecure = false
	)

Definition at line 510 of file SetCookie.php.

    {
        if ($this->getDomain() && (strrpos($requestDomain, $this->getDomain()) !== false)) {
            return false;
        }

        if ($this->getPath() && (strpos($path, $this->getPath()) !== 0)) {
            return false;
        }

        if ($this->secure && $this->isSecure()!==$isSecure) {
            return false;
        }

        return true;

    }

setDomain()

setDomain

(

$domain

)

Parameters

string

$domain

Definition at line 412 of file SetCookie.php.

    {
        Zend_Http_Header_HeaderValue::assertValid($domain);
        $this->domain = $domain;
        return $this;
    }

setExpires()

setExpires

(

$expires

)

Parameters

int

$expires

Returns

SetCookie

Definition at line 382 of file SetCookie.php.

    {
        if (!empty($expires)) {
            if (is_string($expires)) {
                $expires = strtotime($expires);
            } elseif (!is_int($expires)) {
                throw new Zend_Http_Header_Exception_InvalidArgumentException('Invalid expires time specified');
            }
            $this->expires = (int) $expires;
        }
        return $this;
    }

setHttponly()

setHttponly

(

$httponly

)

Parameters

bool

$httponly

Definition at line 465 of file SetCookie.php.

    {
        $this->httponly = $httponly;
        return $this;
    }

setMaxAge()

setMaxAge

(

$maxAge

)

Set Max-Age

Parameters

integer

$maxAge

Definition at line 360 of file SetCookie.php.

    {
        if (!is_int($maxAge) || ($maxAge<0)) {
            throw new Zend_Http_Header_Exception_InvalidArgumentException('Invalid Max-Age number specified');
        }
        $this->maxAge = $maxAge;
    }

setName()

setName

(

$name

)

Parameters

string

$name

Returns

SetCookie

Definition at line 296 of file SetCookie.php.

    {
        if (preg_match("/[=,; \t\r\n\013\014]/", $name)) {
            throw new Zend_Http_Header_Exception_InvalidArgumentException("Cookie name cannot contain these characters: =,; \\t\\r\\n\\013\\014 ({$name})");
        }

        $this->name = $name;
        return $this;
    }

setPath()

setPath

(

$path

)

Parameters

string

$path

Definition at line 430 of file SetCookie.php.

    {
        Zend_Http_Header_HeaderValue::assertValid($path);
        $this->path = $path;
        return $this;
    }

setSecure()

setSecure

(

$secure

)

Parameters

boolean

$secure

Definition at line 448 of file SetCookie.php.

    {
        $this->secure = $secure;
        return $this;
    }

setValue()

setValue

(

$value

)

Parameters

string

$value

Definition at line 317 of file SetCookie.php.

    {
        Zend_Http_Header_HeaderValue::assertValid($value);
        $this->value = $value;
        return $this;
    }

setVersion()

setVersion

(

$version

)

Set version

Parameters

integer

$version

Definition at line 337 of file SetCookie.php.

    {
        if (!is_int($version)) {
            throw new Zend_Http_Header_Exception_InvalidArgumentException('Invalid Version number specified');
        }
        $this->version = $version;
    }

toString()

toString

(

)

Definition at line 528 of file SetCookie.php.

    {
        return $this->getFieldName() . ': ' . $this->getFieldValue();
    }

toStringMultipleHeaders()

toStringMultipleHeaders

(

array

$headers

)

Definition at line 538 of file SetCookie.php.

    {
        $headerLine = $this->toString();
        /* @var $header SetCookie */
        foreach ($headers as $header) {
            if (!$header instanceof Zend_Http_Header_SetCookie) {
                throw new Zend_Http_Header_Exception_RuntimeException(
                    'The SetCookie multiple header implementation can only accept an array of SetCookie headers'
                );
            }
            $headerLine .= ', ' . $header->getFieldValue();
        }
        return $headerLine;
    }

Field Documentation

$domain

$domain = null

protected

Definition at line 95 of file SetCookie.php.

$expires

$expires = null

protected

Definition at line 88 of file SetCookie.php.

$httponly

$httponly = null

protected

Definition at line 114 of file SetCookie.php.

$maxAge

$maxAge = null

protected

Definition at line 81 of file SetCookie.php.

$name

$name = null

protected

Definition at line 60 of file SetCookie.php.

$path

$path = null

protected

Definition at line 102 of file SetCookie.php.

$secure

$secure = null

protected

Definition at line 109 of file SetCookie.php.

$value

$value = null

protected

Definition at line 67 of file SetCookie.php.

$version

$version = null

protected

Definition at line 74 of file SetCookie.php.

---

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

• vendor/magento/zendframework1/library/Zend/Http/Header/SetCookie.php