ilSessionIStorage Class Reference

Session based immediate storage. More...

Collaboration diagram for ilSessionIStorage:

Public Member Functions
	__construct (string $a_component_id, string $a_sess_id='')
	set (string $a_key, string $a_val)
	get (string $a_key)

Static Public Member Functions
static	destroySession ($a_session_id)
	Destroy session(s). More...

Private Member Functions
	initComponentCacheIfNotExists ()

Private Attributes
string	$session_id
string	$component_id

Static Private Attributes
static array	$values = []

Detailed Description

Session based immediate storage.

This class stores session based user data in the database. The difference to ilSession is that data is written immediately when the set() function is called and that this data is written "per key".

Please note that the values are limited to TEXT(1000)!

This class is needed for cases, where ajax calls should write session based data.

Since more concurrent ajax calls can be initiated by a page request, these calls may run into race conditions, if ilSession is used, since it always reads all key/value pairs at the beginning of a request and writes all of them at the end. Similar issues can appear if a page initiates additional requests by (i)frames.

Definition at line 39 of file class.ilSessionIStorage.php.

Constructor & Destructor Documentation

__construct()

ilSessionIStorage::__construct	(	string	$a_component_id,
		string	$a_sess_id = ''
	)

Definition at line 45 of file class.ilSessionIStorage.php.

    {
        $this->component_id = $a_component_id;
        if ($a_sess_id !== '') {
            $this->session_id = $a_sess_id;
        } else {
            $this->session_id = session_id();
        }
    }

Member Function Documentation

destroySession()

static ilSessionIStorage::destroySession (   $a_session_id )

static

Destroy session(s).

This is called by ilSession->destroy

Parameters

string|list<string>

$a_session_id Ids of sessions to be deleted

Definition at line 112 of file class.ilSessionIStorage.php.

References $DIC, and $q.

Referenced by ilSession\_destroy().

                                                        : void
    {
        global $DIC;

        if (is_array($a_session_id)) {
            $q = 'DELETE FROM usr_sess_istorage WHERE ' .
                $DIC->database()->in('session_id', $a_session_id, false, 'text');
        } else {
            $q = 'DELETE FROM usr_sess_istorage WHERE session_id = ' .
                $DIC->database()->quote($a_session_id, 'text');
        }

        $DIC->database()->manipulate($q);
    }

Here is the caller graph for this function:

get()

ilSessionIStorage::get

(

string

$a_key

)

Definition at line 82 of file class.ilSessionIStorage.php.

References $component_id, $DIC, $ilDB, and initComponentCacheIfNotExists().

                                      : string
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        if (isset(self::$values[$this->component_id][$a_key]) && is_array(self::$values[$this->component_id])) {
            return self::$values[$this->component_id][$a_key];
        }

        $set = $ilDB->query(
            'SELECT value FROM usr_sess_istorage ' .
            ' WHERE session_id = ' . $ilDB->quote($this->session_id, 'text') .
            ' AND component_id = ' . $ilDB->quote($this->component_id, 'text') .
            ' AND vkey = ' . $ilDB->quote($a_key, 'text')
        );
        $rec = $ilDB->fetchAssoc($set);
        $value = (string) ($rec['value'] ?? '');

        $this->initComponentCacheIfNotExists();

        self::$values[$this->component_id][$a_key] = $value;

        return $value;
    }

Here is the call graph for this function:

initComponentCacheIfNotExists()

ilSessionIStorage::initComponentCacheIfNotExists ( )

private

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

References $component_id.

Referenced by get(), and set().

                                                    : void
    {
        if (!isset(self::$values[$this->component_id]) || !is_array(self::$values[$this->component_id])) {
            self::$values[$this->component_id] = [];
        }
    }

Here is the caller graph for this function:

set()

ilSessionIStorage::set	(	string	$a_key,
		string	$a_val
	)

Definition at line 62 of file class.ilSessionIStorage.php.

References $component_id, $DIC, $ilDB, and initComponentCacheIfNotExists().

                                                     : void
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $this->initComponentCacheIfNotExists();

        self::$values[$this->component_id][$a_key] = $a_val;
        $ilDB->replace(
            'usr_sess_istorage',
            [
                'session_id' => ['text', $this->session_id],
                'component_id' => ['text', $this->component_id],
                'vkey' => ['text', $a_key]
            ],
            ['value' => ['text', $a_val]]
        );
    }

Here is the call graph for this function:

Field Documentation

$component_id

string ilSessionIStorage::$component_id

private

Definition at line 42 of file class.ilSessionIStorage.php.

Referenced by get(), initComponentCacheIfNotExists(), and set().

$session_id

string ilSessionIStorage::$session_id

private

Definition at line 41 of file class.ilSessionIStorage.php.

$values

array ilSessionIStorage::$values = []

staticprivate

Definition at line 43 of file class.ilSessionIStorage.php.

---

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

• components/ILIAS/Authentication/classes/class.ilSessionIStorage.php