Cookie

static Cookie fromString(string $cookie, bool $decode = false)

Creates cookie from raw header string.

Parameters

string	$cookie
bool	$decode

Return Value

Cookie

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

Parameters

string	$name	The name of the cookie
string|null	$value	The value of the cookie
int|string|DateTimeInterface	$expire	The time the cookie expires
string	$path	The path on the server in which the cookie will be available on
string|null	$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
bool	$raw	Whether the cookie value should be sent with no url encoding
string|null	$sameSite	Whether the cookie will be available for cross-site requests

Exceptions

InvalidArgumentException

string __toString()

Returns the cookie as a string.

Return Value

string

The cookie

string getName()

Gets the name of the cookie.

Return Value

string

string|null getValue()

Gets the value of the cookie.

Return Value

string|null

string|null getDomain()

Gets the domain that the cookie is available to.

Return Value

string|null

int getExpiresTime()

Gets the time the cookie expires.

Return Value

int

int getMaxAge()

Gets the max-age attribute.

Return Value

int

string getPath()

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

Return Value

string

bool isSecure()

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

Return Value

bool

bool isHttpOnly()

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

Return Value

bool

bool isCleared()

Whether this cookie is about to be cleared.

Return Value

bool

bool isRaw()

Checks if the cookie value should be sent with no url encoding.

Return Value

bool

string|null getSameSite()

Gets the SameSite attribute.

Return Value

string|null