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

Collaboration diagram for ilLMTracker:

Public Member Functions
	trackAccess (int $a_page_id, int $user_id)
	Track access to lm page. More...

	trackLastPageAccess (int $usr_id, int $lm_id, int $obj_id)
	Track last accessed page for a learning module. More...

	setCurrentPage (int $a_val)

	getCurrentPage ()

	getAllQuestionsCorrect ()
	Have all questions been answered correctly (and questions exist)? More...

	getIconForLMObject (array $a_node, int $a_highlighted_node=0)

	hasPredIncorrectAnswers (int $a_obj_id, bool $a_ignore_unlock=false)
	Has predecessing incorrect answers. More...

	getBlockedUsersInformation ()

Static Public Member Functions
static	getInstance (int $a_ref_id, int $a_user_id=0)

static	getInstanceByObjId (int $a_obj_id, int $a_user_id=0)

static	_isNodeVisible (array $a_node)
	Is node visible for the learner. More...

Data Fields
const	NOT_ATTEMPTED = 0

const	IN_PROGRESS = 1

const	COMPLETED = 2

const	FAILED = 3

const	CURRENT = 99

Static Public Attributes
static array	$instances = array()

static array	$instancesbyobj = array()

Protected Member Functions
	trackPageAndChapterAccess (int $a_page_id)

	loadLMTrackingData ()
	Load LM tracking data. More...

	determineProgressStatus (int $a_obj_id, bool &$a_has_pred_incorrect_answers, bool &$a_has_pred_incorrect_not_unlocked_answers)
	Determine progress status of nodes. More...

Protected Attributes
int	$user_id

ilDBInterface	$db

ilLanguage	$lng

Refinery	$refinery

ilComponentRepository	$component_repository

ilObjUser	$user

int	$lm_ref_id

int	$lm_obj_id

ilLMTree	$lm_tree

array	$lm_obj_ids = array()

array	$tree_arr = array()

array	$re_arr = array()

bool	$loaded_for_node = false

bool	$dirty = false

array	$page_questions = array()

array	$all_questions = array()

array	$answer_status = array()

bool	$has_incorrect_answers = false

int	$current_page_id = 0

Private Member Functions
	__construct (int $a_id, bool $a_by_obj_id=false, int $a_user_id=0)

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 Track access to ILIAS learning modules

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilLMTracker::__construct	(	int	$a_id,
		bool	$a_by_obj_id = `false`,
		int	$a_user_id = `0`
	)

private

Definition at line 57 of file class.ilLMTracker.php.

