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

Collaboration diagram for ilLearnerProgressDB:

Public Member Functions
	__construct (ilLSItemsDB $items_db, ilAccess $access, ilObjectDataCache $obj_data_cache)

	getLearnerItems (int $usr_id, int $container_ref_id)
	Decorate LSItems with learning progress and availability (from conditions) More...

Protected Member Functions
	getObjIdForRefId (int $ref_id)

	getLearningProgressFor (int $usr_id, LSItem $ls_item)

	isItemVisibleForUser (int $usr_id, LSItem $ls_item)

	getAvailabilityFor (int $usr_id, LSItem $ls_item)

Protected Attributes
	$items_db

	$access

	$obj_data_cache

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	(	ilLSItemsDB	$items_db,
		ilAccess	$access,
		ilObjectDataCache	$obj_data_cache
	)

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

References $access, $items_db, and $obj_data_cache.

       {
         $this->items_db = $items_db;
         $this->access = $access;
         $this->obj_data_cache = $obj_data_cache;
     }

Member Function Documentation

◆ getAvailabilityFor()

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

protected

Definition at line 82 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
     {
         $this->access->clear(); //clear access cache; condition-checks refer to previous state otherwise.
         $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
	)

Decorate LSItems with learning progress and availability (from conditions)

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

References getAvailabilityFor(), getLearningProgressFor(), and isItemVisibleForUser().

                                                                         : array
     {
         $items = [];
         $ls_items = $this->items_db->getLSItems($container_ref_id);
 
         foreach ($ls_items as $ls_item) {
             if ($this->isItemVisibleForUser($usr_id, $ls_item) === false) {
                 continue;
             }
             $lp = $this->getLearningProgressFor($usr_id, $ls_item);
             $av = $this->getAvailabilityFor($usr_id, $ls_item);
             $items[] = new LSLearnerItem($usr_id, $lp, $av, $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 59 of file class.ilLearnerProgressDB.php.

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

Referenced by getLearnerItems().

                                                                             : int
     {
         $obj_id = $this->getObjIdForRefId($ls_item->getRefId());
 
         $il_lp_status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
         if (ilObjectLP::isSupportedObjectType($this->obj_data_cache->lookupType($obj_id))) {
             $il_lp_status = ilLPStatus::_lookupStatus($obj_id, $usr_id, true);
         }
         return (int) $il_lp_status;
     }

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

Referenced by getLearningProgressFor().

                                                      : int
     {
         return (int) $this->obj_data_cache->lookupObjId($ref_id);
     }

Here is the caller graph for this function:

◆ isItemVisibleForUser()

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

protected

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

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

Referenced by getLearnerItems().

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