class Cookie

Represents a cookie.

Constants

SAMESITE_LAX

SAMESITE_STRICT

Methods

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

Constructor.

string
__toString()

Returns the cookie as a string.

string
getName()

Gets the name of the cookie.

string|null
getValue()

Gets the value of the cookie.

string|null
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.

bool
isRaw()

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

string|null
getSameSite()

Gets the SameSite attribute.

Details

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

Constructor.

Parameters

string $name The name of the cookie
string $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 $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

at line line 96
string __toString()

Returns the cookie as a string.

Return Value

string The cookie

at line line 138
string getName()

Gets the name of the cookie.

Return Value

string

at line line 148
string|null getValue()

Gets the value of the cookie.

Return Value

string|null

at line line 158
string|null getDomain()

Gets the domain that the cookie is available to.

Return Value

string|null

at line line 168
int getExpiresTime()

Gets the time the cookie expires.

Return Value

int

at line line 178
string getPath()

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

Return Value

string

at line line 188
bool isSecure()

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

Return Value

bool

at line line 198
bool isHttpOnly()

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

Return Value

bool

at line line 208
bool isCleared()

Whether this cookie is about to be cleared.

Return Value

bool

at line line 218
bool isRaw()

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

Return Value

bool

at line line 228
string|null getSameSite()

Gets the SameSite attribute.

Return Value

string|null