class HybridSession extends BaseStore (View source)

Traits

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

Properties

protected string|null $key

Session secret key

from  BaseStore
protected SessionHandlerInterface[] $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
uninherited(string $name)

Gets the uninherited value for the given config option

public
void
setKey(string|null $key)

Assign a new session secret key

protected
string|null
getKey()

Get the session secret key

protected
int
getLifetime()

Get lifetime in number of seconds

protected
int
getNow()

Gets the current unix timestamp

public
setHandlers(array $handlers)

No description

public
array
getHandlers()

No description

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

No description

public
bool
close()

No description

public
string|false
read(string $session_id)

No description

public
bool
write(string $session_id, string $session_data)

No description

public
bool
destroy(string $session_id)

No description

public
int|false
gc(int $maxlifetime)

No description

public static 
init(string $key = null)

Register the session handler as the default

public static 
bool
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 uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

void setKey(string|null $key)

Assign a new session secret key

Parameters

string|null $key

Return Value

void

protected string|null getKey()

Get the session secret key

Return Value

string|null

protected int getLifetime()

Get lifetime in number of seconds

Return Value

int

protected int getNow()

Gets the current unix timestamp

Return Value

int

HybridSession setHandlers(array $handlers)

No description

Parameters

array $handlers

Return Value

HybridSession

array getHandlers()

No description

Return Value

array

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|false read(string $session_id)

No description

Parameters

string $session_id

Return Value

string|false

bool write(string $session_id, string $session_data)

No description

Parameters

string $session_id
string $session_data

Return Value

bool

bool destroy(string $session_id)

No description

Parameters

string $session_id

Return Value

bool

int|false gc(int $maxlifetime)

No description

Parameters

int $maxlifetime

Return Value

int|false

static init(string $key = null)

Register the session handler as the default

Parameters

string $key

Desired session key

static bool is_enabled()

No description

Return Value

bool