ilLSStateDB Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilLSStateDB:

Public Member Functions
	__construct (ilDBInterface $db)
	getStatesFor (int $lso_ref_id, array $usr_ids=[])
	getCurrentItemsFor (int $lso_ref_id, array $usr_ids=[])
	getFirstAccessFor (int $lso_ref_id, array $usr_ids=[])
	getLastAccessFor (int $lso_ref_id, array $usr_ids=[])
	updateState (int $lso_ref_id, int $usr_id, int $ref_id, ILIAS\KioskMode\State $state, int $current_item=null)
	update a single State (for the item with ref_id); if $current_item is not set, assume that $ref_id is the current one. More...
	deleteFor (int $lso_ref_id, array $usr_ids=[])
	deleteForItem (int $lso_ref_id, int $item_ref_id)

Data Fields
const	TABLE_NAME = 'lso_states'
const	CURRENT_ITEM_ID = "current_item"
const	STATES = "states"
const	FIRST_ACCESS = "first_access"
const	LAST_ACCESS = "last_access"

Protected Member Functions
	entryExistsFor (int $lso_ref_id, int $usr_id)
	insert (int $lso_ref_id, int $usr_id)
	update (ilDBInterface $db, int $lso_ref_id, int $usr_id, int $current_item, string $serialized)
	buildStates (string $serialized)
	serializeStates (array $states)
	select (int $lso_ref_id, array $usr_ids=[])

Protected Attributes
ilDBInterface	$db

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Persistence for View-States

Definition at line 24 of file class.ilLSStateDB.php.

Constructor & Destructor Documentation

__construct()

ilLSStateDB::__construct

(

ilDBInterface

$db

)

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

References $db.

    {
        $this->db = $db;
    }

Member Function Documentation

buildStates()

ilLSStateDB::buildStates ( string  $serialized )

protected

Returns

array <int,ILIAS> ref_id=>State

Definition at line 234 of file class.ilLSStateDB.php.

References $data, ILIAS\LTI\ToolProvider\$key, and $ref_id.

Referenced by select().

                                                      : array
    {
        $states = [];
        $data = json_decode($serialized, true);
        foreach ($data as $ref_id => $kvpair) {
            $states[$ref_id] = new ILIAS\KioskMode\State();
            if (is_array($kvpair)) {
                foreach ($kvpair as $key => $value) {
                    $states[$ref_id] = $states[$ref_id]->withValueFor($key, $value);
                }
            }
        }

        return $states;
    }

Here is the caller graph for this function:

deleteFor()

ilLSStateDB::deleteFor	(	int	$lso_ref_id,
		array	$usr_ids = []
	)

Parameters

int[]

$usr_ids

Definition at line 185 of file class.ilLSStateDB.php.

                                                                   : void
    {
        $query =
             "DELETE FROM " . static::TABLE_NAME . PHP_EOL
            . "WHERE lso_ref_id = " . $this->db->quote($lso_ref_id, "integer") . PHP_EOL
        ;

        if ($usr_ids !== []) {
            $query .= "AND usr_id IN (" . implode(',', $usr_ids) . ")";
        }

        $this->db->manipulate($query);
    }

deleteForItem()

ilLSStateDB::deleteForItem	(	int	$lso_ref_id,
		int	$item_ref_id
	)

Definition at line 199 of file class.ilLSStateDB.php.

References select(), serializeStates(), and update().

                                                                    : void
    {
        $all_states = $this->select($lso_ref_id);
        if ($all_states === []) {
            return;
        }

        $ilAtomQuery = $this->db->buildAtomQuery();
        $ilAtomQuery->addTableLock(static::TABLE_NAME);
        $ilAtomQuery->addQueryCallable(
            function (ilDBInterface $db) use ($lso_ref_id, $all_states, $item_ref_id): void {
                foreach ($all_states as $usr_id => $state_entry) {
                    $current_item = $state_entry['current_item'];
                    $states = $state_entry['states'];

                    if ($current_item === $item_ref_id) {
                        $current_item = -1;
                    }

                    if (array_key_exists($item_ref_id, $states)) {
                        unset($states[$item_ref_id]);
                    }
                    $serialized = $this->serializeStates($states);
                    $this->update($db, $lso_ref_id, (int) $usr_id, $current_item, $serialized);
                }
            }
        );

        $ilAtomQuery->run();
    }

