Docs For Class sessions

Description

Session class to perform the majority of session functionality in ILance.

author: ILance
version: $Revision: 1.0.0 $

Located in /api/class.sessions.inc.php (line 40)

Variable Summary

$admintimeout $admintimeout

$crawlertimeout $crawlertimeout

$guesttimeout $guesttimeout

$membertimeout $membertimeout

$registry $registry

Method Summary

sessions __construct ($registry $registry)

void __destruct ()

array decrypt ([string $data = ''])

string encrypt ([array $data = ''])

void handle_language_style_changes ()

void init_remembered_session ()

bool session_close ()

void session_destroy ([string $sessionkey = ''])

string session_firstclick ([string $sessionkey = ''])

void session_gc ([ $maxlifetime = ''])

bool session_open ([ $savepath = ''], [ $sessioname = ''])

string session_read (string $sessionkey)

void session_write ([string $sessionkey = ''], [string $sessiondata = ''])

Variables

$admintimeout $admintimeout = 90 (line 68)

Timeout in minutes for logged in administrators

$crawlertimeout $crawlertimeout = 5 (line 75)

Timeout in minutes for crawlers and search bots

$guesttimeout $guesttimeout = 30 (line 54)

Timeout in minutes for guests and visitors

$membertimeout $membertimeout = 90 (line 61)

Timeout in minutes for logged in members

$registry $registry = null (line 47)

The ILance session registry object

Methods

Constructor __construct (line 82)

Constructor

sessions __construct ($registry $registry)

$registry $registry: ILance registry object

Destructor __destruct (line 567)

Ensure session data is written out before classes are destroyed (see http://bugs.php.net/bug.php?id=33772 for details)

void __destruct ()

decrypt (line 122)

Decrypt and return the encrypted or serialized session data

return: Session data

array decrypt ([string $data = ''])

string $data: encrypted session data

encrypt (line 105)

Encrypt and compress the serailized session data

return: Encrypted session data

string encrypt ([array $data = ''])

array $data: session data

handle_language_style_changes (line 481)

Function to handle a user language or style switch within the marketplace. Additionally, will update their account within the db if the user is active and logged in. This is called from global.php.

Additionally, this function is responsible for setting the user's initial languageid and styleid for the active session.

void handle_language_style_changes ()

init_remembered_session (line 367)

void init_remembered_session ()

session_close (line 171)

Session close handler

return: true if session data could be closed

bool session_close ()

session_destroy (line 340)

Session destroy handler

void session_destroy ([string $sessionkey = ''])

string $sessionkey: session key

session_firstclick (line 140)

Fetch session first click if applicable

return: Returns first click timestamp

string session_firstclick ([string $sessionkey = ''])

string $sessionkey: session key

session_gc (line 356)

Session garbage collection handler

void session_gc ([ $maxlifetime = ''])

$maxlifetime

session_open (line 161)

Session open handler

return: true if session data could be opened

bool session_open ([ $savepath = ''], [ $sessioname = ''])

$savepath
$sessioname

session_read (line 184)

Session read handler is called once the script is loaded

return: value from the session table

string session_read (string $sessionkey)

string $sessionkey: session key

session_write (line 206)

Session write handler is called once the script is finished executing

void session_write ([string $sessionkey = ''], [string $sessiondata = ''])

string $sessionkey: session key
string $sessiondata: session data we would like to update