Symfony2 API
Class

Symfony\Component\HttpFoundation\Cookie

class Cookie

Represents a cookie

Methods

__construct(string $name, string $value = null, integer|string|DateTime $expire, string $path = '/', string $domain = null, Boolean $secure = false, Boolean $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.
integer getExpiresTime()

Gets the time the cookie expires.
string getPath()

Gets the path on the server in which the cookie will be available on.
Boolean isSecure()

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

Checks whether the cookie will be made accessible only through the HTTP protocol.
Boolean isCleared()

Whether this cookie is about to be cleared

Details

at line 46
public __construct(string $name, string $value = null, integer|string|DateTime $expire, string $path = '/', string $domain = null, Boolean $secure = false, Boolean $httpOnly = true)

Constructor.

Parameters

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

Exceptions

InvalidArgumentException

at line 82
public string __toString()

Returns the cookie as a string.

Return Value

string The cookie

at line 122
public string getName()

Gets the name of the cookie.

Return Value

string

at line 134
public string getValue()

Gets the value of the cookie.

Return Value

string

at line 146
public string getDomain()

Gets the domain that the cookie is available to.

Return Value

string

at line 158
public integer getExpiresTime()

Gets the time the cookie expires.

Return Value

integer

at line 170
public string getPath()

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

Return Value

string

at line 182
public Boolean isSecure()

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

Return Value

Boolean

at line 194
public Boolean isHttpOnly()

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

Return Value

Boolean

at line 206
public Boolean isCleared()

Whether this cookie is about to be cleared

Return Value

Boolean