ilLearningProgress Class Reference

Collaboration diagram for ilLearningProgress:

Static Public Member Functions
static	_tracProgress (int $a_user_id, int $a_obj_id, int $a_ref_id, string $a_obj_type='')
static	_getProgress (int $a_user_id, int $a_obj_id)
static	_lookupProgressByObjId (int $a_obj_id)
	lookup progress for a specific object More...

Detailed Description

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

Member Function Documentation

_getProgress()

static ilLearningProgress::_getProgress ( int  $a_user_id, int  $a_obj_id  )

static

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

References ilChangeEvent\_lookupReadEvents(), IL_CAL_DATETIME, IL_CAL_UNIX, and ILIAS\Repository\int().

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilCourseMailTemplateTutorContext\getCachedPeriodByObjId(), and ilScormMailTemplateLPContext\getDescription().

                                                                      : array
    {
        $events = ilChangeEvent::_lookupReadEvents($a_obj_id, $a_user_id);

        $progress = [];
        foreach ($events as $row) {
            $tmp_date = new ilDateTime($row['last_access'], IL_CAL_UNIX);
            $row['last_access'] = $tmp_date->get(IL_CAL_UNIX);

            $tmp_date = new ilDateTime($row['first_access'], IL_CAL_DATETIME);
            $row['first_access'] = $tmp_date->get(IL_CAL_UNIX);

            if ($progress) {
                $progress['spent_seconds'] += (int) $row['spent_seconds'];
                $progress['access_time'] = max(
                    $progress['access_time'],
                    (int) $row['last_access']
                );
                $progress['access_time_min'] = min(
                    $progress['access_time_min'],
                    (int) $row['first_access']
                );
            } else {
                $progress['obj_id'] = (int) $row['obj_id'];
                $progress['user_id'] = (int) $row['usr_id'];
                $progress['spent_seconds'] = (int) $row['spent_seconds'];
                $progress['access_time'] = (int) $row['last_access'];
                $progress['access_time_min'] = (int) $row['first_access'];
                $progress['visits'] = (int) $row['read_count'];
            }
        }
        return $progress;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupProgressByObjId()

static ilLearningProgress::_lookupProgressByObjId ( int  $a_obj_id )

static

lookup progress for a specific object

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

References ilChangeEvent\_lookupReadEvents(), and ILIAS\Repository\int().

Referenced by ilCourseMembershipGUI\getPrintMemberData(), ilLearningSequenceRoles\readMemberData(), ilObjGroupGUI\readMemberData(), and ilObjCourseGUI\readMemberData().

                                                                : array
    {
        $progress = [];
        foreach (ilChangeEvent::_lookupReadEvents($a_obj_id) as $row) {
            if (isset($progress[$row['usr_id']])) {
                $progress[$row['usr_id']]['spent_seconds'] += (int) $row['spent_seconds'];
                $progress[$row['usr_id']]['read_count'] += (int) $row['read_count'];
                $progress[$row['usr_id']]['ts'] = max(
                    (int) $row['last_access'],
                    (int) $progress[$row['usr_id']]['ts']
                );
            } else {
                $progress[$row['usr_id']]['spent_seconds'] = (int) $row['spent_seconds'];
                $progress[$row['usr_id']]['read_count'] = (int) $row['read_count'];
                $progress[$row['usr_id']]['ts'] = (int) $row['last_access'];
            }
            $progress[$row['usr_id']]['usr_id'] = (int) $row['usr_id'];
            $progress[$row['usr_id']]['obj_id'] = (int) $row['obj_id'];
        }
        return $progress;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_tracProgress()

static ilLearningProgress::_tracProgress ( int  $a_user_id, int  $a_obj_id, int  $a_ref_id, string  $a_obj_type = ''  )

static

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

References ilChangeEvent\_recordReadEvent(), and ilLPStatus\setInProgressIfNotAttempted().

Referenced by ilObjGroupGUI\executeCommand(), ilObjCourseGUI\executeCommand(), ilSurveyExecutionGUI\outSurveyPage(), ilContentPageKioskModeView\render(), ilObjCourseGUI\renderObject(), ilInfoScreenGUI\saveProgress(), ilObjFileBasedLMGUI\setStartFile(), ilObjExerciseGUI\showOverviewObject(), ilObjFileGUI\toggleLearningProgress(), ilLMTracker\trackAccess(), ilObjContentPage\trackProgress(), ilObjFolderGUI\viewObject(), and ilObjGroupGUI\viewObject().

     : bool {
        ilChangeEvent::_recordReadEvent(
            $a_obj_type,
            $a_ref_id,
            $a_obj_id,
            $a_user_id
        );

        ilLPStatus::setInProgressIfNotAttempted($a_obj_id, $a_user_id);

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/Tracking/classes/class.ilLearningProgress.php