Collaboration diagram for ilSession:

Static Public Member Functions
static	_getData (string $a_session_id)
	Get session data from table. More...

static	lookupExpireTime (string $a_session_id)
	Lookup expire time for a specific session. More...

static	_exists (string $a_session_id)
	Check whether session exists. More...

static	_destroy ($a_session_id, ?int $a_closing_context=null, $a_expired_at=null)
	Destroy session. More...

static	_destroyByUserId (int $a_user_id)
	Destroy session. More...

static	_destroyExpiredSessions ()
	Destroy expired sessions. More...

static	_duplicate (string $a_session_id)
	Duplicate session. More...

static	getIdleValue (bool $fixedMode=false)
	Returns the idle time in seconds. More...

static	getSessionExpireValue ()
	Returns the session expiration value. More...

static	set (string $a_var, $a_val)
	Set a value. More...

static	get (string $a_var)

static	has ($a_var)

static	clear (string $a_var)

static	dumpToString ()

static	setClosingContext (int $a_context)
	set closing context (for statistics) More...

static	getClosingContext ()
	get closing context (for statistics) More...

static	isWebAccessWithoutSessionEnabled ()

static	enableWebAccessWithoutSession (bool $enable_web_access_without_session)

Data Fields
const	SESSION_HANDLING_FIXED = 0

const	SESSION_HANDLING_LOAD_DEPENDENT = 1

const	SESSION_CLOSE_USER = 1

const	SESSION_CLOSE_EXPIRE = 2

const	SESSION_CLOSE_FIRST = 3

const	SESSION_CLOSE_IDLE = 4

const	SESSION_CLOSE_LIMIT = 5

const	SESSION_CLOSE_LOGIN = 6

const	SESSION_CLOSE_PUBLIC = 7

const	SESSION_CLOSE_TIME = 8

const	SESSION_CLOSE_IP = 9

const	SESSION_CLOSE_SIMUL = 10

const	SESSION_CLOSE_INACTIVE = 11

Static Protected Attributes
static bool	$enable_web_access_without_session = false

Static Private Attributes
static int	$closing_context = null

Detailed Description

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

ilObjUser on usr_session

Definition at line 26 of file class.ilSession.php.

Member Function Documentation

◆ _destroy()

static ilSession::_destroy	(		$a_session_id,
		?int	$a_closing_context = `null`,
			$a_expired_at = `null`
	)

static

Destroy session.

Parameters

string \| array	$a_session_id	session id\|s
int \| null	$a_closing_context	closing context
int \| bool	$a_expired_at	expired at timestamp

Definition at line 262 of file class.ilSession.php.

References $DIC, Vendor\Package\$e, $ilDB, $q, ilSessionStatistics\closeRawEntry(), ilSessionIStorage\destroySession(), and ilContext\usesHTTP().

Referenced by ilSessionDBHandler\destroy(), ilSessionControl\kickFirstRequestAbidencer(), ilSessionControl\kickOneMinIdleSession(), ilInitialisation\resumeUserSession(), and ilSessionTest\setGlobalVariable().

                                                                                                         : bool
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         if (!$a_closing_context) {
             $a_closing_context = self::$closing_context;
         }
 
         ilSessionStatistics::closeRawEntry($a_session_id, $a_closing_context, $a_expired_at);
 
         if (!is_array($a_session_id)) {
             $q = "DELETE FROM usr_session WHERE session_id = " .
                 $ilDB->quote($a_session_id, "text");
         } else {
             // array: id => timestamp - so we get rid of timestamps
             if ($a_expired_at) {
                 $a_session_id = array_keys($a_session_id);
             }
             $q = "DELETE FROM usr_session WHERE " .
                 $ilDB->in("session_id", $a_session_id, false, "text");
         }
 
         ilSessionIStorage::destroySession($a_session_id);
 
         $ilDB->manipulate($q);
 
         if (ilContext::usesHTTP()) {
             try {
                 // only delete session cookie if it is set in the current request
                 if ($DIC->http()->wrapper()->cookie()->has(session_name()) &&
                     $DIC->http()->wrapper()->cookie()->retrieve(
                         session_name(),
                         $DIC->refinery()->kindlyTo()->string()
                     ) === $a_session_id) {
                     $cookieJar = $DIC->http()->cookieJar()->without(session_name());
                     $cookieJar->renderIntoResponseHeader($DIC->http()->response());
                 }
             } catch (\Throwable $e) {
                 // ignore
                 // this is needed for "header already"  sent errors when the random cleanup of expired sessions is triggered
             }
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _destroyByUserId()

static ilSession::_destroyByUserId ( int $a_user_id )

static

Destroy session.

Parameters

int user id

Definition at line 315 of file class.ilSession.php.

References $DIC, $ilDB, and $q.

Referenced by ilObjUser\delete(), and ilSessionTest\setGlobalVariable().

                                                            : bool
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $q = "DELETE FROM usr_session WHERE user_id = " .
             $ilDB->quote($a_user_id, "integer");
         $ilDB->manipulate($q);
 
         return true;
     }

