phpsessionindb.lib.php File Reference

Set function handlers for PHP session management in DB. More...

Go to the source code of this file.

Functions
	dolSessionOpen ($save_path, $session_name)
	The session open handler called by PHP whenever a session is initialized.
	dolSessionRead ($sess_id)
	This function is called whenever a session_start() call is made and reads the session variables.
	dolSessionWrite ($sess_id, $val)
	This function is called when a session is initialized with a session_start( ) call, when variables are registered or unregistered, and when session variables are modified.
	dolSessionClose ()
	This function is executed on shutdown of the session.
	dolSessionDestroy ($sess_id)
	This is called whenever the session_destroy() function call is made.
	dolSessionGC ($max_lifetime)
	This function is called on a session's start up with the probability specified in session.gc_probability.

Detailed Description

Set function handlers for PHP session management in DB.

Definition in file phpsessionindb.lib.php.

Function Documentation

dolSessionClose()

dolSessionClose

(

)

This function is executed on shutdown of the session.

Returns

boolean Always returns true.

Definition at line 175 of file phpsessionindb.lib.php.

dolSessionDestroy()

dolSessionDestroy

(

$sess_id

)

This is called whenever the session_destroy() function call is made.

Returns true if the session has successfully been deleted.

Parameters

string

$sess_id

Session iDecodeStream

Returns

boolean Always true

Definition at line 192 of file phpsessionindb.lib.php.

dolSessionGC()

dolSessionGC

(

$max_lifetime

)

This function is called on a session's start up with the probability specified in session.gc_probability.

Performs garbage collection by removing all sessions that haven't been updated in the last $max_lifetime seconds as set in session.gc_maxlifetime.

Parameters

int

$max_lifetime

Max lifetime

Returns

boolean true if the DELETE query succeeded.

Definition at line 212 of file phpsessionindb.lib.php.

References dol_now().

dolSessionOpen()

dolSessionOpen	(		$save_path,
			$session_name )

The session open handler called by PHP whenever a session is initialized.

Parameters

string	$save_path	Value of session.save_path into php.ini
string	$session_name	Session name (Example: 'DOLSESSID_xxxxxx')

Returns

boolean Always true

Definition at line 36 of file phpsessionindb.lib.php.

References getDoliDBInstance().

dolSessionRead()

dolSessionRead

(

$sess_id

)

This function is called whenever a session_start() call is made and reads the session variables.

Parameters

string

$sess_id

Session ID

Returns

string Returns "" when a session is not found or (serialized)string if session exists

Definition at line 65 of file phpsessionindb.lib.php.

dolSessionWrite()

dolSessionWrite	(		$sess_id,
			$val )

This function is called when a session is initialized with a session_start( ) call, when variables are registered or unregistered, and when session variables are modified.

Returns true on success.

Parameters

string	$sess_id	Session iDecodeStream
string	$val	Content of session

Returns

boolean Always true

Definition at line 101 of file phpsessionindb.lib.php.

References dol_now(), dol_print_error(), and getUserRemoteIP().