Documentation

File extends Base
in package

Base Session Class.

Tags
copyright

YetiForce Sp. z o.o

license

YetiForce Public License 4.0 (licenses/LicenseEN.txt or yetiforce.com)

author

Mariusz Krzaczkowski m.krzaczkowski@yetiforce.com

author

Tomasz Kur t.kur@yetiforce.com

Table of Contents

__construct()  : mixed
Construct.
clean()  : array<string|int, string>
Function to clean session. Removed old session.
cleanAll()  : int
Function to clean all session.
delete()  : mixed
Function to remove the value.
get()  : mixed
Function to get the value for a given key.
getById()  : array<string|int, mixed>
Function to get session data by id.
has()  : bool
Function to check if the key exists.
isSupported()  : bool
Is driver available.
regenerateId()  : mixed
Update the current session id with a newly generated one.
set()  : $this
Function to set the value for a given key.
unserialize()  : array<string|int, mixed>
Deserialize session data from string, entry function.
unserializePhp()  : array<string|int, mixed>
Deserialize session data from string php handler method.
unserializePhpBinary()  : array<string|int, mixed>
Deserialize session data from string php_binary handler method.

Methods

__construct()

Construct.

public __construct([string $name = 'YTSID' ]) : mixed
Parameters
$name : string = 'YTSID'
Return values
mixed

clean()

Function to clean session. Removed old session.

public static clean() : array<string|int, string>
Return values
array<string|int, string>

cleanAll()

Function to clean all session.

public static cleanAll() : int
Return values
int

delete()

Function to remove the value.

public delete(string $key) : mixed
Parameters
$key : string
Return values
mixed

get()

Function to get the value for a given key.

public get(string $key) : mixed
Parameters
$key : string
Return values
mixed

Value for the given key

getById()

Function to get session data by id.

public getById(string $sessionId) : array<string|int, mixed>
Parameters
$sessionId : string
Return values
array<string|int, mixed>

has()

Function to check if the key exists.

public has(string $key) : bool
Parameters
$key : string
Return values
bool

isSupported()

Is driver available.

public static isSupported() : bool
Return values
bool

set()

Function to set the value for a given key.

public set(string $key, mixed $value) : $this
Parameters
$key : string
$value : mixed
Return values
$this

unserialize()

Deserialize session data from string, entry function.

public static unserialize(string $session) : array<string|int, mixed>
Parameters
$session : string
Tags
throws
IllegalValue
throws
NotAllowedMethod
example

http://php.net/manual/en/function.session-decode.php#108037

Return values
array<string|int, mixed>

unserializePhp()

Deserialize session data from string php handler method.

private static unserializePhp(string $session) : array<string|int, mixed>
Parameters
$session : string
Tags
throws
IllegalValue
Return values
array<string|int, mixed>

unserializePhpBinary()

Deserialize session data from string php_binary handler method.

private static unserializePhpBinary(string $session) : array<string|int, mixed>
Parameters
$session : string
Return values
array<string|int, mixed>

        

Search results