W3cubDocs

Symfony\Component\HttpFoundation\Cookie

class Cookie

Represents a cookie.

Methods

	__construct(string $name, string $value = null, int\|string\|DateTime $expire, string $path = '/', string $domain = null, bool $secure = false, bool $httpOnly = true) Constructor.
string	__toString() Returns the cookie as a string.
string	getName() Gets the name of the cookie.
string	getValue() Gets the value of the cookie.
string	getDomain() Gets the domain that the cookie is available to.
int	getExpiresTime() Gets the time the cookie expires.
string	getPath() Gets the path on the server in which the cookie will be available on.
bool	isSecure() Checks whether the cookie should only be transmitted over a secure HTTPS connection from the client.
bool	isHttpOnly() Checks whether the cookie will be made accessible only through the HTTP protocol.
bool	isCleared() Whether this cookie is about to be cleared.

Details

public __construct(string $name, string $value = null, int|string|DateTime $expire, string $path = '/', string $domain = null, bool $secure = false, bool $httpOnly = true)

Constructor.

Parameters

string	$name	The name of the cookie
string	$value	The value of the cookie
int\|string\|DateTime	$expire	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 to
bool	$secure	Whether the cookie should only be transmitted over a secure HTTPS connection from the client
bool	$httpOnly	Whether the cookie will be made accessible only through the HTTP protocol

Exceptions

InvalidArgumentException

public string __toString()

Returns the cookie as a string.

Return Value

string

The cookie

public string getName()

Gets the name of the cookie.

Return Value

string

public string getValue()

Gets the value of the cookie.

Return Value

string

public string getDomain()

Gets the domain that the cookie is available to.

Return Value

string

public int getExpiresTime()

Gets the time the cookie expires.

Return Value

int

public string getPath()

Gets the path on the server in which the cookie will be available on.

Return Value

string

public bool isSecure()

Checks whether the cookie should only be transmitted over a secure HTTPS connection from the client.

Return Value

bool

public bool isHttpOnly()

Checks whether the cookie will be made accessible only through the HTTP protocol.

Return Value

bool

public bool isCleared()

Whether this cookie is about to be cleared.

Return Value

bool

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/HttpFoundation/Cookie.html