class Cookie

Represents a cookie.

Constants

SAMESITE_LAX

SAMESITE_STRICT

Methods

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

Creates cookie from raw header string.

__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)

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.

int
getMaxAge()

Gets the max-age attribute.

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 42
static Cookie fromString(string $cookie, bool $decode = false)

Creates cookie from raw header string.

Parameters

string $cookie
bool $decode

Return Value

Cookie

at line line 98
__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)

Constructor.

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

at line line 141
string __toString()

Returns the cookie as a string.

Return Value

string The cookie

at line line 183
string getName()

Gets the name of the cookie.

Return Value

string

at line line 193
string|null getValue()

Gets the value of the cookie.

Return Value

string|null

at line line 203
string|null getDomain()

Gets the domain that the cookie is available to.

Return Value

string|null

at line line 213
int getExpiresTime()

Gets the time the cookie expires.

Return Value

int

at line line 223
int getMaxAge()

Gets the max-age attribute.

Return Value

int

at line line 233
string getPath()

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

Return Value

string

at line line 243
bool isSecure()

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

Return Value

bool

at line line 253
bool isHttpOnly()

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

Return Value

bool

at line line 263
bool isCleared()

Whether this cookie is about to be cleared.

Return Value

bool

at line line 273
bool isRaw()

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

Return Value

bool

at line line 283
string|null getSameSite()

Gets the SameSite attribute.

Return Value

string|null