1. class
  2. SilverStripe
  3. \
  4. Control
  5. \
  6. Cookie

Cookie

class Cookie

A set of static methods for manipulating cookies.

Traits

Configurable
Provides extensions to this object to integrate it with standard config API methods.

Config options

report_errors bool

Methods

static Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

from Configurable
mixed
stat(string $name) deprecated

Get inherited config value

from Configurable
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

from Configurable
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

from Configurable
static Cookie_Backend
get_inst()

Fetch the current instance of the cookie backend.

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.

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

Get the cookie value by name. Returns null if not set.

static array
get_all(bool $includeUnsent = true)

Get all the cookies.

static 
force_expiry(string $name, null|string $path = null, null|string $domain = null, bool $secure = false, bool $httpOnly = true)

No description

Details

in Configurable at line 20
static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

....).

Return Value

Config_ForClass

in Configurable at line 32
mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

in Configurable at line 44
mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

in Configurable at line 57
$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

at line 27
static Cookie_Backend get_inst()

Fetch the current instance of the cookie backend.

Return Value

Cookie_Backend

at line 47
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.

Expiry time is set in days, and defaults to 90.

Parameters

string $name
mixed $value
int $expiry
string $path
string $domain
bool $secure
bool $httpOnly See http://php.net/set_session

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

Get the cookie value by name. Returns null if not set.

Parameters

string $name
bool $includeUnsent

Return Value

null|string

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

Get all the cookies.

Parameters

bool $includeUnsent

Return Value

array

at line 91
static force_expiry(string $name, null|string $path = null, null|string $domain = null, bool $secure = false, bool $httpOnly = true)

Parameters

string $name
null|string $path
null|string $domain
bool $secure
bool $httpOnly