This combines calls to ProgressDB and StateDB to handle learner-items in the context of a specific LSObject and a specific user. More...

Collaboration diagram for ilLSLearnerItemsQueries:

Public Member Functions
	__construct (ilLearnerProgressDB $progress_db, ilLSStateDB $states_db, int $ls_ref_id, int $usr_id)

	getItems ()

	getCurrentItemRefId ()

	getCurrentItemPosition ()

	getStateFor (LSItem $ls_item, \ILIAS\KioskMode\View $view)

	storeState (ILIAS\KioskMode\State $state, int $state_item_ref_id, int $current_item_ref_id)

	getFirstAccess ()

Detailed Description

This combines calls to ProgressDB and StateDB to handle learner-items in the context of a specific LSObject and a specific user.

Author: Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

Definition at line 9 of file class.ilLSItemsQueries.php.

Constructor & Destructor Documentation

◆ __construct()

ilLSLearnerItemsQueries::__construct	(	ilLearnerProgressDB	$progress_db,
		ilLSStateDB	$states_db,
		int	$ls_ref_id,
		int	$usr_id
	)

Definition at line 11 of file class.ilLSItemsQueries.php.

      {
        $this->progress_db = $progress_db;
        $this->states_db = $states_db;
        $this->ls_ref_id = $ls_ref_id;
        $this->usr_id = $usr_id;
    }

Member Function Documentation

◆ getCurrentItemPosition()

ilLSLearnerItemsQueries::getCurrentItemPosition ( )

Definition at line 38 of file class.ilLSItemsQueries.php.

                                             : int
    {
        $current_position = 0;
        $items = $this->getItems();
        foreach ($items as $index => $item) {
            if ($item->getRefId() === $this->getCurrentItemRefId()) {
                $current_position = $index;
            }
        }
        return $current_position;
    }

References $index, and getItems().

Here is the call graph for this function:

◆ getCurrentItemRefId()

ilLSLearnerItemsQueries::getCurrentItemRefId ( )

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

                                          : int
    {
        $current = $this->states_db->getCurrentItemsFor($this->ls_ref_id, [$this->usr_id]);
        $ref_id = max(0, $current[$this->usr_id]); //0 or greater
        return $ref_id;
    }

◆ getFirstAccess()

ilLSLearnerItemsQueries::getFirstAccess ( )

Definition at line 77 of file class.ilLSItemsQueries.php.

    {
        $first_access = $this->states_db->getFirstAccessFor($this->ls_ref_id, [$this->usr_id]);
        return $first_access[$this->usr_id];
    }

◆ getItems()

ilLSLearnerItemsQueries::getItems ( )

Returns: LSLearnerItem[]

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

                               : array
    {
        return $this->progress_db->getLearnerItems($this->usr_id, $this->ls_ref_id);
    }

Referenced by getCurrentItemPosition().

Here is the caller graph for this function:

◆ getStateFor()

ilLSLearnerItemsQueries::getStateFor	(	LSItem	$ls_item,
		\ILIAS\KioskMode\View	$view
	)

Definition at line 50 of file class.ilLSItemsQueries.php.

                                                                              : ILIAS\KioskMode\State
    {
        $states = $this->states_db->getStatesFor($this->ls_ref_id, [$this->usr_id]);
        $states = $states[$this->usr_id];
 
        if (array_key_exists($ls_item->getRefId(), $states)) {
            return $states[$ls_item->getRefId()];
        }
        return $view->buildInitialState(
            new ILIAS\KioskMode\State()
        );
    }

References LSItem\getRefId().