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

at line line 42
__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

at line line 78
string __toString()

Returns the cookie as a string.

Return Value

string The cookie

at line line 116
string getName()

Gets the name of the cookie.

Return Value

string

at line line 126
string getValue()

Gets the value of the cookie.

Return Value

string

at line line 136
string getDomain()

Gets the domain that the cookie is available to.

Return Value

string

at line line 146
int getExpiresTime()

Gets the time the cookie expires.

Return Value

int

at line line 156
string getPath()

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

Return Value

string

at line line 166
bool isSecure()

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

Return Value

bool

at line line 176
bool isHttpOnly()

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

Return Value

bool

at line line 186
bool isCleared()

Whether this cookie is about to be cleared.

Return Value

bool