Cookie

class Cookie (View source)

A set of static methods for manipulating cookies.

Properties

Methods

public static 
Cookie_Backend
get_inst()

Fetch the current instance of the cookie backend

public static 
set(string $name, mixed $value, int $expiry = 90, string $path = null, string $domain = null, bool $secure = false, bool $httpOnly = true)

Set a cookie variable

public static 
string|null
get(string $name, bool $includeUnsent = true)

Get the cookie value by name

public static 
array
get_all(bool $includeUnsent = true)

Get all the cookies

public static 
forceExpiry($name, $path = null, $domain = null) deprecated

No description

public static 
force_expiry($name, $path = null, $domain = null, $secure = false, $httpOnly = true)

No description

public static 
set_report_errors($reportErrors) deprecated

No description

public static 
report_errors() deprecated

No description

Details

at line 21
static Cookie_Backend get_inst()

Fetch the current instance of the cookie backend

Return Value

Cookie_Backend

The cookie backend

at line 36
static set(string $name, mixed $value, int $expiry = 90, string $path = null, string $domain = null, bool $secure = false, bool $httpOnly = true)

Set a cookie variable

Parameters

string $name

The variable name
mixed $value

The variable value.
int $expiry

The expiry time, in days. Defaults to 90.
string $path

See http://php.net/set_session
string $domain

See http://php.net/set_session
bool $secure

See http://php.net/set_session
bool $httpOnly

See http://php.net/set_session

at line 50
static string|null get(string $name, bool $includeUnsent = true)

Get the cookie value by name

Parameters

string $name

The name of the cookie to get
bool $includeUnsent

Include cookies we've yet to send when fetching values

Return Value

string|null

The cookie value or null if unset

at line 60
static array get_all(bool $includeUnsent = true)

Get all the cookies

Parameters

bool $includeUnsent

Include cookies we've yet to send

Return Value

array

All the cookies

at line 67
static forceExpiry($name, $path = null, $domain = null) deprecated

deprecated

No description

Parameters

$name
$path
$domain

at line 78
static force_expiry($name, $path = null, $domain = null, $secure = false, $httpOnly = true)

No description

Parameters

$name
$path
$domain
$secure
$httpOnly

at line 85
static set_report_errors($reportErrors) deprecated

deprecated

No description

Parameters

$reportErrors

at line 93
static report_errors() deprecated

deprecated

No description