Here is the caller graph for this function:

◆ _destroyExpiredSessions()

static ilSession::_destroyExpiredSessions ( )

static

Destroy expired sessions.

Returns: int The number of deleted sessions on success

Definition at line 332 of file class.ilSession.php.

References $DIC, $ilDB, $q, $res, ILIAS\Repository\int(), and ilDBConstants\T_INTEGER.

Referenced by ilSessionStatisticsGUI\adminSync(), ilSessionDBHandler\gc(), ilAuthDestroyExpiredSessionsCron\run(), and ilSessionTest\setGlobalVariable().

                                                     : int
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $q = 'SELECT session_id, expires FROM usr_session WHERE expires < ' . $ilDB->quote(time(), ilDBConstants::T_INTEGER);
         $res = $ilDB->query($q);
         $ids = [];
         while ($row = $ilDB->fetchAssoc($res)) {
             $ids[$row['session_id']] = (int) $row['expires'];
         }
         if ($ids !== []) {
             self::_destroy($ids, self::SESSION_CLOSE_EXPIRE, true);
         }
 
         return count($ids);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _duplicate()

static ilSession::_duplicate ( string $a_session_id )

static

Duplicate session.

Parameters

string session id

Returns: string new session id

Definition at line 357 of file class.ilSession.php.

References $DIC, $ilDB, $ilSetting, $q, $res, ilSessionControl\DEFAULT_MAX_IDLE, and ILIAS\Repository\int().

Referenced by ilContainer\cloneAllObject(), ilDclContentExporter\exportAsync(), and ilSessionTest\setGlobalVariable().

                                                            : string
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         // Create new session id
         $new_session = $a_session_id;
         do {
             $new_session = md5($new_session);
             $q = "SELECT * FROM usr_session WHERE " .
                 "session_id = " . $ilDB->quote($new_session, "text");
             $res = $ilDB->query($q);
         } while ($ilDB->fetchAssoc($res));
 
         $query = "SELECT * FROM usr_session " .
             "WHERE session_id = " . $ilDB->quote($a_session_id, "text");
         $res = $ilDB->query($query);
 
         if ($row = $ilDB->fetchObject($res)) {
             self::_writeData($new_session, $row->data);
             return $new_session;
         }
         //TODO check if throwing an excpetion might be a better choice
         return "";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _exists()

static ilSession::_exists ( string $a_session_id )

static

Check whether session exists.

Parameters

string session id

Returns: boolean true, if session id exists

Definition at line 240 of file class.ilSession.php.

References $DIC, $ilDB, and $q.

Referenced by ilSessionTest\setGlobalVariable(), and ilInitialisation\setSessionHandler().

                                                         : bool
     {
         if (!$a_session_id) {
             return false;
         }
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $q = "SELECT 1 FROM usr_session WHERE session_id = " . $ilDB->quote($a_session_id, "text");
         $set = $ilDB->query($q);
 
         return $ilDB->numRows($set) > 0;
     }

Here is the caller graph for this function:

◆ _getData()

static ilSession::_getData ( string $a_session_id )

static

Get session data from table.

According to https://bugs.php.net/bug.php?id=70520 read data must return a string. Otherwise session_regenerate_id might fail with php 7.

Parameters

string session id

Returns: string session data

Definition at line 76 of file class.ilSession.php.

