ilLearnerProgressDB Class Reference

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

Inheritance diagram for ilLearnerProgressDB:

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

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 Get LearningProgress and availability of items in sequence.

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

Constructor & Destructor Documentation

__construct()

ilLearnerProgressDB::__construct	(	ilLSItemsDB	$items_db,
		ilAccess	$access,
		ilObjectDataCache	$obj_data_cache
	)

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

References $access, $items_db, $obj_data_cache, and ILIAS\Repository\access().

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

Here is the call graph for this function:

Member Function Documentation

getAvailabilityFor()

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

protected

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

References ILIAS\Repository\access(), 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)

Returns

LSLearnerItem[]|[]

Definition at line 45 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 67 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 62 of file class.ilLearnerProgressDB.php.

References ilObject\_lookupObjId().

Referenced by getLearningProgressFor().

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

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

References ILIAS\Repository\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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccess ilLearnerProgressDB::$access

protected

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

Referenced by __construct().

$items_db

ilLSItemsDB ilLearnerProgressDB::$items_db

protected

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

Referenced by __construct().

$obj_data_cache

ilObjectDataCache ilLearnerProgressDB::$obj_data_cache

protected

Definition at line 28 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