Documentation

Session
in package

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

Table of Contents

SESSION_PATH  = ROOT_DIRECTORY . DIRECTORY_SEPARATOR . 'cache' . DIRECTORY_SEPARATOR . 'session'
$pool  : Base
Session handler.
clean()  : array<string|int, string>
Function to clean session. Removed old session.
cleanAll()  : int
Function to clean all session.
delete()  : bool
Removes the item from the session.
destroy()  : mixed
Destroys all data registered to a session.
get()  : array<string|int, mixed>|string
Returns a session Item representing the specified key.
getById()  : array<string|int, mixed>
Function to get session data by id.
has()  : bool
Confirms if the session contains specified session item.
init()  : mixed
Initialize session class.
load()  : bool
Load session driver.
regenerateId()  : mixed
Update the current session id with a newly generated one.
set()  : bool
Session Save.

Constants

SESSION_PATH

public string SESSION_PATH = ROOT_DIRECTORY . DIRECTORY_SEPARATOR . 'cache' . DIRECTORY_SEPARATOR . 'session'

Session path

Properties

Methods

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()

Removes the item from the session.

public static delete(string $key) : bool
Parameters
$key : string
Return values
bool

get()

Returns a session Item representing the specified key.

public static get(string $key) : array<string|int, mixed>|string
Parameters
$key : string
Return values
array<string|int, mixed>|string

getById()

Function to get session data by id.

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

has()

Confirms if the session contains specified session item.

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

init()

Initialize session class.

public static init() : mixed
Return values
mixed

load()

Load session driver.

public static load() : bool
Return values
bool

set()

Session Save.

public static set(string $key[, mixed $value = null ]) : bool
Parameters
$key : string
$value : mixed = null
Return values
bool

        

Search results