Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | List of all members
core\session\handler Class Reference

Session handler base. More...

Inheritance diagram for core\session\handler:
core\session\database core\session\file core\session\memcached core\session\redis

Public Member Functions

 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...
 

Detailed Description

Session handler base.

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

Member Function Documentation

◆ kill_session()

core\session\handler::kill_session (   $sid)
abstract

Kill one session, the session record is removed afterwards.

Parameters
string$sid

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

◆ session_exists()

core\session\handler::session_exists (   $sid)
abstract

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
booltrue if session found.

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

◆ start()

core\session\handler::start ( )

Start the session.

Return values
boolsuccess

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


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