SESSION

Common session functions

version 1
package wikindx4\core\session
author Mark Grimshaw

 Methods

SESSION

__construct() 

Clear session variables named with $prefix

clearArray(string $prefix) 

Parameters

$prefix

string

Clear all user sessions

clearSessionData() 

Delete a session variable

delVar(string $key, boolean $prepend) 

Parameters

$key

string

$prepend

boolean

Prepend database name to session key, default is TRUE

Destroy the whole session

destroy() 

Return an associative array of all session variables starting with $prefix_.

getArray(string $prefix) : mixed

key in returned array is minus the prefix to aid in matching database table fields.

Parameters

$prefix

string

Returns

mixedFALSE|array

Get a session variable

getVar(string $key) : mixed

Parameters

$key

string

Returns

mixedFALSE|session value

Is a session variable set?

issetVar(string $key) : boolean

Parameters

$key

string

Returns

boolean

Save the session state

saveState(string $sessionKey) 

Save the session variables to the database for logged on users

Parameters

$sessionKey

string

Set a session variable

setVar(string $inKey, string $value) : boolean

Parameters

$inKey

string

$value

string

Returns

boolean

Write to session variables named with $prefix_ the given associative array.

writeArray(array $array, string $prefix, boolean $addSlashes) : boolean

Parameters

$array

array

$prefix

string

Default is FALSE

$addSlashes

boolean

Default is FALSE

Returns

boolean

 Properties

 

$db 
 

$dbName 
 

$sessionVars 
 

$stateKeys