ilLSLearnerItemsQueries Class Reference

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)
	getLearningSequenceRefId ()
	hasItems ()
	getItems ()
	getCurrentItemRefId ()
	getCurrentItemPosition ()
	getStateFor (LSItem $ls_item, View $view)
	storeState (ILIAS\KioskMode\State $state, int $state_item_ref_id, int $current_item_ref_id)
	getFirstAccess ()

Protected Attributes
ilLearnerProgressDB	$progress_db
ilLSStateDB	$states_db
int	$ls_ref_id
int	$usr_id

Detailed Description

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

Definition at line 27 of file class.ilLSLearnerItemsQueries.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 34 of file class.ilLSLearnerItemsQueries.php.

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

References $ls_ref_id, $progress_db, $states_db, and $usr_id.

Member Function Documentation

getCurrentItemPosition()

ilLSLearnerItemsQueries::getCurrentItemPosition

(

)

Definition at line 70 of file class.ilLSLearnerItemsQueries.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 getItems().

Here is the call graph for this function:

getCurrentItemRefId()

ilLSLearnerItemsQueries::getCurrentItemRefId

(

)

Definition at line 64 of file class.ilLSLearnerItemsQueries.php.

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

getFirstAccess()

ilLSLearnerItemsQueries::getFirstAccess

(

)

Definition at line 109 of file class.ilLSLearnerItemsQueries.php.

                                    : string
    {
        $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 59 of file class.ilLSLearnerItemsQueries.php.

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

Referenced by getCurrentItemPosition(), and hasItems().

Here is the caller graph for this function:

getLearningSequenceRefId()

ilLSLearnerItemsQueries::getLearningSequenceRefId

(

)

Definition at line 46 of file class.ilLSLearnerItemsQueries.php.

                                              : int
    {
        return $this->ls_ref_id;
    }

References $ls_ref_id.

getStateFor()

ilLSLearnerItemsQueries::getStateFor	(	LSItem	$ls_item,
		View	$view
	)

Definition at line 82 of file class.ilLSLearnerItemsQueries.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 $usr_id, ILIAS\KioskMode\View\buildInitialState(), and LSItem\getRefId().

Here is the call graph for this function:

hasItems()

ilLSLearnerItemsQueries::hasItems

(

)

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

                              : bool
    {
        return count($this->getItems()) > 0;
    }

References getItems().

Here is the call graph for this function:

storeState()

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

Definition at line 95 of file class.ilLSLearnerItemsQueries.php.

     : void {
        $this->states_db->updateState(
            $this->ls_ref_id,
            $this->usr_id,
            $state_item_ref_id,
            $state,
            $current_item_ref_id
        );
    }

Field Documentation

$ls_ref_id

int ilLSLearnerItemsQueries::$ls_ref_id

protected

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

Referenced by __construct(), and getLearningSequenceRefId().

$progress_db

ilLearnerProgressDB ilLSLearnerItemsQueries::$progress_db

protected

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

Referenced by __construct().

$states_db

ilLSStateDB ilLSLearnerItemsQueries::$states_db

protected

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

Referenced by __construct().

$usr_id

int ilLSLearnerItemsQueries::$usr_id

protected

Definition at line 32 of file class.ilLSLearnerItemsQueries.php.

Referenced by __construct(), and getStateFor().

---

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

• components/ILIAS/LearningSequence/classes/Player/class.ilLSLearnerItemsQueries.php