Cookie

class Cookie

Cookie represents an HTTP cookie.

Methods

	__construct(string $name, string $value, string $expires = null, string $path = null, string $domain = '', bool $secure = false, bool $httponly = true, bool $encodedValue = false) Sets a cookie.
string	__toString() Returns the HTTP representation of the Cookie.
static Cookie	fromString(string $cookie, string $url = null) Creates a Cookie instance from a Set-Cookie header value.
string	getName() Gets the name of the cookie.
string	getValue() Gets the value of the cookie.
string	getRawValue() Gets the raw value of the cookie.
string	getExpiresTime() Gets the expires time of the cookie.
string	getPath() Gets the path of the cookie.
string	getDomain() Gets the domain of the cookie.
bool	isSecure() Returns the secure flag of the cookie.
bool	isHttpOnly() Returns the httponly flag of the cookie.
bool	isExpired() Returns true if the cookie has expired.

Details

__construct(string $name, string $value, string $expires = null, string $path = null, string $domain = '', bool $secure = false, bool $httponly = true, bool $encodedValue = false)

Sets a cookie.

Parameters

string	$name	The cookie name
string	$value	The value of the cookie
string	$expires	The time the cookie expires
string	$path	The path on the server in which the cookie will be available on
string	$domain	The domain that the cookie is available
bool	$secure	Indicates that the cookie should only be transmitted over a secure HTTPS connection from the client
bool	$httponly	The cookie httponly flag
bool	$encodedValue	Whether the value is encoded or not

string __toString()

Returns the HTTP representation of the Cookie.

Return Value

string

The HTTP representation of the Cookie

Exceptions

UnexpectedValueException

static Cookie fromString(string $cookie, string $url = null)

Creates a Cookie instance from a Set-Cookie header value.

Parameters

string	$cookie	A Set-Cookie header value
string	$url	The base URL

Return Value

A Cookie instance

Exceptions

InvalidArgumentException

string getName()

Gets the name of the cookie.

Return Value

string

The cookie name

string getValue()

Gets the value of the cookie.

Return Value

string

The cookie value

string getRawValue()

Gets the raw value of the cookie.

Return Value

string

The cookie value

string getExpiresTime()

Gets the expires time of the cookie.

Return Value

string

The cookie expires time

string getPath()

Gets the path of the cookie.

Return Value

string

The cookie path

string getDomain()

Gets the domain of the cookie.

Return Value

string

The cookie domain

bool isSecure()

Returns the secure flag of the cookie.

Return Value

bool	The cookie secure flag

bool isHttpOnly()

Returns the httponly flag of the cookie.

Return Value

bool	The cookie httponly flag

bool isExpired()

Returns true if the cookie has expired.

Return Value

bool	true if the cookie has expired, false otherwise

Links:

http://api.symfony.com/master/Symfony/Component/BrowserKit/Cookie.html

doc_Symfony

2016-10-28 06:12:16

Comments