Documentation

Session
in package

FinalYes

Legacy session persistence helper backed by cookies and the slothsoft DBMS layer.

Included for historical compatibility only. This API is deprecated and should not be used in new code.

Tags
author

Daniel Schulz

since
2012-12-16

Table of Contents

Constants

GLOBAL_SESSION  : mixed = null

Properties

$cookieName  : mixed
$data  : mixed
$dbmsTable  : mixed
$dbName  : mixed
$hashList  : mixed
$initialized  : mixed
$key  : mixed
$tableName  : mixed

Methods

__construct()  : mixed
getCookie()  : mixed
getDataValue()  : mixed
getGlobalValue()  : mixed
setCookie()  : void
setDataValue()  : void
setGlobalValue()  : void
decodeData()  : mixed
encodeData()  : string|false
generateKey()  : string
hash()  : string
init()  : void
initKey()  : void
install()  : void
loadData()  : mixed
saveData()  : void

Constants

GLOBAL_SESSION

public mixed GLOBAL_SESSION = null

Properties

$cookieName

protected mixed $cookieName = 'session-key'

$dbmsTable

protected mixed $dbmsTable

$dbName

protected mixed $dbName = 'cms'

$hashList

protected static mixed $hashList = []

$initialized

protected mixed $initialized

$tableName

protected mixed $tableName = 'session'

Methods

__construct()

public __construct() : mixed

getCookie()

public getCookie(mixed $key[, mixed $val = null ]) : mixed
Parameters
$key : mixed
$val : mixed = null

getDataValue()

public getDataValue(mixed $key[, mixed $val = null ]) : mixed
Parameters
$key : mixed
$val : mixed = null

getGlobalValue()

public getGlobalValue(mixed $key[, mixed $val = null ]) : mixed
Parameters
$key : mixed
$val : mixed = null

setCookie()

public setCookie(mixed $key[, mixed $val = null ]) : void
Parameters
$key : mixed
$val : mixed = null

setDataValue()

public setDataValue(mixed $key[, mixed $val = null ]) : void
Parameters
$key : mixed
$val : mixed = null

setGlobalValue()

public setGlobalValue(mixed $key[, mixed $val = null ]) : void
Parameters
$key : mixed
$val : mixed = null

decodeData()

protected decodeData(mixed $data) : mixed
Parameters
$data : mixed

encodeData()

protected encodeData(mixed $data) : string|false
Parameters
$data : mixed
Return values
string|false

generateKey()

protected generateKey() : string
Return values
string

hash()

protected hash(mixed $name) : string
Parameters
$name : mixed
Return values
string

initKey()

protected initKey([mixed $key = null ]) : void
Parameters
$key : mixed = null

install()

protected install() : void

loadData()

protected loadData(mixed $session, mixed $key, mixed $val) : mixed
Parameters
$session : mixed
$key : mixed
$val : mixed

saveData()

protected saveData(mixed $session, mixed $key, mixed $val) : void
Parameters
$session : mixed
$key : mixed
$val : mixed
On this page

Search results