Here is the call graph for this function:

entryExistsFor()

ilLSStateDB::entryExistsFor ( int  $lso_ref_id, int  $usr_id  )

protected

Definition at line 144 of file class.ilLSStateDB.php.

References select().

Referenced by updateState().

                                                                   : bool
    {
        return $this->select($lso_ref_id, [$usr_id]) !== [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentItemsFor()

ilLSStateDB::getCurrentItemsFor	(	int	$lso_ref_id,
		array	$usr_ids = []
	)

Returns

array <int, int> usr_id => item_ref_id

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

References $data, and select().

                                                                            : array
    {
        $data = $this->select($lso_ref_id, $usr_ids);
        $ret = [];
        foreach ($usr_ids as $usr_id) {
            $ret[$usr_id] = -1;
            if (array_key_exists($usr_id, $data)) {
                $ret[$usr_id] = $data[$usr_id][self::CURRENT_ITEM_ID];
            }
        }

        return $ret;
    }

Here is the call graph for this function:

getFirstAccessFor()

ilLSStateDB::getFirstAccessFor	(	int	$lso_ref_id,
		array	$usr_ids = []
	)

Parameters

array<int>

$usr_ids

Returns

array<int, string>

Definition at line 78 of file class.ilLSStateDB.php.

References $data, and select().

                                                                           : array
    {
        $data = $this->select($lso_ref_id, $usr_ids);
        $ret = [];
        foreach ($usr_ids as $usr_id) {
            $ret[$usr_id] = '-1';
            if (array_key_exists($usr_id, $data)) {
                $ret[$usr_id] = $data[$usr_id][self::FIRST_ACCESS];
            }
        }

        return $ret;
    }

Here is the call graph for this function:

getLastAccessFor()

ilLSStateDB::getLastAccessFor	(	int	$lso_ref_id,
		array	$usr_ids = []
	)

Parameters

int[]

$usr_ids

Returns

array<int, string>

Definition at line 96 of file class.ilLSStateDB.php.

References $data, and select().

                                                                          : array
    {
        $data = $this->select($lso_ref_id, $usr_ids);
        $ret = [];
        foreach ($usr_ids as $usr_id) {
            $ret[$usr_id] = '-1';
            if (array_key_exists($usr_id, $data)) {
                $ret[$usr_id] = $data[$usr_id][self::LAST_ACCESS];
            }
        }

        return $ret;
    }

Here is the call graph for this function:

getStatesFor()

ilLSStateDB::getStatesFor	(	int	$lso_ref_id,
		array	$usr_ids = []
	)

Returns

array <int,ILIAS> usr_id => [item_ref_id=>State]

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

References $data, and select().

Referenced by updateState().

                                                                      : array
    {
        $data = $this->select($lso_ref_id, $usr_ids);
        $ret = [];
        foreach ($usr_ids as $usr_id) {
            $ret[$usr_id] = [];
            if (array_key_exists($usr_id, $data)) {
                $ret[$usr_id] = $data[$usr_id][self::STATES];
            }
        }

        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilLSStateDB::insert ( int  $lso_ref_id, int  $usr_id  )

protected

Definition at line 149 of file class.ilLSStateDB.php.

Referenced by updateState().

                                                           : void
    {
        $first_access = date("d.m.Y H:i:s");
        $values = array(
            "lso_ref_id" => array("integer", $lso_ref_id),
            "usr_id" => array("integer", $usr_id),
            "first_access" => array("text", $first_access)
        );

        $this->db->insert(static::TABLE_NAME, $values);
    }

Here is the caller graph for this function:

select()

ilLSStateDB::select ( int  $lso_ref_id, array  $usr_ids = []  )

protected

Parameters

int[]

$usr_ids

Returns

array<string, array>

Definition at line 273 of file class.ilLSStateDB.php.

References buildStates(), and ILIAS\Repository\int().

Referenced by deleteForItem(), entryExistsFor(), getCurrentItemsFor(), getFirstAccessFor(), getLastAccessFor(), and getStatesFor().

                                                                   : array
    {
        $query =
             "SELECT usr_id, current_item, states, first_access, last_access" . PHP_EOL
            . "FROM " . static::TABLE_NAME . PHP_EOL
            . "WHERE lso_ref_id = " . $this->db->quote($lso_ref_id, "integer") . PHP_EOL
        ;

        if ($usr_ids !== []) {
            $query .= "AND usr_id IN (" . implode(',', $usr_ids) . ")";
        }

        $result = $this->db->query($query);

        $ret = [];
        while ($row = $this->db->fetchAssoc($result)) {
            $ret[$row['usr_id']] = [
                self::CURRENT_ITEM_ID => (int) $row[self::CURRENT_ITEM_ID],
                self::STATES => $this->buildStates($row[self::STATES]),
                self::FIRST_ACCESS => $row[self::FIRST_ACCESS],
                self::LAST_ACCESS => $row[self::LAST_ACCESS]
            ];
        }

        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

serializeStates()

ilLSStateDB::serializeStates ( array  $states )

protected

Parameters

array

<int,ILIAS> ref_id=>State

Definition at line 253 of file class.ilLSStateDB.php.

References $data, and $ref_id.

Referenced by deleteForItem(), and updateState().

                                                     : string
    {
        $data = [];
        foreach ($states as $ref_id => $state) {
            $data[$ref_id] = json_decode($state->serialize());
        }

        $result = json_encode($data);

        if ($result === false) {
            throw new LogicException("Could not serialize state.");
        }

        return $result;
    }

Here is the caller graph for this function:

update()

ilLSStateDB::update ( ilDBInterface  $db, int  $lso_ref_id, int  $usr_id, int  $current_item, string  $serialized  )

protected

Definition at line 161 of file class.ilLSStateDB.php.

References ilDBInterface\update().

Referenced by deleteForItem(), and updateState().

     : void {
        $last_access = date("d.m.Y H:i:s");
        $where = array(
            "lso_ref_id" => array("integer", $lso_ref_id),
            "usr_id" => array("integer", $usr_id)
        );
        $values = array(
            "current_item" => array("integer", $current_item),
            "states" => array("text", $serialized),
            "last_access" => array("text", $last_access)
        );

        $db->update(static::TABLE_NAME, $values, $where);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateState()

ilLSStateDB::updateState	(	int	$lso_ref_id,
		int	$usr_id,
		int	$ref_id,
		ILIAS\KioskMode\State	$state,
		int	$current_item = null
	)

update a single State (for the item with ref_id); if $current_item is not set, assume that $ref_id is the current one.

Definition at line 114 of file class.ilLSStateDB.php.

References $ref_id, entryExistsFor(), getStatesFor(), insert(), serializeStates(), and update().

     : void {
        $insert_first = $this->entryExistsFor($lso_ref_id, $usr_id) === false;
        $states = $this->getStatesFor($lso_ref_id, [$usr_id]);
        $states = $states[$usr_id];
        $states[$ref_id] = $state;
        $serialized = $this->serializeStates($states);
        if (is_null($current_item)) {
            $current_item = $ref_id;
        }

        $ilAtomQuery = $this->db->buildAtomQuery();
        $ilAtomQuery->addTableLock(static::TABLE_NAME);
        $ilAtomQuery->addQueryCallable(
            function (ilDBInterface $db) use ($insert_first, $lso_ref_id, $usr_id, $current_item, $serialized): void {
                if ($insert_first) {
                    $this->insert($lso_ref_id, $usr_id);
                }
                $this->update($db, $lso_ref_id, $usr_id, $current_item, $serialized);
            }
        );

        $ilAtomQuery->run();
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilLSStateDB::$db

protected

Definition at line 33 of file class.ilLSStateDB.php.

Referenced by __construct().

CURRENT_ITEM_ID

const ilLSStateDB::CURRENT_ITEM_ID = "current_item"

Definition at line 28 of file class.ilLSStateDB.php.

FIRST_ACCESS

const ilLSStateDB::FIRST_ACCESS = "first_access"

Definition at line 30 of file class.ilLSStateDB.php.

LAST_ACCESS

const ilLSStateDB::LAST_ACCESS = "last_access"

Definition at line 31 of file class.ilLSStateDB.php.

STATES

const ilLSStateDB::STATES = "states"

Definition at line 29 of file class.ilLSStateDB.php.

TABLE_NAME

const ilLSStateDB::TABLE_NAME = 'lso_states'

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

---

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

• Modules/LearningSequence/classes/Player/class.ilLSStateDB.php