class HybridSession extends BaseStore (View source)

Traits

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

Properties

protected string $key

Session secret key

from  BaseStore
protected array $handlers

List of session handlers

protected static bool $enabled

True if this session store has been initialised

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)

No description

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

public
$this
setHandlers($handlers)

No description

public
getHandlers()

No description

public
bool
open(string $save_path, string $name)

No description

public
bool
close()

No description

public
string
read(string $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 
init(string $key = null)

Register the session handler as the default

public static 
is_enabled()

No description

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)

No description

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

$this setHandlers($handlers)

No description

Parameters

$handlers

Return Value

$this

SessionHandlerInterface[] getHandlers()

No description

Return Value

SessionHandlerInterface[]

bool open(string $save_path, string $name)

No description

Parameters

string $save_path
string $name

Return Value

bool

bool close()

No description

Return Value

bool

string read(string $session_id)

No description

Parameters

string $session_id

Return Value

string

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 init(string $key = null)

Register the session handler as the default

Parameters

string $key

Desired session key

static is_enabled()

No description