References $DIC, $ilDB, and $q.

Referenced by ilSessionDBHandler\read(), and ilSessionTest\setGlobalVariable().

                                                          : string
     {
         if (!$a_session_id) {
             // fix for php #70520
             return '';
         }
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $q = "SELECT data FROM usr_session WHERE session_id = " .
             $ilDB->quote($a_session_id, "text");
         $set = $ilDB->query($q);
         $rec = $ilDB->fetchAssoc($set);
         if (!is_array($rec)) {
             return '';
         }
 
         // fix for php #70520
         return (string) $rec["data"];
     }

Here is the caller graph for this function:

◆ clear()

static ilSession::clear ( string $a_var )

static

Parameters

string $a_var

Definition at line 478 of file class.ilSession.php.

                                                : void
     {
         if (isset($_SESSION[$a_var])) {
             unset($_SESSION[$a_var]);
         }
     }

Here is the caller graph for this function:

◆ dumpToString()

static ilSession::dumpToString ( )

static

Definition at line 485 of file class.ilSession.php.

Referenced by ilAuthFrontend\handleAccountMigration().

                                          : string
     {
         return print_r($_SESSION, true);
     }

Here is the caller graph for this function:

◆ enableWebAccessWithoutSession()

static ilSession::enableWebAccessWithoutSession ( bool $enable_web_access_without_session )

static

Parameters

boolean $enable_web_access_without_session

Definition at line 519 of file class.ilSession.php.

References $enable_web_access_without_session.

Referenced by ilSessionReminderCheck\__construct(), ilWebDAVAuthentication\authenticate(), ilNotificationGUI\getOSDNotificationsObject(), ilOnScreenChatGUI\getUserProfileData(), and ilOnScreenChatGUI\verifyLogin().

                                                                                                  : void
     {
         self::$enable_web_access_without_session = $enable_web_access_without_session;
     }

Here is the caller graph for this function:

◆ get()

static ilSession::get ( string $a_var )

static

Returns: mixed|null

Definition at line 465 of file class.ilSession.php.

     {
         return $_SESSION[$a_var] ?? null;
     }

Here is the caller graph for this function:

◆ getClosingContext()

static ilSession::getClosingContext ( )

static

get closing context (for statistics)

Definition at line 501 of file class.ilSession.php.

                                               : int
     {
         return self::$closing_context;
     }

◆ getIdleValue()

static ilSession::getIdleValue ( bool $fixedMode = false )

static

Returns the idle time in seconds.

Parameters

boolean If passed, the value for fixed session is returned

Returns: integer The idle time in seconds

Definition at line 423 of file class.ilSession.php.

References $DIC, $ilSetting, and ilSessionControl\DEFAULT_MAX_IDLE.

Referenced by ilObjSCORMInitData\getIliasScormVars(), ilSCORM13PlayerGUI\getPlayer(), and ilSessionReminder\init().

                                                                 : int
     {
         global $DIC;
 
         $ilSetting = $DIC['ilSetting'];
         $ilClientIniFile = $DIC['ilClientIniFile'];
 
         if ($fixedMode || $ilSetting->get('session_handling_type', (string) self::SESSION_HANDLING_FIXED) === (string) self::SESSION_HANDLING_FIXED) {
             // fixed session
             return (int) $ilClientIniFile->readVariable('session', 'expire');
         }
 
         if ($ilSetting->get('session_handling_type', (string) self::SESSION_HANDLING_FIXED) === (string) self::SESSION_HANDLING_LOAD_DEPENDENT) {
             // load dependent session settings
             return ((int) $ilSetting->get('session_max_idle', (string) (ilSessionControl::DEFAULT_MAX_IDLE))) * 60;
         }
         return ilSessionControl::DEFAULT_MAX_IDLE * 60;
     }

Here is the caller graph for this function:

◆ getSessionExpireValue()

static ilSession::getSessionExpireValue ( )

static

Returns the session expiration value.

Returns: integer The expiration value in seconds

Definition at line 449 of file class.ilSession.php.

Referenced by ilObjUserFolderGUI\initFormGeneralSettings(), and ilPersonalSettingsGUI\initGeneralSettingsForm().

                                                   : int
     {
         return self::getIdleValue(true);
     }

