\GuzzleHttp\CookieSetCookie

fromString()

fromString(string  $cookie) : self

Create a new SetCookie object from a string

Parameters

Returns

__construct()

__construct(array  $data = array()) 

Parameters

__toString()

__toString() 

toArray()

toArray() 

getName()

getName() : string

Get the cookie name

Returns

setName()

setName(string  $name) 

Set the cookie name

Parameters

getValue()

getValue() : string

Get the cookie value

Returns

setValue()

setValue(string  $value) 

Set the cookie value

Parameters

getDomain()

getDomain() : string|null

Get the domain

Returns

setDomain()

setDomain(string  $domain) 

Set the domain of the cookie

Parameters

getPath()

getPath() : string

Get the path

Returns

setPath()

setPath(string  $path) 

Set the path of the cookie

Parameters

getMaxAge()

getMaxAge() : integer|null

Maximum lifetime of the cookie in seconds

Returns

setMaxAge()

setMaxAge(integer  $maxAge) 

Set the max-age of the cookie

Parameters

getExpires()

getExpires() : mixed

The UNIX timestamp when the cookie Expires

Returns

setExpires()

setExpires(integer  $timestamp) 

Set the unix timestamp for which the cookie will expire

Parameters

getSecure()

getSecure() : null|boolean

Get whether or not this is a secure cookie

Returns

setSecure()

setSecure(boolean  $secure) 

Set whether or not the cookie is secure

Parameters

getDiscard()

getDiscard() : null|boolean

Get whether or not this is a session cookie

Returns

setDiscard()

setDiscard(boolean  $discard) 

Set whether or not this is a session cookie

Parameters

getHttpOnly()

getHttpOnly() : boolean

Get whether or not this is an HTTP only cookie

Returns

setHttpOnly()

setHttpOnly(boolean  $httpOnly) 

Set whether or not this is an HTTP only cookie

Parameters

matchesPath()

matchesPath(string  $requestPath) : boolean

Check if the cookie matches a path value.

A request-path path-matches a given cookie-path if at least one of the following conditions holds:

• The cookie-path and the request-path are identical.
• The cookie-path is a prefix of the request-path, and the last character of the cookie-path is %x2F ("/").
• The cookie-path is a prefix of the request-path, and the first character of the request-path that is not included in the cookie- path is a %x2F ("/") character.

Parameters

Returns

matchesDomain()

matchesDomain(string  $domain) : boolean

Check if the cookie matches a domain value

Parameters

Returns

isExpired()

isExpired() : boolean

Check if the cookie is expired

Returns

validate()

validate() : boolean|string

Check if the cookie is valid according to RFC 6265

Returns

Returns true if valid or an error message if invalid