References $DIC, ilObject\_lookupObjId(), ilLMTree\getInstance(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

       {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $this->user_id = $a_user_id;
         $this->refinery = $DIC['refinery'];
         $this->component_repository = $DIC['component.repository'];
 
         if ($a_by_obj_id) {
             $this->lm_ref_id = 0;
             $this->lm_obj_id = $a_id;
         } else {
             $this->lm_ref_id = $a_id;
             $this->lm_obj_id = ilObject::_lookupObjId($a_id);
         }
 
         $this->lm_tree = ilLMTree::getInstance($this->lm_obj_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _isNodeVisible()

static ilLMTracker::_isNodeVisible ( array $a_node )

static

Is node visible for the learner.

Definition at line 583 of file class.ilLMTracker.php.

References $lm_set, ilPageObject\_lookupActivationData(), ilPageObject\_lookupActive(), and ilUtil\now().

      : bool {
         if ($a_node["type"] != "pg") {
             return true;
         }
 
         $lm_set = new ilSetting("lm");
         $active = ilPageObject::_lookupActive(
             $a_node["child"],
             "lm",
             (bool) $lm_set->get("time_scheduled_page_activation")
         );
 
         if (!$active) {
             $act_data = ilPageObject::_lookupActivationData((int) $a_node["child"], "lm");
             if ($act_data["show_activation_info"] &&
                 (ilUtil::now() < $act_data["activation_start"])) {
                 return true;
             } else {
                 return false;
             }
         } else {
             return true;
         }
     }

Here is the call graph for this function:

◆ determineProgressStatus()

ilLMTracker::determineProgressStatus	(	int	$a_obj_id,
		bool &	$a_has_pred_incorrect_answers,
		bool &	$a_has_pred_incorrect_not_unlocked_answers
	)

protected

Determine progress status of nodes.

Parameters

int $a_obj_id lm object id

Definition at line 381 of file class.ilLMTracker.php.

References $c, COMPLETED, CURRENT, FAILED, getCurrentPage(), IN_PROGRESS, NOT_ATTEMPTED, and ilArrayUtil\sortArray().

Referenced by loadLMTrackingData().

      : int {
         $status = ilLMTracker::NOT_ATTEMPTED;
 
         if (isset($this->tree_arr["nodes"][$a_obj_id])) {
             $this->tree_arr["nodes"][$a_obj_id]["has_pred_incorrect_answers"] = $a_has_pred_incorrect_answers;
             $this->tree_arr["nodes"][$a_obj_id]["has_pred_incorrect_not_unlocked_answers"] = $a_has_pred_incorrect_not_unlocked_answers;
 
             if (isset($this->tree_arr["childs"][$a_obj_id])) {
                 // sort childs in correct order
                 $this->tree_arr["childs"][$a_obj_id] = ilArrayUtil::sortArray(
                     $this->tree_arr["childs"][$a_obj_id],
                     "lft",
                     "asc",
                     true
                 );
 
                 $cnt_completed = 0;
                 foreach ($this->tree_arr["childs"][$a_obj_id] as $c) {
                     // if child is not activated/displayed count child as implicitly completed
                     // rationale: everything that is visible for the learner determines the status
                     // see also bug #14642
                     if (!self::_isNodeVisible($c)) {
                         $cnt_completed++;
                         continue;
                     }
                     $c_stat = $this->determineProgressStatus(
                         $c["child"],
                         $a_has_pred_incorrect_answers,
                         $a_has_pred_incorrect_not_unlocked_answers
                     );
                     if ($status != ilLMTracker::FAILED) {
                         if ($c_stat == ilLMTracker::FAILED) {
                             $status = ilLMTracker::IN_PROGRESS;
                         } elseif ($c_stat == ilLMTracker::IN_PROGRESS) {
                             $status = ilLMTracker::IN_PROGRESS;
                         } elseif ($c_stat == ilLMTracker::COMPLETED || $c_stat == ilLMTracker::CURRENT) {
                             $status = ilLMTracker::IN_PROGRESS;
                             $cnt_completed++;
                         }
                     }
                     // if an item is failed or in progress or (not attempted and contains questions)
                     // the next item has predecessing incorrect answers
                     if ($this->tree_arr["nodes"][$c["child"]]["type"] == "pg") {
                         if ($c_stat == ilLMTracker::FAILED || $c_stat == ilLMTracker::IN_PROGRESS ||
                             ($c_stat == ilLMTracker::NOT_ATTEMPTED && isset($this->page_questions[$c["child"]]) && count($this->page_questions[$c["child"]]) > 0)) {
                             $a_has_pred_incorrect_answers = true;
                             if (!$this->tree_arr["nodes"][$c["child"]]["unlocked"]) {
                                 $a_has_pred_incorrect_not_unlocked_answers = true;
                             }
                         }
                     }
                 }
                 if ($cnt_completed == count($this->tree_arr["childs"][$a_obj_id])) {
                     $status = ilLMTracker::COMPLETED;
                 }
             } elseif ($this->tree_arr["nodes"][$a_obj_id]["type"] == "pg") {
                 // check read event data
                 if (isset($this->re_arr[$a_obj_id]) && $this->re_arr[$a_obj_id]["read_count"] > 0) {
                     $status = ilLMTracker::COMPLETED;
                 } elseif ($a_obj_id == $this->getCurrentPage()) {
                     $status = ilLMTracker::CURRENT;
                 }
 
                 $unlocked = false;
                 if (isset($this->page_questions[$a_obj_id])) {
                     // check questions, if one is failed -> failed
                     $unlocked = true;
                     foreach ($this->page_questions[$a_obj_id] as $q_id) {
                         if (isset($this->answer_status[$q_id])
                             && $this->answer_status[$q_id]["try"] > 0
                             && !$this->answer_status[$q_id]["passed"]) {
                             $status = ilLMTracker::FAILED;
                             if (!$this->answer_status[$q_id]["unlocked"]) {
                                 $unlocked = false;
                             }
                         }
                     }
 
                     // check questions, if one is not answered -> in progress
                     if ($status != ilLMTracker::FAILED) {
                         foreach ($this->page_questions[$a_obj_id] as $q_id) {
                             if (!isset($this->answer_status[$q_id])
                                 || $this->answer_status[$q_id]["try"] == 0) {
                                 if ($status != ilLMTracker::NOT_ATTEMPTED) {
                                     $status = ilLMTracker::IN_PROGRESS;
                                 }
                             }
                         }
                         $unlocked = false;
                     }
                 }
                 $this->tree_arr["nodes"][$a_obj_id]["unlocked"] = $unlocked;
                 $this->tree_arr["nodes"][$a_obj_id]["has_pred_incorrect_answers"] = $a_has_pred_incorrect_answers;
                 $this->tree_arr["nodes"][$a_obj_id]["has_pred_incorrect_not_unlocked_answers"] = $a_has_pred_incorrect_not_unlocked_answers;
             }
         } /*else {      // free pages (currently not called, since only walking through tree structure)
         }*/
         $this->tree_arr["nodes"][$a_obj_id]["status"] = $status;
 
         return $status;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllQuestionsCorrect()

ilLMTracker::getAllQuestionsCorrect ( )

Have all questions been answered correctly (and questions exist)?

Returns: bool true, if learning module contains any question and all questions (in the chapter structure) have been answered correctly

Definition at line 367 of file class.ilLMTracker.php.

References loadLMTrackingData().

                                             : bool
     {
         $this->loadLMTrackingData();
         if (count($this->all_questions) > 0 && !$this->has_incorrect_answers) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ getBlockedUsersInformation()

ilLMTracker::getBlockedUsersInformation ( )

Definition at line 536 of file class.ilLMTracker.php.

References $component_repository, $db, $ilDB, $lng, $q, $refinery, ilObjUser\_lookupName(), ilLMObject\_lookupTitle(), ilPageQuestionProcessor\getAnswerStatus(), and ilLMPageObject\queryQuestionsOfLearningModule().

                                                 : array
     {
         $ilDB = $this->db;
         $lng = $this->lng;
         $refinery = $this->refinery;
         $component_repository = $this->component_repository;
 
         $blocked_users = array();
 
         // load question/pages information
         $this->page_questions = array();
         $this->all_questions = array();
         $page_for_question = array();
         $q = ilLMPageObject::queryQuestionsOfLearningModule($this->lm_obj_id, "", "", 0, 0);
         foreach ($q["set"] as $quest) {
             $this->page_questions[$quest["page_id"]][] = $quest["question_id"];
             $this->all_questions[] = $quest["question_id"];
             $page_for_question[$quest["question_id"]] = $quest["page_id"];
         }
         // get question information
         $qlist = new ilAssQuestionList($ilDB, $lng, $refinery, $component_repository);
         $qlist->setParentObjId(0);
         $qlist->setJoinObjectData(false);
         $qlist->addFieldFilter("question_id", $this->all_questions);
         $qlist->load();
         $qdata = $qlist->getQuestionDataArray();
 
         // load question answer information
         $this->answer_status = ilPageQuestionProcessor::getAnswerStatus($this->all_questions);
         foreach ($this->answer_status as $as) {
             if ($as["try"] >= $qdata[$as["qst_id"]]["nr_of_tries"] && $qdata[$as["qst_id"]]["nr_of_tries"] > 0 && !$as["passed"]) {
                 //var_dump($qdata[$as["qst_id"]]);
                 $name = ilObjUser::_lookupName($as["user_id"]);
                 $as["user_name"] = $name["lastname"] . ", " . $name["firstname"] . " [" . $name["login"] . "]";
                 $as["question_text"] = $qdata[$as["qst_id"]]["question_text"];
                 $as["page_id"] = $page_for_question[$as["qst_id"]];
                 $as["page_title"] = ilLMPageObject::_lookupTitle($as["page_id"]);
                 $blocked_users[] = $as;
             }
         }
 
         return $blocked_users;
     }

Here is the call graph for this function:

◆ getCurrentPage()

ilLMTracker::getCurrentPage ( )

Definition at line 298 of file class.ilLMTracker.php.

References $current_page_id.

Referenced by determineProgressStatus(), and loadLMTrackingData().

                                     : int
     {
         return $this->current_page_id;
     }

Here is the caller graph for this function:

◆ getIconForLMObject()

ilLMTracker::getIconForLMObject	(	array	$a_node,
		int	$a_highlighted_node = `0`
	)

Definition at line 487 of file class.ilLMTracker.php.

References COMPLETED, FAILED, ilLPStatusIcons\getInstance(), ilLPStatusIcons\ICON_VARIANT_SHORT, IN_PROGRESS, and loadLMTrackingData().

      : string {
         $this->loadLMTrackingData();
         $icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_SHORT);
 
         if ($a_node["child"] == $a_highlighted_node) {
             return $icons->getImagePathRunning();
         }
         if (isset($this->tree_arr["nodes"][$a_node["child"]])) {
             switch ($this->tree_arr["nodes"][$a_node["child"]]["status"] ?? null) {
                 case ilLMTracker::IN_PROGRESS:
                     return $icons->getImagePathInProgress();
 
                 case ilLMTracker::FAILED:
                     return $icons->getImagePathFailed();
 
                 case ilLMTracker::COMPLETED:
                     return $icons->getImagePathCompleted();
             }
         }
         return $icons->getImagePathNotAttempted();
     }

Here is the call graph for this function:

◆ getInstance()

static ilLMTracker::getInstance	(	int	$a_ref_id,
		int	$a_user_id = `0`
	)

static

Definition at line 82 of file class.ilLMTracker.php.

References $DIC.

Referenced by ilLMBlockedUsersTableGUI\__construct().

      : self {
         global $DIC;
 
         $ilUser = $DIC->user();
 
         if ($a_user_id == 0) {
             $a_user_id = $ilUser->getId();
         }
 
         if (!isset(self::$instances[$a_ref_id][$a_user_id])) {
             self::$instances[$a_ref_id][$a_user_id] = new ilLMTracker($a_ref_id, false, $a_user_id);
         }
         return self::$instances[$a_ref_id][$a_user_id];
     }

Here is the caller graph for this function:

◆ getInstanceByObjId()

static ilLMTracker::getInstanceByObjId	(	int	$a_obj_id,
		int	$a_user_id = `0`
	)

static

Definition at line 100 of file class.ilLMTracker.php.

References $DIC.

Referenced by ilLPStatusQuestions\_getCompleted(), and ilLPStatusQuestions\determineStatus().

      : self {
         global $DIC;
 
         $ilUser = $DIC->user();
 
         if ($a_user_id == 0) {
             $a_user_id = $ilUser->getId();
         }
 
         if (!isset(self::$instancesbyobj[$a_obj_id][$a_user_id])) {
             self::$instancesbyobj[$a_obj_id][$a_user_id] = new ilLMTracker($a_obj_id, true, $a_user_id);
         }
         return self::$instancesbyobj[$a_obj_id][$a_user_id];
     }

Here is the caller graph for this function:

◆ hasPredIncorrectAnswers()

ilLMTracker::hasPredIncorrectAnswers	(	int	$a_obj_id,
		bool	$a_ignore_unlock = `false`
	)

Has predecessing incorrect answers.

Returns: bool true if incorrect/unsanswered questions exist in predecessing pages

Definition at line 516 of file class.ilLMTracker.php.

References loadLMTrackingData().

Referenced by ilLMPresentationGUI\filterNonAccessibleNode().

       {
         $this->loadLMTrackingData();
         $ret = false;
         if (isset($this->tree_arr["nodes"][$a_obj_id])) {
             if ($a_ignore_unlock) {
                 $ret = $this->tree_arr["nodes"][$a_obj_id]["has_pred_incorrect_answers"] ?? false;
             } else {
                 $ret = $this->tree_arr["nodes"][$a_obj_id]["has_pred_incorrect_not_unlocked_answers"] ?? false;
             }
         }
         return $ret;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadLMTrackingData()

ilLMTracker::loadLMTrackingData ( )

protected

Load LM tracking data.

Loaded when needed.

Definition at line 306 of file class.ilLMTracker.php.

References $db, $ilDB, $q, ilLMObject\_getAllLMObjectsOfLM(), determineProgressStatus(), ilPageQuestionProcessor\getAnswerStatus(), getCurrentPage(), and ilLMPageObject\queryQuestionsOfLearningModule().

Referenced by getAllQuestionsCorrect(), getIconForLMObject(), and hasPredIncorrectAnswers().

                                            : void
     {
         $ilDB = $this->db;
 
         // we must prevent loading tracking data multiple times during a request where possible
         // please note that the dirty flag works only to a certain limit
         // e.g. if questions are answered the flag is not set (yet)
         // or if pages/chapter are added/deleted the flag is not set
         if ((int) $this->loaded_for_node === $this->getCurrentPage() && $this->getCurrentPage() > 0 && !$this->dirty) {
             return;
         }
 
         $this->loaded_for_node = $this->getCurrentPage();
         $this->dirty = false;
 
         // load lm tree in array
         $this->tree_arr = array();
         $nodes = $this->lm_tree->getCompleteTree();
         foreach ($nodes as $node) {
             $this->tree_arr["childs"][$node["parent"]][] = $node;
             $this->tree_arr["parent"][$node["child"]] = $node["parent"];
             $this->tree_arr["nodes"][$node["child"]] = $node;
         }
 
         // load all lm obj ids of learning module
         $this->lm_obj_ids = ilLMObject::_getAllLMObjectsOfLM($this->lm_obj_id);
 
         // load read event data
         $this->re_arr = array();
         $set = $ilDB->query("SELECT * FROM lm_read_event " .
             " WHERE " . $ilDB->in("obj_id", $this->lm_obj_ids, false, "integer") .
             " AND usr_id = " . $ilDB->quote($this->user_id, "integer"));
         while ($rec = $ilDB->fetchAssoc($set)) {
             $this->re_arr[$rec["obj_id"]] = $rec;
         }
 
         // load question/pages information
         $this->page_questions = array();
         $this->all_questions = array();
         $q = ilLMPageObject::queryQuestionsOfLearningModule($this->lm_obj_id, "", "", 0, 0);
         foreach ($q["set"] as $quest) {
             $this->page_questions[$quest["page_id"]][] = $quest["question_id"];
             $this->all_questions[] = $quest["question_id"];
         }
 
         // load question answer information
         $this->answer_status = ilPageQuestionProcessor::getAnswerStatus($this->all_questions, $this->user_id);
 
         $this->has_incorrect_answers = false;
 
         $has_pred_incorrect_answers = false;
         $has_pred_incorrect_not_unlocked_answers = false;
         $this->determineProgressStatus($this->lm_tree->readRootId(), $has_pred_incorrect_answers, $has_pred_incorrect_not_unlocked_answers);
 
         $this->has_incorrect_answers = $has_pred_incorrect_answers;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentPage()

ilLMTracker::setCurrentPage ( int $a_val )

Definition at line 292 of file class.ilLMTracker.php.

      : void {
         $this->current_page_id = $a_val;
     }

◆ trackAccess()

ilLMTracker::trackAccess	(	int	$a_page_id,
		int	$user_id
	)

Track access to lm page.

Definition at line 125 of file class.ilLMTracker.php.

References ilChangeEvent\_recordReadEvent(), ilLearningProgress\_tracProgress(), ilLPStatusWrapper\_updateStatus(), ANONYMOUS_USER_ID, trackLastPageAccess(), and trackPageAndChapterAccess().

      : void {
         if ($user_id == ANONYMOUS_USER_ID) {
             ilChangeEvent::_recordReadEvent("lm", $this->lm_ref_id, $this->lm_obj_id, $user_id);
             return;
         }
 
         if ($this->lm_ref_id == 0) {
             throw new ilLMPresentationException("ilLMTracker: No Ref Id given.");
         }
 
         // track page and chapter access
         $this->trackPageAndChapterAccess($a_page_id);
 
         // track last page access (must be done after calling trackPageAndChapterAccess())
         $this->trackLastPageAccess($this->user_id, $this->lm_ref_id, $a_page_id);
 
         // #9483
         // general learning module lp tracking
         ilLearningProgress::_tracProgress(
             $this->user_id,
             $this->lm_obj_id,
             $this->lm_ref_id,
             "lm"
         );
 
         // obsolete?
         ilLPStatusWrapper::_updateStatus($this->lm_obj_id, $this->user_id);
 
         // mark currently loaded data as dirty to force reload if necessary
         $this->dirty = true;
     }

Here is the call graph for this function:

◆ trackLastPageAccess()

ilLMTracker::trackLastPageAccess	(	int	$usr_id,
		int	$lm_id,
		int	$obj_id
	)

Track last accessed page for a learning module.

Parameters

int	$usr_id	user id
int	$lm_id	learning module id
int	$obj_id	page id

Definition at line 166 of file class.ilLMTracker.php.

References $db, ilUtil\now(), and ilDBInterface\replace().

Referenced by trackAccess().

      : void {
         $title = "";
         $db = $this->db;
         $db->replace(
             "lo_access",
             [
             "usr_id" => ["integer", $usr_id],
             "lm_id" => ["integer", $lm_id]
         ],
             [
                 "timestamp" => ["timestamp", ilUtil::now()],
                 "obj_id" => ["integer", $obj_id],
                 "lm_title" => ["text", $title]
             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ trackPageAndChapterAccess()

ilLMTracker::trackPageAndChapterAccess ( int $a_page_id )

protected

Definition at line 187 of file class.ilLMTracker.php.

References $db, $ilDB, $res, ilObjUserTracking\_getValidTimeSpan(), IL_CAL_DATETIME, and IL_CAL_UNIX.

Referenced by trackAccess().

      : void {
         $ilDB = $this->db;
 
         $now = time();
 
         //
         // 1. Page access: current page
         //
         $set = $ilDB->query("SELECT obj_id FROM lm_read_event" .
             " WHERE obj_id = " . $ilDB->quote($a_page_id, "integer") .
             " AND usr_id = " . $ilDB->quote($this->user_id, "integer"));
         if (!$ilDB->fetchAssoc($set)) {
             $fields = array(
                 "obj_id" => array("integer", $a_page_id),
                 "usr_id" => array("integer", $this->user_id)
             );
             // $ilDB->insert("lm_read_event", $fields);
             $ilDB->replace("lm_read_event", $fields, array()); // #15144
         }
 
         // update all parent chapters
         $ilDB->manipulate("UPDATE lm_read_event SET" .
             " read_count = read_count + 1 " .
             " , last_access = " . $ilDB->quote($now, "integer") .
             " WHERE obj_id = " . $ilDB->quote($a_page_id, "integer") .
             " AND usr_id = " . $ilDB->quote($this->user_id, "integer"));
 
 
         //
         // 2. Chapter access: based on last page accessed
         //
 
         // get last accessed page
         $set = $ilDB->query("SELECT * FROM lo_access WHERE " .
             "usr_id = " . $ilDB->quote($this->user_id, "integer") . " AND " .
             "lm_id = " . $ilDB->quote($this->lm_ref_id, "integer"));
         $res = $ilDB->fetchAssoc($set);
         if (isset($res["obj_id"])) {
             $valid_timespan = ilObjUserTracking::_getValidTimeSpan();
 
             $pg_ts = new ilDateTime($res["timestamp"], IL_CAL_DATETIME);
             $pg_ts = $pg_ts->get(IL_CAL_UNIX);
             $pg_id = $res["obj_id"];
             if (!$this->lm_tree->isInTree($pg_id)) {
                 return;
             }
 
             $time_diff = $read_diff = 0;
 
             // spent_seconds or read_count ?
             if (($now - $pg_ts) <= $valid_timespan) {
                 $time_diff = $now - $pg_ts;
             } else {
                 $read_diff = 1;
             }
 
             // find parent chapter(s) for that page
             $parent_st_ids = array();
             foreach ($this->lm_tree->getPathFull($pg_id) as $item) {
                 if ($item["type"] == "st") {
                     $parent_st_ids[] = $item["obj_id"];
                 }
             }
 
             if ($parent_st_ids && ($time_diff || $read_diff)) {
                 // get existing chapter entries
                 $ex_st = array();
                 $set = $ilDB->query("SELECT obj_id FROM lm_read_event" .
                     " WHERE " . $ilDB->in("obj_id", $parent_st_ids, "", "integer") .
                     " AND usr_id = " . $ilDB->quote($this->user_id, "integer"));
                 while ($row = $ilDB->fetchAssoc($set)) {
                     $ex_st[] = $row["obj_id"];
                 }
 
                 // add missing chapter entries
                 $missing_st = array_diff($parent_st_ids, $ex_st);
                 if (sizeof($missing_st)) {
                     foreach ($missing_st as $st_id) {
                         $fields = array(
                             "obj_id" => array("integer", $st_id),
                             "usr_id" => array("integer", $this->user_id)
                         );
                         // $ilDB->insert("lm_read_event", $fields);
                         $ilDB->replace("lm_read_event", $fields, array()); // #15144
                     }
                 }
 
                 // update all parent chapters
                 $ilDB->manipulate("UPDATE lm_read_event SET" .
                     " read_count = read_count + " . $ilDB->quote($read_diff, "integer") .
                     " , spent_seconds = spent_seconds + " . $ilDB->quote($time_diff, "integer") .
                     " , last_access = " . $ilDB->quote($now, "integer") .
                     " WHERE " . $ilDB->in("obj_id", $parent_st_ids, "", "integer") .
                     " AND usr_id = " . $ilDB->quote($this->user_id, "integer"));
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $all_questions

array ilLMTracker::$all_questions = array()

protected

Definition at line 49 of file class.ilLMTracker.php.

◆ $answer_status

array ilLMTracker::$answer_status = array()

protected

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

◆ $component_repository

ilComponentRepository ilLMTracker::$component_repository

protected

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

Referenced by getBlockedUsersInformation().

◆ $current_page_id

int ilLMTracker::$current_page_id = 0

protected

Definition at line 52 of file class.ilLMTracker.php.

Referenced by getCurrentPage().

◆ $db

ilDBInterface ilLMTracker::$db

protected

Definition at line 35 of file class.ilLMTracker.php.

Referenced by getBlockedUsersInformation(), loadLMTrackingData(), trackLastPageAccess(), and trackPageAndChapterAccess().

◆ $dirty

bool ilLMTracker::$dirty = false

protected

Definition at line 47 of file class.ilLMTracker.php.

◆ $has_incorrect_answers

bool ilLMTracker::$has_incorrect_answers = false

protected

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

◆ $instances

array ilLMTracker::$instances = array()

static

Definition at line 54 of file class.ilLMTracker.php.

◆ $instancesbyobj

array ilLMTracker::$instancesbyobj = array()

static

Definition at line 55 of file class.ilLMTracker.php.

◆ $lm_obj_id

int ilLMTracker::$lm_obj_id

protected

Definition at line 41 of file class.ilLMTracker.php.

◆ $lm_obj_ids

array ilLMTracker::$lm_obj_ids = array()

protected

Definition at line 43 of file class.ilLMTracker.php.

◆ $lm_ref_id

int ilLMTracker::$lm_ref_id

protected

Definition at line 40 of file class.ilLMTracker.php.

◆ $lm_tree

ilLMTree ilLMTracker::$lm_tree

protected

Definition at line 42 of file class.ilLMTracker.php.

◆ $lng

ilLanguage ilLMTracker::$lng

protected

Definition at line 36 of file class.ilLMTracker.php.

Referenced by getBlockedUsersInformation().

◆ $loaded_for_node

bool ilLMTracker::$loaded_for_node = false

protected

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

◆ $page_questions

array ilLMTracker::$page_questions = array()

protected

Definition at line 48 of file class.ilLMTracker.php.

◆ $re_arr

array ilLMTracker::$re_arr = array()

protected

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

◆ $refinery

Refinery ilLMTracker::$refinery

protected

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

Referenced by getBlockedUsersInformation().

◆ $tree_arr

array ilLMTracker::$tree_arr = array()

protected

Definition at line 44 of file class.ilLMTracker.php.

◆ $user

ilObjUser ilLMTracker::$user

protected

Definition at line 39 of file class.ilLMTracker.php.

◆ $user_id

int ilLMTracker::$user_id

protected

Definition at line 33 of file class.ilLMTracker.php.

◆ COMPLETED

const ilLMTracker::COMPLETED = 2

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

Referenced by determineProgressStatus(), and getIconForLMObject().

◆ CURRENT

const ilLMTracker::CURRENT = 99

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

Referenced by determineProgressStatus().

◆ FAILED

const ilLMTracker::FAILED = 3

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

Referenced by determineProgressStatus(), and getIconForLMObject().

◆ IN_PROGRESS

const ilLMTracker::IN_PROGRESS = 1

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

Referenced by determineProgressStatus(), and getIconForLMObject().

◆ NOT_ATTEMPTED

const ilLMTracker::NOT_ATTEMPTED = 0

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

Referenced by determineProgressStatus().

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

components/ILIAS/LearningModule/classes/class.ilLMTracker.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _isNodeVisible()

◆ determineProgressStatus()

◆ getAllQuestionsCorrect()

◆ getBlockedUsersInformation()

◆ getCurrentPage()

◆ getIconForLMObject()

◆ getInstance()

◆ getInstanceByObjId()

◆ hasPredIncorrectAnswers()

◆ loadLMTrackingData()

◆ setCurrentPage()

◆ trackAccess()

◆ trackLastPageAccess()

◆ trackPageAndChapterAccess()

Field Documentation

◆ $all_questions

◆ $answer_status

◆ $component_repository

◆ $current_page_id

◆ $db

◆ $dirty

◆ $has_incorrect_answers

◆ $instances

◆ $instancesbyobj

◆ $lm_obj_id

◆ $lm_obj_ids

◆ $lm_ref_id

◆ $lm_tree

◆ $lng

◆ $loaded_for_node

◆ $page_questions

◆ $re_arr

◆ $refinery

◆ $tree_arr

◆ $user

◆ $user_id

◆ COMPLETED

◆ CURRENT

◆ FAILED

◆ IN_PROGRESS

◆ NOT_ATTEMPTED