Here is the caller graph for this function:

◆ has()

static ilSession::has ( $a_var )

static

Definition at line 470 of file class.ilSession.php.

                                       : bool
     {
         return isset($_SESSION[$a_var]);
     }

Here is the caller graph for this function:

◆ isWebAccessWithoutSessionEnabled()

static ilSession::isWebAccessWithoutSessionEnabled ( )

static

Returns: boolean

Definition at line 511 of file class.ilSession.php.

                                                              : bool
     {
         return self::$enable_web_access_without_session;
     }

◆ lookupExpireTime()

static ilSession::lookupExpireTime ( string $a_session_id )

static

Lookup expire time for a specific session.

Parameters

string $a_session_id

Returns: int expired unix timestamp

Definition at line 103 of file class.ilSession.php.

References $_SERVER, $DIC, $ilDB, $res, ilSessionControl\$session_types_controlled, ilSessionStatistics\aggretateRaw(), ilSessionStatistics\createRawEntry(), ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\get(), ilContext\getType(), ILIAS\Repository\int(), ilContext\isSessionMainContext(), ilDBConstants\T_CLOB, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by ilAuthSession\validateExpiration().

                                                                  : int
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = 'SELECT expires FROM usr_session WHERE session_id = ' .
             $ilDB->quote($a_session_id, 'text');
         $res = $ilDB->query($query);
         if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return (int) $row->expires;
         }
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set()

static ilSession::set	(	string	$a_var,
			$a_val
	)

static

Set a value.

Definition at line 457 of file class.ilSession.php.

                                                      : void
     {
         $_SESSION[$a_var] = $a_val;
     }

Here is the caller graph for this function:

◆ setClosingContext()

static ilSession::setClosingContext ( int $a_context )

static

set closing context (for statistics)

Definition at line 493 of file class.ilSession.php.

Referenced by ILIAS\LegalDocuments\Provide\ProvideWithdrawal\__construct(), ilSessionControl\checkCurrentSessionIsAllowed(), ilPersonalSettingsGUI\deleteOwnAccountLogout(), ilStartUpGUI\doLogout(), ilPersonalProfileGUI\goToEmailConfirmation(), ilInitialisation\goToLogin(), ilInitialisation\goToPublicSection(), ilCronStartUp\logout(), ilSoapUserAdministration\logout(), ILIAS\Saml\Module\run(), and ilStartUpGUI\showLoginPageOrStartupPage().

                                                             : void
     {
         self::$closing_context = $a_context;
     }

Here is the caller graph for this function:

Field Documentation

◆ $closing_context

int ilSession::$closing_context = null

staticprivate

Definition at line 63 of file class.ilSession.php.

◆ $enable_web_access_without_session

bool ilSession::$enable_web_access_without_session = false

staticprotected

Definition at line 65 of file class.ilSession.php.

Referenced by enableWebAccessWithoutSession().

◆ SESSION_CLOSE_EXPIRE

const ilSession::SESSION_CLOSE_EXPIRE = 2

Definition at line 52 of file class.ilSession.php.

Referenced by ilSessionStatistics\aggregateRawHelper(), ilInitialisation\goToLogin(), ilInitialisation\goToPublicSection(), and ilInitialisation\resumeUserSession().

◆ SESSION_CLOSE_FIRST

const ilSession::SESSION_CLOSE_FIRST = 3

Definition at line 53 of file class.ilSession.php.

Referenced by ilSessionStatistics\aggregateRawHelper(), and ilSessionControl\kickFirstRequestAbidencer().

◆ SESSION_CLOSE_IDLE

const ilSession::SESSION_CLOSE_IDLE = 4

Definition at line 54 of file class.ilSession.php.

Referenced by ilSessionStatistics\aggregateRawHelper(), and ilSessionControl\kickOneMinIdleSession().

◆ SESSION_CLOSE_INACTIVE

const ilSession::SESSION_CLOSE_INACTIVE = 11

Definition at line 61 of file class.ilSession.php.

◆ SESSION_CLOSE_IP

const ilSession::SESSION_CLOSE_IP = 9

Definition at line 59 of file class.ilSession.php.

