Class icms_core_Session

Handler for a session

Based on SecureSession class Written by Vagharshak Tozalakyan vagh@armdex.com Released under GNU Public License

Package: Session
Category: ICMS
Copyright: copyright (c) 2000-2003 XOOPS.org
License: GNU General Public License (GPL)
Author: Kazumi Ono onokazu@xoops.org
Located at core/Session.php

Methods summary
`public static icms_core_Session`	# `service( )` Initialize the session service Initialize the session service Returns `icms_core_Session`
`public`	# `__construct( object & $db )` Constructor Constructor Parameters `$db` reference to the XoopsDatabase object Do we need this $db reference now we're using icms::$xoopsDB?????
`public boolean`	# `open( string $save_path, string $session_name )` Open a session Open a session Parameters `$save_path` `$session_name` Returns boolean
`public boolean`	# `close( )` Close a session Close a session Returns boolean
`public string`	# `read( string $sess_id )` Read a session from the database Read a session from the database Parameters `$sess_id` ID of the session Returns string Session data
`public boolean`	# `write( string $sess_id, string $sess_data )` Inserts a session into the database Inserts a session into the database Parameters `$sess_id` `$sess_data` Returns boolean
`public boolean`	# `destroy( string $sess_id )` Destroy a session Destroy a session Parameters `$sess_id` Returns boolean
`public boolean`	# `gc( integer $expire )` Garbage Collector Garbage Collector Parameters `$expire` Time in seconds until a session expires Returns boolean
`public`	# `gc_force( )` Force gc for situations where gc is registered but not executed Force gc for situations where gc is registered but not executed
`public boolean`	# `icms_sessionRegenerateId( boolean $regenerate = false )` Update the current session id with a newly generated one To be refactored Update the current session id with a newly generated one To be refactored Parameters `$regenerate` $delete_old_session Returns boolean
`public boolean`	# `update_cookie( string $sess_id = null, integer $expire = null )` Update cookie status for current session To be refactored Update cookie status for current session To be refactored Parameters `$sess_id` session ID `$expire` Time in seconds until a session expires Returns boolean
`public string`	# `createFingerprint( )` Creates a Fingerprint of the current User Session Fingerprint stored in current $_SESSION['icms_fprint'] To be refactored Creates a Fingerprint of the current User Session Fingerprint stored in current $_SESSION['icms_fprint'] To be refactored Returns string
`public boolean`	# `checkFingerprint( )` Compares the Fingerprint stored in $_SESSION['icms_fprint'] by creating a new Fingerprint. If they match, the Session is valid. To be refactored Compares the Fingerprint stored in $_SESSION['icms_fprint'] by creating a new Fingerprint. If they match, the Session is valid. To be refactored Returns boolean
`public`	# `sessionOpen( $regenerate = false )`
`public`	# `removeExpiredCustomSession( $sess )`
`public`	# `sessionClose( string $uid )` Closes the Session & removes Session Cookies for specified User Id To be refactored Closes the Session & removes Session Cookies for specified User Id To be refactored Parameters `$uid` User ID of user to close Returns
`public`	# `sessionStart( string $sslpost_name = '' )` Creates Session ID & Starts the session removes Expired Custom Sessions after session Start Creates Session ID & Starts the session removes Expired Custom Sessions after session Start Parameters `$sslpost_name` sets the session_id as ssl Name defined in preferences (if SSL enabled) Returns

Properties summary
`public integer`	`$securityLevel` Security checking level Possible value: 0 - no check; 1 - check browser characteristics (HTTP_USER_AGENT); 2 - check browser and IP A.B; 3 - check browser and IP A.B.C, recommended; 4 - check browser and IP A.B.C.D; Security checking level Possible value: 0 - no check; 1 - check browser characteristics (HTTP_USER_AGENT); 2 - check browser and IP A.B; 3 - check browser and IP A.B.C, recommended; 4 - check browser and IP A.B.C.D;	# `3`
`public integer`	`$ipv6securityLevel` Security checking level for IPv6 Address types Possible value: 0 - no check; 1 - check browser characteristics (HTTP_USER_AGENT); 2 - check browser and IPv6 aaaa:bbbb; 3 - check browser and IPv6 aaaa:bbbb:cccc; 4 - check browser and IPv6 aaaa:bbbb:cccc:dddd; 5 - check browser and IPv6 aaaa:bbbb:cccc:dddd:eeee; 6 - check browser and IPv6 aaaa:bbbb:cccc:dddd:eeee:ffff; 7 - check browser and IPv6 aaaa:bbbb:cccc:dddd:eeee:ffff:gggg; (recommended) 8 - check browser and IPv6 aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh; Security checking level for IPv6 Address types Possible value: 0 - no check; 1 - check browser characteristics (HTTP_USER_AGENT); 2 - check browser and IPv6 aaaa:bbbb; 3 - check browser and IPv6 aaaa:bbbb:cccc; 4 - check browser and IPv6 aaaa:bbbb:cccc:dddd; 5 - check browser and IPv6 aaaa:bbbb:cccc:dddd:eeee; 6 - check browser and IPv6 aaaa:bbbb:cccc:dddd:eeee:ffff; 7 - check browser and IPv6 aaaa:bbbb:cccc:dddd:eeee:ffff:gggg; (recommended) 8 - check browser and IPv6 aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh;	# `7`
`public boolean`	`$enableRegenerateId` Enable regenerate_id Enable regenerate_id	# `false`

Packages

Classes

Class icms_core_Session

Returns

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns