ilLearnerProgressDB Class Reference

Get LearningProgress and availability of items in sequence. More...

Collaboration diagram for ilLearnerProgressDB:

Public Member Functions
	__construct (ilLSStateDB $state_db, ilAccess $access)
	getLearnerItems (int $usr_id, int $container_ref_id, array $ls_items)
	Decorate LSItems with learning progress, availability (from conditions) kiosk-mode state information. More...

Protected Member Functions
	getLPStatusRefresher ()
	getObjIdForRefId (int $ref_id)
	getStateFor (LSItem $ls_item, array $states)
	getLearningProgressFor (int $usr_id, LSItem $ls_item)
	isItemVisibleForUser (int $usr_id, LSItem $ls_item)
	getAvailabilityFor (int $usr_id, LSItem $ls_item)

Protected Attributes
	$state_db

Detailed Description

Get LearningProgress and availability of items in sequence.

Author

Daniel Weise danie.nosp@m.l.we.nosp@m.ise@c.nosp@m.once.nosp@m.pts-a.nosp@m.nd-t.nosp@m.raini.nosp@m.ng.d.nosp@m.e

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 11 of file class.ilLearnerProgressDB.php.

Constructor & Destructor Documentation

__construct()

ilLearnerProgressDB::__construct	(	ilLSStateDB	$state_db,
		ilAccess	$access
	)

Definition at line 18 of file class.ilLearnerProgressDB.php.

References $state_db.

    {
        $this->state_db = $state_db;
        $this->access = $access;
    }

Member Function Documentation

getAvailabilityFor()

ilLearnerProgressDB::getAvailabilityFor ( int  $usr_id, LSItem  $ls_item  )

protected

Definition at line 92 of file class.ilLearnerProgressDB.php.

References ILIAS\UI\Component\Listing\Workflow\Step\AVAILABLE, LSItem\getRefId(), and ILIAS\UI\Component\Listing\Workflow\Step\NOT_AVAILABLE.

Referenced by getLearnerItems().

                                                                        : int
    {
        $readable = $this->access->checkAccessOfUser($usr_id, 'read', '', $ls_item->getRefId());
        if ($readable) {
            return ILIAS\UI\Component\Listing\Workflow\Step::AVAILABLE;
        }

        return ILIAS\UI\Component\Listing\Workflow\Step::NOT_AVAILABLE;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLearnerItems()

ilLearnerProgressDB::getLearnerItems	(	int	$usr_id,
		int	$container_ref_id,
		array	$ls_items
	)

Decorate LSItems with learning progress, availability (from conditions) kiosk-mode state information.

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

References $state, getAvailabilityFor(), getLPStatusRefresher(), getStateFor(), and isItemVisibleForUser().

                                                                                         : array
    {
        $items = [];
        $states = $this->state_db->getStatesFor($container_ref_id, [$usr_id]);
        foreach ($ls_items as $ls_item) {
            if ($this->isItemVisibleForUser($usr_id, $ls_item) === false) {
                continue;
            }
            $lp_refresher = $this->getLPStatusRefresher();
            $av = $this->getAvailabilityFor($usr_id, $ls_item);
            $state = $this->getStateFor($ls_item, $states[$usr_id]);
            $items[] = new LSLearnerItem($usr_id, $lp_refresher, $av, $state, $ls_item);
        }

        return $items;
    }

Here is the call graph for this function:

getLearningProgressFor()

ilLearnerProgressDB::getLearningProgressFor ( int  $usr_id, LSItem  $ls_item  )

protected

Definition at line 67 of file class.ilLearnerProgressDB.php.

References ilLPStatus\_lookupStatus(), getObjIdForRefId(), and LSItem\getRefId().

                                                                            : int
    {
        $obj_id = $this->getObjIdForRefId($ls_item->getRefId());
        $il_lp_status = ilLPStatus::_lookupStatus($obj_id, $usr_id, true);

        return (int) $il_lp_status;
    }

Here is the call graph for this function:

getLPStatusRefresher()

ilLearnerProgressDB::getLPStatusRefresher ( )

protected

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

References ilObject\_lookupObjId(), and ilLPStatus\_lookupStatus().

Referenced by getLearnerItems().

                                             : \Closure {
        return function(int $ref_id, int $usr_id)  {
            $obj_id = ilObject::_lookupObjId($ref_id);
            return (int)ilLPStatus::_lookupStatus($obj_id, $usr_id, true);
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjIdForRefId()

ilLearnerProgressDB::getObjIdForRefId ( int  $ref_id )

protected

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

References ilObject\_lookupObjId().

Referenced by getLearningProgressFor().

                                                     : int
    {
        return (int) ilObject::_lookupObjId($ref_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStateFor()

ilLearnerProgressDB::getStateFor ( LSItem  $ls_item, array  $states  )

protected

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

References LSItem\getRefId().

Referenced by getLearnerItems().

                                                                   : ILIAS\KioskMode\State
    {
        if (array_key_exists($ls_item->getRefId(), $states)) {
            return $states[$ls_item->getRefId()];
        }

        return new ILIAS\KioskMode\State();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isItemVisibleForUser()

ilLearnerProgressDB::isItemVisibleForUser ( int  $usr_id, LSItem  $ls_item  )

protected

Definition at line 75 of file class.ilLearnerProgressDB.php.

References LSItem\getRefId(), and LSItem\isOnline().

Referenced by getLearnerItems().

                                                                          : bool
    {
        $online = $ls_item->isOnline();
        $access = $this->access->checkAccessOfUser(
            $usr_id,
            "visible",
            "",
            $ls_item->getRefId()
        );

        if (!($online && $access)) {
            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$state_db

ilLearnerProgressDB::$state_db

protected

Definition at line 16 of file class.ilLearnerProgressDB.php.

Referenced by __construct().

---

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

• Modules/LearningSequence/classes/LearnerProgress/class.ilLearnerProgressDB.php