core\session\database Class Reference

Database based session handler. More...

Inheritance diagram for core\session\database:

Public Member Functions
	__construct ()
	Create new instance of handler.
	handler_close ()
	Close session handler. More...
	handler_destroy ($sid)
	Destroy session handler. More...
	handler_gc ($ignored_maxlifetime)
	GC session handler. More...
	handler_open ($save_path, $session_name)
	Open session handler. More...
	handler_read ($sid)
	Read session handler. More...
	handler_write ($sid, $session_data)
	Write session handler. More...
	init ()
	Init session handler.
	kill_all_sessions ()
	Kill all active sessions, the core sessions table is purged afterwards.
	kill_session ($sid)
	Kill one session, the session record is removed afterwards. More...
	session_exists ($sid)
	Check the backend contains data for this session id. More...
	start ()
	Start the session. More...

Protected Attributes
int	$acquiretimeout = 120
	$acquiretimeout how long to wait for session lock
moodle_database	$database = null
	$database session database
bool	$failed = false
	$failed session read/init failed, do not write back to DB
string	$lasthash = null
	$lasthash hash of the session data content
stdClass	$recordid = null
	$record session record

Detailed Description

Database based session handler.

Copyright

2013 Petr Skoda http://skodak.org

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

handler_close()

core\session\database::handler_close

(

)

Close session handler.

{

See also

http://php.net/manual/en/function.session-set-save-handler.php}

Return values

bool

success

handler_destroy()

core\session\database::handler_destroy

(

$sid

)

Destroy session handler.

{

See also

http://php.net/manual/en/function.session-set-save-handler.php}

Parameters

string

$sid

Return values

bool

success

handler_gc()

core\session\database::handler_gc

(

$ignored_maxlifetime

)

GC session handler.

{

See also

http://php.net/manual/en/function.session-set-save-handler.php}

Parameters

int

$ignored_maxlifetime

moodle uses special timeout rules

Return values

bool

success

handler_open()

core\session\database::handler_open	(		$save_path,
			$session_name
	)

Open session handler.

{

See also

http://php.net/manual/en/function.session-set-save-handler.php}

Parameters

string	$save_path
string	$session_name

Return values

bool

success

handler_read()

core\session\database::handler_read

(

$sid

)

Read session handler.

{

See also

http://php.net/manual/en/function.session-set-save-handler.php}

Parameters

string

$sid

Return values

string

handler_write()

core\session\database::handler_write	(		$sid,
			$session_data
	)

Write session handler.

{

See also

http://php.net/manual/en/function.session-set-save-handler.php}

NOTE: Do not write to output or throw any exceptions! Hopefully the next page is going to display nice error or it recovers...

Parameters

string	$sid
string	$session_data

Return values

bool

success

kill_session()

core\session\database::kill_session

(

$sid

)

Kill one session, the session record is removed afterwards.

Parameters

string

$sid

Reimplemented from core\session\handler.

session_exists()

core\session\database::session_exists

(

$sid

)

Check the backend contains data for this session id.

Note: this is intended to be called from manager::session_exists() only.

Parameters

string

$sid

Return values

bool	true if session found.

Reimplemented from core\session\handler.

start()

core\session\handler::start ( )

inherited

Start the session.

Return values

bool

success

Reimplemented in core\session\redis, and core\session\memcached.

---

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

• lib/classes/session/database.php