Zend Framework » \Zend\Http\Header\SetCookie

`\Zend\Http\Header\Exception\InvalidArgumentException`
see	\Zend\Http\Header\http://www.ietf.org/rfc/rfc2109.txt
see	\Zend\Http\Header\http://www.w3.org/Protocols/rfc2109/rfc2109

Methods

Cookie object constructor

__construct(string $name, string $value, int $expires, string $path, string $domain, bool $secure, bool $httponly, string $maxAge, int $version) : \Zend\Http\Header\SetCookie

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

Parameters

$name

string

$value

string

$expires

int

$path

string

$domain

string

$secure

bool

$httponly

bool

$maxAge

string

$version

int

Returns

\Zend\Http\Header\SetCookie

fromString()

fromString($headerLine, bool $bypassHeaderFieldName) : array | \Zend\Http\Header\SetCookie

static

Parameters

$headerLine

$bypassHeaderFieldName

bool

Exceptions

`\Zend\Http\Header\Exception\InvalidArgumentException`

Returns

array\Zend\Http\Header\SetCookie

getDomain()

getDomain() : string

Returns

string

getExpires()

getExpires(bool $inSeconds) : int

Parameters

$inSeconds

bool

Returns

int

getFieldName()

getFieldName() : string

Returns

string'Set-Cookie'

getFieldValue()

getFieldValue() : string

Exceptions

`\Zend\Http\Header\Exception\RuntimeException`

Returns

string

Get Max-Age

getMaxAge() : integer

Returns

integer

getName()

getName() : string

Returns

string

getPath()

getPath() : string

Returns

string

getValue()

getValue() : string

Returns

string

Get version

getVersion() : integer

Returns

integer

Check whether the cookie has expired

isExpired(int $now) : bool

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

Parameters

$now

int

Timestamp to consider as "now"

Returns

bool

isHttponly()

isHttponly() : bool

Returns

bool

isSecure()

isSecure() : bool

Returns

bool

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

isSessionCookie() : bool

Returns

bool

isValidForRequest()

isValidForRequest($requestDomain, $path, $isSecure)

Parameters

$requestDomain

$path

$isSecure

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

match(string | \Zend\Http\Header\Zend\Uri\Uri $uri, boolean $matchSessionCookies, int $now) : boolean

Parameters

$uri

string\Zend\Http\Header\Zend\Uri\Uri

URI to check against (secure, domain, path)

$matchSessionCookies

boolean

Whether to send session cookies

$now

int

Override the current time when checking for expiry time

Returns

boolean

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

matchCookieDomain(string $cookieDomain, string $host) : boolean

Used by Zend\Http\Cookies for cookie matching

Parameters

$cookieDomain

string

$host

string

Returns

boolean

Check if a cookie's path matches a URL path

matchCookiePath(string $cookiePath, string $path) : boolean

Used by Zend\Http\Cookies for cookie matching

Parameters

$cookiePath

string

$path

string

Returns

boolean

setDomain()

setDomain(string $domain)

Parameters

$domain

string

setExpires()

setExpires(int $expires) : \Zend\Http\Header\SetCookie

Parameters

$expires

int

Exceptions

`\Zend\Http\Header\Exception\InvalidArgumentException`

Returns

\Zend\Http\Header\SetCookie

setHttponly()

setHttponly(bool $httponly)

Parameters

$httponly

bool

Set Max-Age

setMaxAge(integer $maxAge)

Parameters

$maxAge

integer

Exceptions

`\Zend\Http\Header\Exception\InvalidArgumentException`

setName()

setName(string $name) : \Zend\Http\Header\SetCookie

Parameters

$name

string

Exceptions

`\Zend\Http\Header\Exception\InvalidArgumentException`

Returns

\Zend\Http\Header\SetCookie

setPath()

setPath(string $path)

Parameters

$path

string

setSecure()

setSecure(bool $secure)

Parameters

$secure

bool

setValue()

setValue(string $value)

Parameters

$value

string

Set version

setVersion(integer $version)

Parameters

$version

integer

Exceptions

`\Zend\Http\Header\Exception\InvalidArgumentException`

toString()

toString()

toStringMultipleHeaders()

toStringMultipleHeaders(array $headers)

Parameters

$headers

Properties

Cookie domain

$domain : string

Cookie expiry date

$expires : int

$httponly

$httponly : bool | null

Max Age

$maxAge : integer

Cookie name

$name : string

Cookie path

$path : string

Whether the cookie is secure or not

$secure : bool

Cookie value

$value : string

Version

$version : integer