◆ SESSION_CLOSE_LIMIT

const ilSession::SESSION_CLOSE_LIMIT = 5

Definition at line 55 of file class.ilSession.php.

Referenced by ilSessionStatistics\aggregateRawHelper(), and ilSessionControl\checkCurrentSessionIsAllowed().

◆ SESSION_CLOSE_LOGIN

const ilSession::SESSION_CLOSE_LOGIN = 6

Definition at line 56 of file class.ilSession.php.

Referenced by ilSessionStatistics\aggregateRawHelper(), and ilInitialisation\goToLogin().

◆ SESSION_CLOSE_PUBLIC

const ilSession::SESSION_CLOSE_PUBLIC = 7

Definition at line 57 of file class.ilSession.php.

Referenced by ilInitialisation\goToPublicSection().

◆ SESSION_CLOSE_SIMUL

const ilSession::SESSION_CLOSE_SIMUL = 10

Definition at line 60 of file class.ilSession.php.

◆ SESSION_CLOSE_TIME

const ilSession::SESSION_CLOSE_TIME = 8

Definition at line 58 of file class.ilSession.php.

◆ SESSION_CLOSE_USER

const ilSession::SESSION_CLOSE_USER = 1

Definition at line 51 of file class.ilSession.php.

Referenced by ilSessionStatistics\aggregateRawHelper(), ilPersonalSettingsGUI\deleteOwnAccountLogout(), ilStartUpGUI\doLogout(), ILIAS\LegalDocuments\Provide\ProvideWithdrawal\finishAndLogout(), ilPersonalProfileGUI\goToEmailConfirmation(), ilCronStartUp\logout(), ilSoapUserAdministration\logout(), ILIAS\Saml\Module\run(), ilStartUpGUI\showLoginPageOrStartupPage(), and ILIAS\LegalDocuments\test\Provide\ProvideWithdrawalTest\testFinishAndLogout().

◆ SESSION_HANDLING_FIXED

const ilSession::SESSION_HANDLING_FIXED = 0

Definition at line 35 of file class.ilSession.php.

Referenced by ilSessionReminder\byLoggedInUser(), ilObjUserFolderGUI\generalSettingsObject(), ilLDAPServerTest\getLanguageMock(), ilSessionControl\handleLoginEvent(), ilObjUserFolderGUI\initFormGeneralSettings(), ilObjUserFolderGUI\saveGeneralSettingsObject(), and ilSessionTest\setGlobalVariable().

◆ SESSION_HANDLING_LOAD_DEPENDENT

const ilSession::SESSION_HANDLING_LOAD_DEPENDENT = 1

Definition at line 44 of file class.ilSession.php.

Referenced by ilSessionControl\handleLoginEvent(), ilObjUserFolderGUI\initFormGeneralSettings(), and ilObjUserFolderGUI\saveGeneralSettingsObject().

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

Services/Authentication/classes/class.ilSession.php

Static Public Member Functions

Data Fields

Static Protected Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ _destroy()

◆ _destroyByUserId()

◆ _destroyExpiredSessions()

◆ _duplicate()

◆ _exists()

◆ _getData()

◆ clear()

◆ dumpToString()

◆ enableWebAccessWithoutSession()

◆ get()

◆ getClosingContext()

◆ getIdleValue()

◆ getSessionExpireValue()

◆ has()

◆ isWebAccessWithoutSessionEnabled()

◆ lookupExpireTime()

◆ set()

◆ setClosingContext()

Field Documentation

◆ $closing_context

◆ $enable_web_access_without_session

◆ SESSION_CLOSE_EXPIRE

◆ SESSION_CLOSE_FIRST

◆ SESSION_CLOSE_IDLE

◆ SESSION_CLOSE_INACTIVE

◆ SESSION_CLOSE_IP

◆ SESSION_CLOSE_LIMIT

◆ SESSION_CLOSE_LOGIN

◆ SESSION_CLOSE_PUBLIC

◆ SESSION_CLOSE_SIMUL

◆ SESSION_CLOSE_TIME

◆ SESSION_CLOSE_USER

◆ SESSION_HANDLING_FIXED

◆ SESSION_HANDLING_LOAD_DEPENDENT