class DatabaseStore extends BaseStore (View source)

Traits

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

Constants

private HASH_ALGO

Hashing algorithm used to encrypt $session_id (PHPSESSID) Ensure that HybridSessionDataObject.SessionID is wide enough to accomodate the hash

Properties

protected string $key

Session secret key

from  BaseStore

Methods

public static 
config()

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

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

public
setKey(string $key)

Assign a new session secret key

protected
string
getKey()

Get the session secret key

protected
int
getLifetime()

Get lifetime in number of seconds

protected
int
getNow()

Gets the current unix timestamp

protected
bool
isDatabaseReady()

Determine if the DB is ready to use.

public
open($save_path, $name)

No description

public
close()

No description

public
read($session_id)

No description

public
write($session_id, $session_data)

No description

public
destroy($session_id)

No description

public
gc($maxlifetime)

No description

public static 
string
binaryDataJsonEncode(string $data)

Encode binary data into ASCII string (a subset of UTF-8)

public static 
binaryDataJsonDecode(string $text)

Decode ASCII string into original binary data (a php string)

Details

static Config_ForClass config()

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

Return Value

Config_ForClass

mixed stat(string $name) deprecated

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

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$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

setKey(string $key)

Assign a new session secret key

Parameters

string $key

protected string getKey()

Get the session secret key

Return Value

string

protected int getLifetime()

Get lifetime in number of seconds

Return Value

int

protected int getNow()

Gets the current unix timestamp

Return Value

int

protected bool isDatabaseReady()

Determine if the DB is ready to use.

Return Value

bool

Exceptions

Exception

open($save_path, $name)

No description

Parameters

$save_path
$name

close()

No description

read($session_id)

No description

Parameters

$session_id

write($session_id, $session_data)

No description

Parameters

$session_id
$session_data

destroy($session_id)

No description

Parameters

$session_id

gc($maxlifetime)

No description

Parameters

$maxlifetime

static string binaryDataJsonEncode(string $data)

Encode binary data into ASCII string (a subset of UTF-8)

Silverstripe <= 4.4 does not have a binary db field implementation, so we have to store binary data as text

Parameters

string $data

This is a binary blob

Return Value

string

static binaryDataJsonDecode(string $text)

Decode ASCII string into original binary data (a php string)

Silverstripe <= 4.4 does not have a binary db field implementation, so we have to store binary data as text

Parameters

string $text