Elgg_Http_DatabaseSessionHandler Class Reference

Inheritance diagram for Elgg_Http_DatabaseSessionHandler:

Public Member Functions
	__construct (Elgg_Database $db)
	Constructor. More...
	open ($save_path, $name)
	Re-initialize existing session, or creates a new one.Called when a session starts or when session_start() is invoked. Parameters string $save_path The path where to store/retrieve the session. string $name The session name. Returns boolean More...
	read ($session_id)
	Reads the session data from the session storage, and returns the results. Parameters string $session_id The session id. Returns string Returns an encoded string of the read data More...
	write ($session_id, $session_data)
	Writes the session data to the session storage. Parameters string $session_id The session id. string $session_data The encoded session data. Returns boolean More...
	close ()
	Closes the current session. Returns boolean More...
	destroy ($session_id)
	Destroys a session. Parameters string $session_id The session id. Returns boolean More...
	gc ($max_lifetime)
	Cleans up expired sessions. Parameters int $max_lifetime Sessions not updated for max_lifetime seconds are removed. Returns boolean More...

Protected Attributes
	$db

Detailed Description

Definition at line 11 of file DatabaseSessionHandler.php.

Constructor & Destructor Documentation

Elgg_Http_DatabaseSessionHandler::__construct

(

Elgg_Database

$db

)

Constructor.

Parameters

Elgg_Database

$db

The database

Definition at line 21 of file DatabaseSessionHandler.php.

Member Function Documentation

Elgg_Http_DatabaseSessionHandler::close

(

)

Closes the current session.

Returns

boolean

Implements Elgg_Http_SessionHandler.

Definition at line 69 of file DatabaseSessionHandler.php.

Elgg_Http_DatabaseSessionHandler::destroy

(

$session_id

)

Destroys a session.

Parameters

string

$session_id

The session id.

Returns

boolean

Implements Elgg_Http_SessionHandler.

Definition at line 76 of file DatabaseSessionHandler.php.

Elgg_Http_DatabaseSessionHandler::gc

(

$max_lifetime

)

Cleans up expired sessions.

Parameters

int

$max_lifetime

Sessions not updated for max_lifetime seconds are removed.

Returns

boolean

Implements Elgg_Http_SessionHandler.

Definition at line 86 of file DatabaseSessionHandler.php.

Elgg_Http_DatabaseSessionHandler::open	(		$save_path,
			$name
	)

Re-initialize existing session, or creates a new one.Called when a session starts or when session_start() is invoked.

Parameters

string	$save_path	The path where to store/retrieve the session.
string	$name	The session name.

Returns

boolean

Implements Elgg_Http_SessionHandler.

Definition at line 28 of file DatabaseSessionHandler.php.

Elgg_Http_DatabaseSessionHandler::read

(

$session_id

)

Reads the session data from the session storage, and returns the results.

Parameters

string

$session_id

The session id.

Returns

string Returns an encoded string of the read data

Implements Elgg_Http_SessionHandler.

Definition at line 35 of file DatabaseSessionHandler.php.

Elgg_Http_DatabaseSessionHandler::write	(		$session_id,
			$session_data
	)

Writes the session data to the session storage.

Parameters

string	$session_id	The session id.
string	$session_data	The encoded session data.

Returns

boolean

Implements Elgg_Http_SessionHandler.

Definition at line 50 of file DatabaseSessionHandler.php.

Member Data Documentation

Elgg_Http_DatabaseSessionHandler::$db

protected

Definition at line 14 of file DatabaseSessionHandler.php.

---

The documentation for this class was generated from the following file:

• engine/classes/Elgg/Http/DatabaseSessionHandler.php