Abstract class ilLPStatus for all learning progress modes E.g ilLPStatusManual, ilLPStatusObjectives ... More...

Inheritance diagram for ilLPStatus:

Collaboration diagram for ilLPStatus:

Public Member Functions
	__construct (int $a_obj_id)

	_updateStatus (int $a_obj_id, int $a_usr_id, ?object $a_obj=null, bool $a_percentage=false, bool $a_force_raise=false)
	New status handling (st: status, nr: accesses, p: percentage, t: time spent, m: mark) Learning progress: More...

	determinePercentage (int $a_obj_id, int $a_usr_id, ?object $a_obj=null)

	determineStatus (int $a_obj_id, int $a_usr_id, ?object $a_obj=null)

	refreshStatus (int $a_obj_id, ?array $a_users=null)
	Refresh status. More...

Static Public Member Functions
static	_getCountNotAttempted (int $a_obj_id)

static	_getNotAttempted (int $a_obj_id)

static	_getCountInProgress (int $a_obj_id)

static	_getInProgress (int $a_obj_id)

static	_getCountCompleted (int $a_obj_id)

static	_getCompleted (int $a_obj_id)

static	_getFailed (int $a_obj_id)

static	_getCountFailed (int $a_obj_id)

static	_getStatusInfo (int $a_obj_id)

static	_getTypicalLearningTime (string $type, int $obj_id, int $sub_id=0)

static	checkStatusForObject (int $a_obj_id, ?array $a_users=null)
	This function checks whether the status for a given number of users is dirty and must be recalculated. More...

static	writeStatus (int $a_obj_id, int $a_user_id, int $a_status, int $a_percentage=0, bool $a_force_per=false, ?int &$a_old_status=self::LP_STATUS_NOT_ATTEMPTED_NUM)
	Write status for user and object. More...

static	setInProgressIfNotAttempted (int $a_obj_id, int $a_user_id)
	This function shoudl be clalled for normal "read events". More...

static	setAllDirty ()
	Sets all status to dirty. More...

static	setDirty (int $a_obj_id)
	Sets status of an object to dirty. More...

static	_lookupStatus (int $a_obj_id, int $a_user_id, bool $a_create=true)
	Lookup status. More...

static	_lookupPercentage (int $a_obj_id, int $a_user_id)
	Lookup percentage. More...

static	_hasUserCompleted (int $a_obj_id, int $a_user_id)
	Lookup user object completion. More...

static	_lookupStatusChanged (int $a_obj_id, int $a_user_id)
	Lookup status changed. More...

static	_lookupCompletedForObject (int $a_obj_id, ?array $a_user_ids=null)
	Get completed users for object. More...

static	_lookupFailedForObject (int $a_obj_id, ?array $a_user_ids=null)
	Get failed users for object. More...

static	_lookupInProgressForObject (int $a_obj_id, ?array $a_user_ids=null)
	Get in progress users for object. More...

static	preloadListGUIData (array $a_obj_ids)

static	getListGUIStatus (int $a_obj_id, bool $a_image_only=true)

static	hasListGUIStatus (int $a_obj_id)

Data Fields
const	LP_STATUS_NOT_ATTEMPTED = 'trac_no_attempted'

const	LP_STATUS_IN_PROGRESS = 'trac_in_progress'

const	LP_STATUS_COMPLETED = 'trac_completed'

const	LP_STATUS_FAILED = 'trac_failed'

const	LP_STATUS_NOT_ATTEMPTED_NUM = 0

const	LP_STATUS_IN_PROGRESS_NUM = 1

const	LP_STATUS_COMPLETED_NUM = 2

const	LP_STATUS_FAILED_NUM = 3

const	LP_STATUS_REGISTERED = 'trac_registered'

const	LP_STATUS_NOT_REGISTERED = 'trac_not_registered'

const	LP_STATUS_PARTICIPATED = 'trac_participated'

const	LP_STATUS_NOT_PARTICIPATED = 'trac_not_participated'

Static Public Attributes
static	$list_gui_cache

Static Protected Member Functions
static	raiseEvent (int $a_obj_id, int $a_usr_id, int $a_status, int $a_old_status, int $a_percentage)

static	_lookupStatusForObject (int $a_obj_id, int $a_status, ?array $a_user_ids=null)
	Get users with given status for object. More...

static	validateLPForObjects (int $a_user_id, array $a_obj_ids, int $a_parent_ref_id)
	Process given objects for lp-relevance. More...

static	checkLPModesForObjects (array $a_obj_ids, array &$a_coll_obj_ids)
	Process lp modes for given objects. More...

static	getLPStatusForObjects (int $a_user_id, array $a_obj_ids)
	Get LP status for given objects (and user) More...

Protected Attributes
int	$obj_id

ilDBInterface	$db

ilObjectDataCache	$ilObjDataCache

Detailed Description

Abstract class ilLPStatus for all learning progress modes E.g ilLPStatusManual, ilLPStatusObjectives ...

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilLPStatus::__construct ( int $a_obj_id )

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

References $DIC.

     {
         global $DIC;
 
         $this->obj_id = $a_obj_id;
         $this->db = $DIC->database();
         $this->ilObjDataCache = $DIC['ilObjDataCache'];
     }

Member Function Documentation

◆ _getCompleted()

static ilLPStatus::_getCompleted ( int $a_obj_id )

static

Parameters

int $a_obj_id

Returns: int[]

Definition at line 94 of file class.ilLPStatus.php.

Referenced by ilTimingCache\readObjectInformation().

                                                        : array
     {
         return array();
     }

Here is the caller graph for this function:

◆ _getCountCompleted()

static ilLPStatus::_getCountCompleted ( int $a_obj_id )

static

Definition at line 85 of file class.ilLPStatus.php.

◆ _getCountFailed()

static ilLPStatus::_getCountFailed ( int $a_obj_id )

static

Definition at line 108 of file class.ilLPStatus.php.

◆ _getCountInProgress()

static ilLPStatus::_getCountInProgress ( int $a_obj_id )

static

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

◆ _getCountNotAttempted()

static ilLPStatus::_getCountNotAttempted ( int $a_obj_id )

static

Definition at line 61 of file class.ilLPStatus.php.

◆ _getFailed()

static ilLPStatus::_getFailed ( int $a_obj_id )

static

Parameters

int $a_obj_id

Returns: int[]

Definition at line 103 of file class.ilLPStatus.php.

                                                     : array
     {
         return array();
     }

◆ _getInProgress()

static ilLPStatus::_getInProgress ( int $a_obj_id )

static

Definition at line 80 of file class.ilLPStatus.php.

                                                         : array
     {
         return array();
     }

◆ _getNotAttempted()

static ilLPStatus::_getNotAttempted ( int $a_obj_id )

static

Parameters

int $a_obj_id

Returns: int[]

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

                                                           : array
     {
         return array();
     }

◆ _getStatusInfo()

static ilLPStatus::_getStatusInfo ( int $a_obj_id )

static

Definition at line 113 of file class.ilLPStatus.php.

Referenced by ilLPStatusTypicalLearningTime\_getCompleted().

                                                         : array
     {
         return array();
     }

Here is the caller graph for this function:

◆ _getTypicalLearningTime()

static ilLPStatus::_getTypicalLearningTime	(	string	$type,
		int	$obj_id,
		int	$sub_id = `0`
	)

static

Definition at line 118 of file class.ilLPStatus.php.

References $DIC.

Referenced by ilLPCollectionOfLMChapters\getPossibleItems().

                                                                                               : int
     {
         global $DIC;
 
         $lom_services = $DIC->learningObjectMetadata();
         $paths = $lom_services->paths();
         $data_helper = $lom_services->dataHelper();
 
         $value = $lom_services->read($obj_id, $sub_id, $type, $paths->firstTypicalLearningTime())
                               ->firstData($paths->firstTypicalLearningTime())
                               ->value();
 
         return $data_helper->durationToSeconds($value);
     }

Here is the caller graph for this function:

◆ _hasUserCompleted()

static ilLPStatus::_hasUserCompleted	(	int	$a_obj_id,
		int	$a_user_id
	)

static

Lookup user object completion.

Definition at line 728 of file class.ilLPStatus.php.

Referenced by ilConditionHandler\_checkCondition(), ilFileKioskModeView\buildLearningProgressToggleControl(), ilObjSAHSLearningModuleAccess\checkCondition(), ilObjLTIConsumerAccess\checkCondition(), ilObjCmiXapiAccess\checkCondition(), ilObjStudyProgramme\getCompletedCourses(), ilObjFileGUI\infoScreenForward(), ilLearningSequenceRoles\isCompletedByUser(), ilCourseStart\isFullfilled(), ilContainerStartObjects\isFullfilled(), ilFileKioskModeView\toggleLearningProgress(), and ilObjFileGUI\toggleLearningProgress().

      : bool {
         return self::_lookupStatus(
             $a_obj_id,
             $a_user_id
         ) == self::LP_STATUS_COMPLETED_NUM;
     }

Here is the caller graph for this function:

◆ _lookupCompletedForObject()

static ilLPStatus::_lookupCompletedForObject	(	int	$a_obj_id,
		?array	$a_user_ids = `null`
	)

static

Get completed users for object.

Definition at line 815 of file class.ilLPStatus.php.

Referenced by ilTimingsUser\lookupTimings().

      : array {
         return self::_lookupStatusForObject(
             $a_obj_id,
             self::LP_STATUS_COMPLETED_NUM,
             $a_user_ids
         );
     }

Here is the caller graph for this function:

◆ _lookupFailedForObject()

static ilLPStatus::_lookupFailedForObject	(	int	$a_obj_id,
		?array	$a_user_ids = `null`
	)

static

Get failed users for object.

Definition at line 829 of file class.ilLPStatus.php.

      : array {
         return self::_lookupStatusForObject(
             $a_obj_id,
             self::LP_STATUS_FAILED_NUM,
             $a_user_ids
         );
     }

◆ _lookupInProgressForObject()

static ilLPStatus::_lookupInProgressForObject	(	int	$a_obj_id,
		?array	$a_user_ids = `null`
	)

static

Get in progress users for object.

Definition at line 843 of file class.ilLPStatus.php.

      : array {
         return self::_lookupStatusForObject(
             $a_obj_id,
             self::LP_STATUS_IN_PROGRESS_NUM,
             $a_user_ids
         );
     }

◆ _lookupPercentage()

static ilLPStatus::_lookupPercentage	(	int	$a_obj_id,
		int	$a_user_id
	)

static

Lookup percentage.

Definition at line 705 of file class.ilLPStatus.php.

References $DIC, $ilDB, and null.

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilLTIAppEventListener\doCronUpdate(), and ilObjSCORMLearningModule\importRaw().

      : ?int {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $set = $ilDB->query(
             "SELECT percentage FROM ut_lp_marks WHERE " .
             " status_dirty = " . $ilDB->quote(0, "integer") .
             " AND usr_id = " . $ilDB->quote($a_user_id, "integer") .
             " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
         );
         if ($rec = $ilDB->fetchAssoc($set)) {
             return $rec["percentage"];
         }
         return null;
     }

Here is the caller graph for this function:

◆ _lookupStatus()

static ilLPStatus::_lookupStatus	(	int	$a_obj_id,
		int	$a_user_id,
		bool	$a_create = `true`
	)

static

Lookup status.

Definition at line 670 of file class.ilLPStatus.php.

References $DIC, $ilDB, ilLPStatusWrapper\_updateStatus(), and null.

Referenced by ilLearningProgressBaseGUI\__appendLPDetails(), ilLearningProgressBaseGUI\__readStatus(), ilObjSAHSLearningModuleAccess\checkCondition(), ilObjCmiXapiAccess\checkCondition(), ilObjCourse\checkLPStatusSync(), ilLPStatusTestPassed\determineStatus(), ilLPStatusCourseReference\determineStatus(), ilLTIAppEventListener\doCronUpdate(), ilCourseLPBadge\evaluate(), ilCourseMailTemplateTutorContext\getCachedPeriodByObjId(), ilObjLearningSequenceLPPollingGUI\getCurrentItemLearningProgress(), ilScormMailTemplateLPContext\getDescription(), ilLearnerProgressDB\getLearningProgressFor(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilObjSCORMInitData\getStatus(), ilObjSCORMLearningModule\importRaw(), ilLearningProgressBaseGUI\initEditUserForm(), and ilCertificateLPStatusHelper\lookUpStatus().

      : ?int {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $set = $ilDB->query(
             "SELECT status FROM ut_lp_marks WHERE " .
             " status_dirty = " . $ilDB->quote(0, "integer") .
             " AND usr_id = " . $ilDB->quote($a_user_id, "integer") .
             " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
         );
         if ($rec = $ilDB->fetchAssoc($set)) {
             return (int) $rec["status"];
         } elseif ($a_create) {
             ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
             $set = $ilDB->query(
                 "SELECT status FROM ut_lp_marks WHERE " .
                 " status_dirty = " . $ilDB->quote(0, "integer") .
                 " AND usr_id = " . $ilDB->quote($a_user_id, "integer") .
                 " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
             );
             if ($rec = $ilDB->fetchAssoc($set)) {
                 return (int) $rec["status"];
             }
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupStatusChanged()

static ilLPStatus::_lookupStatusChanged	(	int	$a_obj_id,
		int	$a_user_id
	)

static

Lookup status changed.

Definition at line 741 of file class.ilLPStatus.php.

References $DIC, $ilDB, ilLPStatusWrapper\_updateStatus(), and null.

Referenced by ilCertificateLPStatusHelper\lookupStatusChanged().

      : ?string {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $set = $ilDB->query(
             "SELECT status_changed FROM ut_lp_marks WHERE " .
             " status_dirty = " . $ilDB->quote(0, "integer") .
             " AND usr_id = " . $ilDB->quote($a_user_id, "integer") .
             " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
         );
         if ($rec = $ilDB->fetchAssoc($set)) {
             return (string) $rec["status_changed"];
         } else {
             ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
             $set = $ilDB->query(
                 "SELECT status_changed FROM ut_lp_marks WHERE " .
                 " status_dirty = " . $ilDB->quote(0, "integer") .
                 " AND usr_id = " . $ilDB->quote($a_user_id, "integer") .
                 " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
             );
             if ($rec = $ilDB->fetchAssoc($set)) {
                 return (string) $rec["status_changed"];
             }
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupStatusForObject()

static ilLPStatus::_lookupStatusForObject	(	int	$a_obj_id,
		int	$a_status,
		?array	$a_user_ids = `null`
	)

staticprotected

Get users with given status for object.

Definition at line 775 of file class.ilLPStatus.php.

References $DIC, $ilDB, $res, and ILIAS\Repository\int().

      : array {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $sql = "SELECT usr_id, status, status_dirty FROM ut_lp_marks" .
             " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer") .
             " AND status = " . $ilDB->quote($a_status, "integer");
         if ($a_user_ids) {
             $sql .= " AND " . $ilDB->in("usr_id", $a_user_ids, "", "integer");
         }
 
         $set = $ilDB->query($sql);
         $res = array();
         while ($rec = $ilDB->fetchAssoc($set)) {
             // @fixme this was broken due to wrong $res['status_dirty'] access
             // check how to update status without recursion
             // check consequences of the old implementation
             if ($rec["status_dirty"]) {
                 // update status and check again
                 if (self::_lookupStatus(
                     $a_obj_id,
                     $rec["usr_id"]
                 ) != $a_status) {
                     // update status: see comment
                 }
             }
             $res[] = (int) $rec["usr_id"];
         }
 
         return $res;
     }

Here is the call graph for this function:

◆ _updateStatus()

ilLPStatus::_updateStatus	(	int	$a_obj_id,
		int	$a_usr_id,
		?object	$a_obj = `null`,
		bool	$a_percentage = `false`,
		bool	$a_force_raise = `false`
	)

New status handling (st: status, nr: accesses, p: percentage, t: time spent, m: mark) Learning progress:

lm: ilLPStatusManual (st, nr, t, ok, p-, m-), ilLPStatusVisits (st, nr, p, t, ok, m-), ilLPStatusTypicalLearningTime (st, nr, p, t, ok, m-)
dbk: ilLPStatusManual (st, nr, t ok, p-, m-)
htlm: ilLPStatusManual (st, nr, t, m ok, p-) (but mark handling different than lm/dbk)
crs: ilLPStatusManualByTutor (st ok), ilLPStatusObjectives (st ok), ilLPStatusCollection
grp: ilLPStatusManualByTutor, ilLPStatusCollection
fold: ilLPStatusCollection
session: ilLPStatusEvent (st ok, nr and t only for infoscreen, comment and mark are not saved in learning progress table!)
exercise: ilLPStatusExerciseReturned (st, nr, m ok, t-, p-)
scorm: ilLPStatusSCORM (st, nr, p, t, m ok), ilLPStatusSCORMPackage (st, nr, t, m ok, p-)
tst: ilLPStatusTestFinished (st, nr, t, p ok, mark not synced), ilLPStatusTestPassed (st, nr, t ok, p-, mark not synced) Added determine Status to:
ilLPStatusManual
ilLPStatusVisits
ilLPStatusTypicalLearningTime
ilLPStatusManualByTutor
ilLPStatusObjectives
ilLPStatusCollection
ilLPStatusEvent
ilLPStatusExerciseReturned
ilLPStatusSCORMPackage
ilLPStatusTestFinished
ilLPStatusTestPassed Updating the status:
ilLPStatus::setInProgressIfNotAttempted($a_obj_id, $a_user_id) added to: – ilLearningProgress->_tracProgress() – ilTestSession->saveToDb()
ilChangeEvent::_recordReadEvent() added to: – ilObjSessionGUI->infoScreen()
- ilLearningProgress->_tracProgress() added to:

ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id); added to: – ilInfoScreenGUI->saveProgress() – ilLMPresentation->ilPage() – ilLPListOfObjectsGUI->updateUser() – ilCourseObjectiveResult->reset() – ilCourseObjectiveResult->__updatePassed() – ilEventParticipants->updateUser() – ilEventParticipants->_updateParticipation() – ilEventParticipants->_register() – ilEventParticipants->_unregister() – ilExerciseMembers->assignMember() – ilExerciseMembers->deassignMember() – ilExerciseMembers->ilClone() – ilExerciseMembers->writeStatus() – ilExerciseMembers->writeReturned() – ilSCORM13Player->writeGObjective() – ilObjSCORM2004LearningModule->deleteTrackingDataOfUsers() – ilObjSCORM2004LearningModule->importSuccess() – ilObjSCORM2004LearningModuleGUI->confirmedDeleteTracking() – ilSCORM13Player->removeCMIData() – ilSCORM13Player->setCMIData() – ilObjSCORMLearningModule->importSuccess() – ilObjSCORMLearningModule->importRaw() – ilObjSCORMLearningModuleGUI->confirmedDelete() – ilObjSCORMLearningModuleGUI->decreaseAttempt() – ilObjSCORMTracking->store() – ilObjSCORMTracking-> _insertTrackData() – ilSCORMPresentationGUI->increase_attemptAndsave_module_version() – ilTestScoringGUI->setPointsManual() – ilTestSession->increaseTestPass() – ilTestSession->saveToDb()
ilLPStatusWrapper::_refreshStatus($a_ojb_id); aufgenommen in: – ilCourseObjective->add() – ilCourseObjective->delete() – ilCourseObjective->deleteAll() – ilExerciseMembers->delete() – ilSCORM13Package->removeCMIData() – ilAICCCourse->delete() – ilAICCUnit->delete() – ilObjAICCLearningModule->delete() – ilSCORMItem->delete() – ilLPStatusWrapper->update() – ilLPListOfSettingsGUI->assign() – ilLPListOfSettingsGUI->deassign() – ilLPListOfSettingsGUI->groupMaterials() – ilLPListOfSettingsGUI->releaseMaterials() – ilObjTestGUI->confirmDeleteAllUserResultsObject move to ilObjTest but this can ba called for each single question – ilConditionHandlerGUI->updateCondition()
external time/access values for read events ilChangeEvent::_recordReadEvent($a_obj_id, $a_user_id, false, $attempts, $time); – ilObjSCORMTracking->_syncReadEvent in ilObjSCORMTracking->store() (add to refresh) – ilSCORM2004Tracking->_syncReadEvent in ilSCORM13Player->setCMIData()

Definition at line 222 of file class.ilLPStatus.php.

References $log, determinePercentage(), determineStatus(), ilLoggerFactory\getLogger(), and LP_STATUS_NOT_ATTEMPTED_NUM.

      : void {
         $log = ilLoggerFactory::getLogger('trac');
         $log->debug(
             sprintf(
                 "obj_id: %s, user id: %s, object: %s",
                 $a_obj_id,
                 $a_usr_id,
                 (is_object($a_obj) ? get_class($a_obj) : 'null')
             )
         );
 
         $status = $this->determineStatus($a_obj_id, $a_usr_id, $a_obj);
         $percentage = $this->determinePercentage($a_obj_id, $a_usr_id, $a_obj);
         $old_status = ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
         $changed = self::writeStatus(
             $a_obj_id,
             $a_usr_id,
             $status,
             $percentage,
             false,
             $old_status
         );
 
         // ak: I don't think that this is a good way to fix 15529, we should not
         // raise the event, if the status does not change imo.
         // for now the changes in the next line just prevent the event being raised twice
         if (!$changed && $a_force_raise) { // #15529
             self::raiseEvent(
                 $a_obj_id,
                 $a_usr_id,
                 $status,
                 $old_status,
                 $percentage
             );
         }
     }

Here is the call graph for this function:

◆ checkLPModesForObjects()

static ilLPStatus::checkLPModesForObjects	(	array	$a_obj_ids,
		array &	$a_coll_obj_ids
	)

staticprotected

Process lp modes for given objects.

Definition at line 881 of file class.ilLPStatus.php.

References $obj_id, $valid, ilLPObjSettings\_lookupDBModeForObjects(), ilLPCollection\getCollectionModes(), ilObjectLP\getInstance(), ilLPObjSettings\LP_MODE_DEACTIVATED, and ilLPObjSettings\LP_MODE_UNDEFINED.

      : array {
         $valid = array();
 
         // all lp modes with collections (gathered separately)
         $coll_modes = ilLPCollection::getCollectionModes();
 
         // check if objects have LP activated at all (DB entries)
         $existing = ilLPObjSettings::_lookupDBModeForObjects($a_obj_ids);
         foreach ($existing as $obj_id => $obj_mode) {
             if ($obj_mode != ilLPObjSettings::LP_MODE_DEACTIVATED) {
                 $valid[$obj_id] = $obj_id;
 
                 if (in_array($obj_mode, $coll_modes)) {
                     $a_coll_obj_ids[] = $obj_id;
                 }
             }
         }
 
         // missing objects in DB (default mode)
         $existing_obj_ids = array_keys($existing);
         if (sizeof($existing) != sizeof($a_obj_ids)) {
             foreach (array_diff($a_obj_ids, $existing_obj_ids) as $obj_id) {
                 $olp = ilObjectLP::getInstance($obj_id);
                 $mode = $olp->getCurrentMode();
                 if ($mode == ilLPObjSettings::LP_MODE_DEACTIVATED) {
                     // #11141
                     unset($valid[$obj_id]);
                 } elseif ($mode != ilLPObjSettings::LP_MODE_UNDEFINED) {
                     $valid[$obj_id] = $obj_id;
 
                     if (in_array($mode, $coll_modes)) {
                         $a_coll_obj_ids[] = $obj_id;
                     }
                 }
             }
             unset($existing);
         }
         return array_values($valid);
     }

Here is the call graph for this function:

◆ checkStatusForObject()

static ilLPStatus::checkStatusForObject	(	int	$a_obj_id,
		?array	$a_users = `null`
	)

static

This function checks whether the status for a given number of users is dirty and must be recalculated.

"Missing" records are not inserted!

Parameters

int	$a_obj_id
	?int[]	$a_users

Definition at line 287 of file class.ilLPStatus.php.

References $DIC, $ilDB, $r, and ilLPStatusFactory\_getInstance().

Referenced by ilTrQuery\refreshObjectsStatus().

      : void {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         //@todo: there maybe the need to add extra handling for sessions here, since the
         // "in progress" status is time dependent here. On the other hand, if they registered
         // to the session, they already accessed the course and should have a "in progress"
         // anyway. But the status on the session itself may not be correct.
 
         $sql = "SELECT usr_id FROM ut_lp_marks WHERE " .
             " obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
             " status_dirty = " . $ilDB->quote(1, "integer");
         if (is_array($a_users) && count($a_users) > 0) {
             $sql .= " AND " . $ilDB->in("usr_id", $a_users, false, "integer");
         }
         $set = $ilDB->query($sql);
         $dirty = false;
         if ($rec = $ilDB->fetchAssoc($set)) {
             $dirty = true;
         }
 
         // check if any records are missing
         $missing = false;
         if (!$dirty && is_array($a_users) && count($a_users) > 0) {
             $set = $ilDB->query(
                 "SELECT count(usr_id) cnt FROM ut_lp_marks WHERE " .
                 " obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
                 $ilDB->in("usr_id", $a_users, false, "integer")
             );
             $r = $ilDB->fetchAssoc($set);
             if ($r["cnt"] < count($a_users)) {
                 $missing = true;
             }
         }
 
         // refresh status, if records are dirty or missing
         if ($dirty || $missing) {
             $trac_obj = ilLPStatusFactory::_getInstance($a_obj_id);
             $trac_obj->refreshStatus($a_obj_id, $a_users);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determinePercentage()

ilLPStatus::determinePercentage	(	int	$a_obj_id,
		int	$a_usr_id,
		?object	$a_obj = `null`
	)

Definition at line 265 of file class.ilLPStatus.php.

Referenced by _updateStatus(), and refreshStatus().

      : int {
         return 0;
     }

Here is the caller graph for this function:

◆ determineStatus()

ilLPStatus::determineStatus	(	int	$a_obj_id,
		int	$a_usr_id,
		?object	$a_obj = `null`
	)

Definition at line 273 of file class.ilLPStatus.php.

Referenced by ilLPStatusContentVisited\_getCompleted(), and _updateStatus().

      : int {
         return 0;
     }

Here is the caller graph for this function:

◆ getListGUIStatus()

static ilLPStatus::getListGUIStatus	(	int	$a_obj_id,
		bool	$a_image_only = `true`
	)

static

Returns: string|array

Definition at line 1023 of file class.ilLPStatus.php.

Referenced by ilObjectListGUI\determineProperties().

       {
         if ($a_image_only) {
             $image = '';
             if (isset(self::$list_gui_cache[$a_obj_id]["image"])) {
                 $image = self::$list_gui_cache[$a_obj_id]["image"];
             }
 
             return $image;
         }
         return self::$list_gui_cache[$a_obj_id] ?? "";
     }

Here is the caller graph for this function:

◆ getLPStatusForObjects()

static ilLPStatus::getLPStatusForObjects	(	int	$a_user_id,
		array	$a_obj_ids
	)

staticprotected

Get LP status for given objects (and user)

Definition at line 927 of file class.ilLPStatus.php.

References $DIC, $ilDB, $obj_id, $res, and null.

      : array {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $res = array();
 
         // get user lp data
         $sql = "SELECT status, status_dirty, obj_id FROM ut_lp_marks" .
             " WHERE " . $ilDB->in("obj_id", $a_obj_ids, "", "integer") .
             " AND usr_id = " . $ilDB->quote($a_user_id, "integer");
         $set = $ilDB->query($sql);
         while ($row = $ilDB->fetchAssoc($set)) {
             if (!$row["status_dirty"]) {
                 $res[$row["obj_id"]] = $row["status"];
             } else {
                 $res[$row["obj_id"]] = self::_lookupStatus(
                     $row["obj_id"],
                     $a_user_id
                 );
             }
         }
 
         // process missing user entries (same as dirty entries, see above)
         foreach ($a_obj_ids as $obj_id) {
             if (!isset($res[$obj_id])) {
                 $res[$obj_id] = self::_lookupStatus($obj_id, $a_user_id);
                 if ($res[$obj_id] === null) {
                     $res[$obj_id] = self::LP_STATUS_NOT_ATTEMPTED_NUM;
                 }
             }
         }
 
         return $res;
     }

◆ hasListGUIStatus()

static ilLPStatus::hasListGUIStatus ( int $a_obj_id )

static

Definition at line 1038 of file class.ilLPStatus.php.

                                                           : bool
     {
         if (isset(self::$list_gui_cache[$a_obj_id])) {
             return true;
         }
         return false;
     }

◆ preloadListGUIData()

static ilLPStatus::preloadListGUIData ( array $a_obj_ids )

static

Definition at line 966 of file class.ilLPStatus.php.

References $DIC, $lng, $obj_id, $requested_ref_id, $res, $user_id, ilObjUserTracking\_enabledLearningProgress(), ilObjUserTracking\_hasLearningProgressLearner(), ilObjUserTracking\_hasLearningProgressListGUI(), ANONYMOUS_USER_ID, ilLPStatusIcons\getInstance(), and ilLPStatusIcons\ICON_VARIANT_LONG.

Referenced by ilDashboardBlockGUI\getListItemGroups(), and ilObjectListGUIPreloader\preload().

                                                                : void
     {
         global $DIC;
 
         $requested_ref_id = 0;
         if ($DIC->http()->wrapper()->query()->has('ref_id')) {
             $requested_ref_id = $DIC->http()->wrapper()->query()->retrieve(
                 'ref_id',
                 $DIC->refinery()->kindlyTo()->int()
             );
         }
 
         $ilUser = $DIC['ilUser'];
         $lng = $DIC['lng'];
 
         $user_id = $ilUser->getId();
         $res = array();
         if ($ilUser->getId() != ANONYMOUS_USER_ID &&
             ilObjUserTracking::_enabledLearningProgress() &&
             ilObjUserTracking::_hasLearningProgressLearner() && // #12042
             ilObjUserTracking::_hasLearningProgressListGUI()) {
             // -- validate
 
             // :TODO: we need the parent ref id, but this is awful
             // this step removes all "not attempted" from the list, which we usually do not want
             //$a_obj_ids = self::validateLPForObjects($user_id, $a_obj_ids, $requested_ref_id);
 
             // we are not handling the collections differently yet
             $coll_obj_ids = array();
             $a_obj_ids = self::checkLPModesForObjects(
                 $a_obj_ids,
                 $coll_obj_ids
             );
 
             // -- gather
 
             $res = self::getLPStatusForObjects($user_id, $a_obj_ids);
 
             // -- render
 
             // value to icon
             $lng->loadLanguageModule("trac");
             $icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_LONG);
             foreach ($res as $obj_id => $status) {
                 $res[$obj_id] = [
                     "image" => $icons->renderIconForStatus($status),
                     "status" => $status
                 ];
             }
         }
 
         self::$list_gui_cache = $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ raiseEvent()

static ilLPStatus::raiseEvent	(	int	$a_obj_id,
		int	$a_usr_id,
		int	$a_status,
		int	$a_old_status,
		int	$a_percentage
	)

staticprotected

Definition at line 333 of file class.ilLPStatus.php.

References $DIC, $log, and ilLoggerFactory\getLogger().

      : void {
         global $DIC;
 
         $ilAppEventHandler = $DIC['ilAppEventHandler'];
 
         $log = ilLoggerFactory::getLogger('trac');
         $log->debug(
             "obj_id: " . $a_obj_id . ", user id: " . $a_usr_id . ", status: " .
             $a_status . ", percentage: " . $a_percentage
         );
 
         $ilAppEventHandler->raise(
             "components/ILIAS/Tracking",
             "updateStatus",
             array(
             "obj_id" => $a_obj_id,
             "usr_id" => $a_usr_id,
             "status" => $a_status,
             "old_status" => $a_old_status,
             "percentage" => $a_percentage
         )
         );
     }

Here is the call graph for this function:

◆ refreshStatus()

ilLPStatus::refreshStatus	(	int	$a_obj_id,
		?array	$a_users = `null`
	)

Refresh status.

Definition at line 366 of file class.ilLPStatus.php.

References $user_id, ilLPStatusWrapper\_getCompleted(), ilLPStatusWrapper\_getFailed(), ilLPStatusWrapper\_getInProgress(), ilLPStatusWrapper\_getNotAttempted(), ilLPStatusWrapper\_updateStatus(), and determinePercentage().

                                                                         : void
     {
         $not_attempted = ilLPStatusWrapper::_getNotAttempted($a_obj_id);
         foreach ($not_attempted as $user_id) {
             $percentage = $this->determinePercentage($a_obj_id, $user_id);
             if (self::writeStatus(
                 $a_obj_id,
                 $user_id,
                 self::LP_STATUS_NOT_ATTEMPTED_NUM,
                 $percentage,
                 true
             )) {
                 //self::raiseEvent($a_obj_id, $user_id, self::LP_STATUS_NOT_ATTEMPTED_NUM, $percentage);
             }
         }
         $in_progress = ilLPStatusWrapper::_getInProgress($a_obj_id);
         foreach ($in_progress as $user_id) {
             $percentage = $this->determinePercentage($a_obj_id, $user_id);
             if (self::writeStatus(
                 $a_obj_id,
                 $user_id,
                 self::LP_STATUS_IN_PROGRESS_NUM,
                 $percentage,
                 true
             )) {
                 //self::raiseEvent($a_obj_id, $user_id, self::LP_STATUS_IN_PROGRESS_NUM, $percentage);
             }
         }
         $completed = ilLPStatusWrapper::_getCompleted($a_obj_id);
         foreach ($completed as $user_id) {
             $percentage = $this->determinePercentage($a_obj_id, $user_id);
             if (self::writeStatus(
                 $a_obj_id,
                 $user_id,
                 self::LP_STATUS_COMPLETED_NUM,
                 $percentage,
                 true
             )) {
                 //self::raiseEvent($a_obj_id, $user_id, self::LP_STATUS_COMPLETED_NUM, $percentage);
             }
         }
         $failed = ilLPStatusWrapper::_getFailed($a_obj_id);
         foreach ($failed as $user_id) {
             $percentage = $this->determinePercentage($a_obj_id, $user_id);
             if (self::writeStatus(
                 $a_obj_id,
                 $user_id,
                 self::LP_STATUS_FAILED_NUM,
                 $percentage,
                 true
             )) {
                 //self::raiseEvent($a_obj_id, $user_id, self::LP_STATUS_FAILED_NUM, $percentage);
             }
         }
         if ($a_users) {
             $missing_users = array_diff(
                 $a_users,
                 $not_attempted + $in_progress + $completed + $failed
             );
             if ($missing_users) {
                 foreach ($missing_users as $user_id) {
                     ilLPStatusWrapper::_updateStatus($a_obj_id, $user_id);
                 }
             }
         }
     }

Here is the call graph for this function:

◆ setAllDirty()

static ilLPStatus::setAllDirty ( )

static

Sets all status to dirty.

For testing puproses.

Definition at line 639 of file class.ilLPStatus.php.

References $DIC, and $ilDB.

                                         : void
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $ilDB->manipulate(
             "UPDATE ut_lp_marks SET " .
             " status_dirty = " . $ilDB->quote(1, "integer")
         );
     }

◆ setDirty()

static ilLPStatus::setDirty ( int $a_obj_id )

static

Sets status of an object to dirty.

Definition at line 654 of file class.ilLPStatus.php.

References $DIC, and $ilDB.

                                                   : void
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $ilDB->manipulate(
             "UPDATE ut_lp_marks SET " .
             " status_dirty = " . $ilDB->quote(1, "integer") .
             " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer")
         );
     }

◆ setInProgressIfNotAttempted()

static ilLPStatus::setInProgressIfNotAttempted	(	int	$a_obj_id,
		int	$a_user_id
	)

static

This function shoudl be clalled for normal "read events".

The "in progress" status is only written, if current status is "NOT ATTEMPTED"

Definition at line 604 of file class.ilLPStatus.php.

References $DIC, $ilDB, and ilLPStatusWrapper\_updateStatus().

Referenced by ilLearningProgress\_tracProgress().

      : void {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         // #11513
 
         $needs_update = false;
 
         $set = $ilDB->query(
             "SELECT usr_id, status FROM ut_lp_marks WHERE " .
             " obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
             " usr_id = " . $ilDB->quote($a_user_id, "integer")
         );
         if ($rec = $ilDB->fetchAssoc($set)) {
             // current status is not attempted, so we need to update
             if ($rec["status"] == self::LP_STATUS_NOT_ATTEMPTED_NUM) {
                 $needs_update = true;
             }
         } else {
             // no ut_lp_marks yet, we should update
             $needs_update = true;
         }
 
         if ($needs_update) {
             ilLPStatusWrapper::_updateStatus($a_obj_id, $a_user_id);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateLPForObjects()

static ilLPStatus::validateLPForObjects	(	int	$a_user_id,
		array	$a_obj_ids,
		int	$a_parent_ref_id
	)

staticprotected

Process given objects for lp-relevance.

Definition at line 857 of file class.ilLPStatus.php.

References $obj_id, and ilObjectLP\getLPMemberships().

      : array {
         $lp_invalid = array();
 
         $memberships = ilObjectLP::getLPMemberships(
             $a_user_id,
             $a_obj_ids,
             $a_parent_ref_id
         );
         foreach ($memberships as $obj_id => $status) {
             if (!$status) {
                 $lp_invalid[] = $obj_id;
             }
         }
 
         return array_diff($a_obj_ids, $lp_invalid);
     }

Here is the call graph for this function:

◆ writeStatus()

static ilLPStatus::writeStatus	(	int	$a_obj_id,
		int	$a_user_id,
		int	$a_status,
		int	$a_percentage = `0`,
		bool	$a_force_per = `false`,
		?int &	$a_old_status = `self::LP_STATUS_NOT_ATTEMPTED_NUM`
	)

static

Write status for user and object.

Definition at line 436 of file class.ilLPStatus.php.

References $DIC, $ilDB, $log, $res, ilObject\_lookupType(), ilLPStatusWrapper\_removeStatusCache(), ilLPStatusWrapper\_updateStatus(), ilDBConstants\FETCHMODE_OBJECT, and ilDBConstants\T_INTEGER.

Referenced by ilLTIConsumerGradeServiceScores\checkScore(), ilLTIConsumerResultService\deleteResult(), ilLPStatusSCORMPackage\refreshStatus(), ilLPStatusSCORM\refreshStatus(), ilLTIConsumerResultService\replaceResult(), ilObjSCORMTracking\syncGlobalStatus(), ilSCORM2004StoreData\syncGlobalStatus(), and ilFileKioskModeView\toggleLearningProgress().

      : bool {
         global $DIC;
 
         $ilDB = $DIC->database();
         $log = $DIC->logger()->trac();
 
         $log->debug(
             'Write status for:  ' . "obj_id: " . $a_obj_id . ", user id: " . $a_user_id . ", status: " . $a_status . ", percentage: " . $a_percentage . ", force: " . $a_force_per
         );
         $update_dependencies = false;
 
         $a_old_status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
 
         // get status in DB
         $set = $ilDB->query(
             "SELECT usr_id,status,status_dirty FROM ut_lp_marks WHERE " .
             " obj_id = " . $ilDB->quote($a_obj_id, "integer") . " AND " .
             " usr_id = " . $ilDB->quote($a_user_id, "integer")
         );
         $rec = $ilDB->fetchAssoc($set);
 
         // update
         if ($rec) {
             $a_old_status = $rec["status"];
 
             // status has changed: update
             if ($rec["status"] != $a_status) {
                 $ret = $ilDB->manipulate(
                     "UPDATE ut_lp_marks SET " .
                     " status = " . $ilDB->quote($a_status, "integer") . "," .
                     " status_changed = " . $ilDB->now() . "," .
                     " status_dirty = " . $ilDB->quote(0, "integer") .
                     " WHERE usr_id = " . $ilDB->quote($a_user_id, "integer") .
                     " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
                 );
                 if ($ret != 0) {
                     $update_dependencies = true;
                 }
             } // status has not changed: reset dirty flag
             elseif ($rec["status_dirty"]) {
                 $ilDB->manipulate(
                     "UPDATE ut_lp_marks SET " .
                     " status_dirty = " . $ilDB->quote(0, "integer") .
                     " WHERE usr_id = " . $ilDB->quote($a_user_id, "integer") .
                     " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
                 );
             }
         } // insert
         else {
             // #13783
             $ilDB->replace(
                 "ut_lp_marks",
                 array(
                     "obj_id" => array("integer", $a_obj_id),
                     "usr_id" => array("integer", $a_user_id)
                 ),
                 array(
                     "status" => array("integer", $a_status),
                     "status_changed" => array("timestamp", date("Y-m-d H:i:s")),
                     // was $ilDB->now()
                     "status_dirty" => array("integer", 0)
                 )
             );
 
             $update_dependencies = true;
         }
 
         // update percentage
         if ($a_percentage || $a_force_per) {
             $a_percentage = max(0, $a_percentage);
             $a_percentage = min(100, $a_percentage);
             $ret = $ilDB->manipulate(
                 "UPDATE ut_lp_marks SET " .
                 " percentage = " . $ilDB->quote($a_percentage, "integer") .
                 " WHERE usr_id = " . $ilDB->quote($a_user_id, "integer") .
                 " AND obj_id = " . $ilDB->quote($a_obj_id, "integer")
             );
         }
 
         $log->debug(
             'Update dependecies is ' . ($update_dependencies ? 'true' : 'false')
         );
 
         // update collections
         if ($update_dependencies) {
             $log->debug('update dependencies');
 
             // a change occured - remove existing cache entry
             ilLPStatusWrapper::_removeStatusCache($a_obj_id, $a_user_id);
 
             $set = $ilDB->query(
                 "SELECT ut_lp_collections.obj_id obj_id FROM " .
                 "object_reference JOIN ut_lp_collections ON " .
                 "(object_reference.obj_id = " . $ilDB->quote(
                     $a_obj_id,
                     "integer"
                 ) .
                 " AND object_reference.ref_id = ut_lp_collections.item_id)"
             );
             while ($rec = $ilDB->fetchAssoc($set)) {
                 if (in_array(
                     ilObject::_lookupType($rec["obj_id"]),
                     array("crs", "grp", "fold")
                 )) {
                     $log->debug(
                         'Calling update status for collection obj_id: ' . $rec['obj_id']
                     );
                     // just to make sure - remove existing cache entry
                     ilLPStatusWrapper::_removeStatusCache(
                         (int) $rec["obj_id"],
                         $a_user_id
                     );
                     ilLPStatusWrapper::_updateStatus(
                         (int) $rec["obj_id"],
                         $a_user_id
                     );
                 }
             }
 
             // find all course references
             if (ilObject::_lookupType($a_obj_id) == 'crs') {
                 $log->debug('update references');
 
                 $query = 'select obj_id from container_reference ' .
                     'where target_obj_id = ' . $ilDB->quote(
                         $a_obj_id,
                         ilDBConstants::T_INTEGER
                     );
                 $res = $ilDB->query($query);
                 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                     $log->debug(
                         'Calling update status for reference obj_id: ' . $row->obj_id
                     );
                     \ilLPStatusWrapper::_removeStatusCache(
                         (int) $row->obj_id,
                         $a_user_id
                     );
                     \ilLPStatusWrapper::_updateStatus(
                         (int) $row->obj_id,
                         $a_user_id
                     );
                 }
             }
 
             self::raiseEvent(
                 $a_obj_id,
                 $a_user_id,
                 $a_status,
                 $a_old_status,
                 $a_percentage
             );
         }
 
         return $update_dependencies;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $db

ilDBInterface ilLPStatus::$db

protected

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

Referenced by ilLPStatusSurveyFinished\getInvitations().

◆ $ilObjDataCache

ilObjectDataCache ilLPStatus::$ilObjDataCache

protected

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

◆ $list_gui_cache

ilLPStatus::$list_gui_cache

static

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

◆ $obj_id

int ilLPStatus::$obj_id

protected

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

Referenced by checkLPModesForObjects(), ilLPStatusCollection\determinePercentage(), getLPStatusForObjects(), preloadListGUIData(), and validateLPForObjects().

◆ LP_STATUS_COMPLETED

const ilLPStatus::LP_STATUS_COMPLETED = 'trac_completed'

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

Referenced by ilLearningProgressBaseGUI\__readStatus(), ilLearningProgressBaseGUI\_getStatusText(), ilCourseMembershipGUI\getPrintMemberData(), ilTrQuery\getSCOsStatusForUser(), ilMStListCoursesTableGUI\initFilter(), ilMStShowUserCoursesTableGUI\initFilter(), ilTrObjectUsersPropsTableGUI\initFilter(), ilTrSummaryTableGUI\initFilter(), ilLPStatusIcons\lookupNumStatus(), ilLearningSequenceRoles\readMemberData(), ilObjGroupGUI\readMemberData(), and ilObjCourseGUI\readMemberData().

◆ LP_STATUS_COMPLETED_NUM

const ilLPStatus::LP_STATUS_COMPLETED_NUM = 2

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

Referenced by ilLearningProgressBaseGUI\__getLegendHTML(), ilLearningProgressBaseGUI\__readStatus(), ilLPStatusCmiXapiAbstract\_getCompleted(), ilLPStatusStudyProgramme\_getCompleted(), ilLearningProgressBaseGUI\_getStatusText(), ilLMExplorerGUI\checkLPIcon(), ilObjCourse\checkLPStatusSync(), ilLTIConsumerGradeServiceScores\checkScore(), ILIAS\Tracking\View\Renderer\Renderer\determinePercentage(), ilLPStatusSurveyFinished\determineStatus(), ilCourseLPBadge\evaluate(), ILIAS\Course\Certificate\CertificateCourseLearningProgressEvaluation\evaluate(), ilTrSummaryTableGUI\fillHeaderCSV(), ilTrSummaryTableGUI\fillHeaderExcel(), ilLPProgressTableGUI\fillRow(), ilTrObjectUsersPropsTableGUI\fillRow(), ilTrMatrixTableGUI\fillRow(), ilLPStatusStudyProgramme\getAssignmentsLPMatrix(), ilLPStatusCourseReference\getCompleted(), ilLPMarks\getCompletionsOfUser(), ilLPObjectStatisticsLPTableGUI\getGraph(), ilLPStatusIcons\getImagePathForStatus(), ilTrMatrixTableGUI\getItems(), ilTrSummaryTableGUI\getItems(), ilObjLearningSequence\getLPCompletionStates(), ilLOUserResults\getObjectiveStatusForLP(), ilTrQuery\getObjectsDataForUser(), ILIAS\Forum\Statistics\ForumStatisticsTable\getProgressStatus(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilLPStatusStudyProgramme\getStatusForAssignments(), ilTrQuery\getSubItemsStatusForUser(), ilLOUserResults\getSummarizedObjectiveStatusForLP(), ilTrQuery\getUserObjectiveMatrix(), ilBadgeAppEventListener\handleEvent(), ilSkillAppEventListener\handleEvent(), ilCourseAppEventListener\handleEvent(), ilCertificateAppEventListener\handleLPUpdate(), ilObjSCORM2004LearningModule\importSuccess(), ilObjSCORMLearningModule\importSuccess(), ilLPObjectStatisticsLPTableGUI\init(), ilLearningProgressGUI\initCollectionManualForm(), ilLearningProgressBaseGUI\initEditUserForm(), ilMStListCoursesTableGUI\initFilter(), ilMStShowUserCoursesTableGUI\initFilter(), ilTrObjectUsersPropsTableGUI\initFilter(), ilTrSummaryTableGUI\initFilter(), ilCourseObjectiveListGUI\insertProgressInfo(), ilLPStatusCmiXapiAbstract\loadStatusInfo(), ilLPStatusIcons\lookupNumStatus(), ilLearningSequenceAppEventListener\onServiceTrackingUpdateStatus(), ilStudyProgrammeAppEventListener\onServiceTrackingUpdateStatus(), ilLPStatusCourseReference\readStatusInfo(), ilLTIConsumerResultService\replaceResult(), ilLearningProgressGUI\showtlt(), ILIAS\Course\Certificate\ilCertificateCourseLearningProgressEvaluationTest\testAllCoursesAreCompletedOnLPChange(), ILIAS\Course\Certificate\ilCertificateCourseLearningProgressEvaluationTest\testOnlyOneCourseIsCompletedOnLPChange(), ilLPStatusIconsTest\testSomeExamplesForImagePathsByStatus(), ilFileKioskModeView\toggleLearningProgress(), and ilLTIAppEventListener\tryOutcomeService().

◆ LP_STATUS_FAILED

const ilLPStatus::LP_STATUS_FAILED = 'trac_failed'

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

Referenced by ilLearningProgressBaseGUI\__readStatus(), ilLearningProgressBaseGUI\_getStatusText(), ilCourseMembershipGUI\getPrintMemberData(), ilTrQuery\getSCOsStatusForUser(), ilObjSCORM2004LearningModule\importSuccess(), ilObjSCORMLearningModule\importSuccess(), ilMStListCoursesTableGUI\initFilter(), ilMStShowUserCoursesTableGUI\initFilter(), ilTrObjectUsersPropsTableGUI\initFilter(), ilTrSummaryTableGUI\initFilter(), ilLPStatusIcons\lookupNumStatus(), ilLearningSequenceRoles\readMemberData(), ilObjGroupGUI\readMemberData(), and ilObjCourseGUI\readMemberData().

◆ LP_STATUS_FAILED_NUM

const ilLPStatus::LP_STATUS_FAILED_NUM = 3

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

Referenced by ilLearningProgressBaseGUI\__getLegendHTML(), ilLearningProgressBaseGUI\__readStatus(), ilLPStatusCmiXapiAbstract\_getFailed(), ilLPStatusStudyProgramme\_getFailed(), ilLearningProgressBaseGUI\_getStatusText(), ilObjSAHSLearningModuleAccess\checkCondition(), ilObjCmiXapiAccess\checkCondition(), ilTrSummaryTableGUI\fillHeaderCSV(), ilTrSummaryTableGUI\fillHeaderExcel(), ilLPStatusStudyProgramme\getAssignmentsLPMatrix(), ilLPObjectStatisticsLPTableGUI\getGraph(), ilLPStatusIcons\getImagePathForStatus(), ilTrMatrixTableGUI\getItems(), ilTrSummaryTableGUI\getItems(), ilLOUserResults\getObjectiveStatusForLP(), ilTrQuery\getObjectsDataForUser(), ILIAS\Forum\Statistics\ForumStatisticsTable\getProgressStatus(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilLPStatusStudyProgramme\getStatusForAssignments(), ilLOUserResults\getSummarizedObjectiveStatusForLP(), ilTrQuery\getUserObjectiveMatrix(), ilObjSCORM2004LearningModule\importSuccess(), ilObjSCORMLearningModule\importSuccess(), ilLPObjectStatisticsLPTableGUI\init(), ilMStListCoursesTableGUI\initFilter(), ilMStShowUserCoursesTableGUI\initFilter(), ilTrObjectUsersPropsTableGUI\initFilter(), ilTrSummaryTableGUI\initFilter(), ilCourseObjectiveListGUI\insertProgressInfo(), ilLPStatusCmiXapiAbstract\loadStatusInfo(), ilLPStatusIcons\lookupNumStatus(), ilLPStatusCourseReference\readStatusInfo(), ilLPStatusIconsTest\testSomeExamplesForImagePathsByStatus(), and ilLTIAppEventListener\tryOutcomeService().

◆ LP_STATUS_IN_PROGRESS

const ilLPStatus::LP_STATUS_IN_PROGRESS = 'trac_in_progress'

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

Referenced by ilLearningProgressBaseGUI\__readStatus(), ilLearningProgressBaseGUI\_getStatusText(), ilCourseMembershipGUI\getPrintMemberData(), ilTrQuery\getSCOsStatusForUser(), ilObjSCORM2004LearningModule\importSuccess(), ilObjSCORMLearningModule\importSuccess(), ilMStListCoursesTableGUI\initFilter(), ilMStShowUserCoursesTableGUI\initFilter(), ilTrObjectUsersPropsTableGUI\initFilter(), ilTrSummaryTableGUI\initFilter(), ilLPStatusIcons\lookupNumStatus(), ilLearningSequenceRoles\readMemberData(), ilObjGroupGUI\readMemberData(), and ilObjCourseGUI\readMemberData().

◆ LP_STATUS_IN_PROGRESS_NUM

const ilLPStatus::LP_STATUS_IN_PROGRESS_NUM = 1

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

Referenced by ilLearningProgressBaseGUI\__getLegendHTML(), ilLearningProgressBaseGUI\__readStatus(), ilLPStatusCmiXapiAbstract\_getInProgress(), ilLPStatusStudyProgramme\_getInProgress(), ilLPStatusObjectives\_getStatusInfo(), ilLearningProgressBaseGUI\_getStatusText(), ilLMExplorerGUI\checkLPIcon(), ilLTIConsumerGradeServiceScores\checkScore(), ilLTIConsumerResultService\deleteResult(), ilLPStatusSurveyFinished\determineStatus(), ilIndividualAssessmentLPInterface\determineStatusOfMember(), ilTrSummaryTableGUI\fillHeaderCSV(), ilTrSummaryTableGUI\fillHeaderExcel(), ilLPStatusStudyProgramme\getAssignmentsLPMatrix(), ilLPObjectStatisticsLPTableGUI\getGraph(), ilLPStatusIcons\getImagePathForStatus(), ilLPStatusCourseReference\getInProgress(), ilTrMatrixTableGUI\getItems(), ilTrSummaryTableGUI\getItems(), ilLOUserResults\getObjectiveStatusForLP(), ilTrQuery\getObjectsDataForUser(), ILIAS\Forum\Statistics\ForumStatisticsTable\getProgressStatus(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilLPStatusStudyProgramme\getStatusForAssignments(), ilTrQuery\getSubItemsStatusForUser(), ilLOUserResults\getSummarizedObjectiveStatusForLP(), ilTrQuery\getUserObjectiveMatrix(), ilObjSCORM2004LearningModule\importSuccess(), ilObjSCORMLearningModule\importSuccess(), ilLPObjectStatisticsLPTableGUI\init(), ilMStListCoursesTableGUI\initFilter(), ilMStShowUserCoursesTableGUI\initFilter(), ilLPObjectStatisticsLPTableGUI\initFilter(), ilTrObjectUsersPropsTableGUI\initFilter(), ilTrSummaryTableGUI\initFilter(), ilDashboardLearningSequenceGUI\isRelevantLso(), ilLPStatusCmiXapiAbstract\loadStatusInfo(), ilLPStatusIcons\lookupNumStatus(), ilLPStatusCourseReference\readStatusInfo(), ilLTIConsumerResultService\replaceResult(), ilLearningProgressGUI\showtlt(), ILIAS\Course\Certificate\ilCertificateCourseLearningProgressEvaluationTest\testOnlyOneCourseIsCompletedOnLPChange(), and ilLPStatusIconsTest\testSomeExamplesForImagePathsByStatus().

◆ LP_STATUS_NOT_ATTEMPTED

const ilLPStatus::LP_STATUS_NOT_ATTEMPTED = 'trac_no_attempted'

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

Referenced by ilLearningProgressBaseGUI\__readStatus(), ilLearningProgressBaseGUI\_getStatusText(), ilCourseMembershipGUI\getPrintMemberData(), ilTrQuery\getSCOsStatusForUser(), ilObjSCORM2004LearningModule\importSuccess(), ilObjSCORMLearningModule\importSuccess(), ilMStListCoursesTableGUI\initFilter(), ilMStShowUserCoursesTableGUI\initFilter(), ilTrObjectUsersPropsTableGUI\initFilter(), ilTrSummaryTableGUI\initFilter(), ilLPStatusIcons\lookupNumStatus(), ilLearningSequenceRoles\readMemberData(), ilObjGroupGUI\readMemberData(), and ilObjCourseGUI\readMemberData().

◆ LP_STATUS_NOT_ATTEMPTED_NUM

const ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM = 0

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

Referenced by ilLearningProgressBaseGUI\__getLegendHTML(), ilLearningProgressBaseGUI\__readStatus(), ilLPStatusCmiXapiAbstract\_getNotAttempted(), ilLearningProgressBaseGUI\_getStatusText(), _updateStatus(), ilTrQuery\buildFilters(), ilLMExplorerGUI\checkLPIcon(), ILIAS\MyStaff\ListCourses\ilMStListCourses\createWhereStatement(), ilLPStatusSurveyFinished\determineStatus(), ilIndividualAssessmentLPInterface\determineStatusOfMember(), ilTrSummaryTableGUI\fillHeaderCSV(), ilTrSummaryTableGUI\fillHeaderExcel(), ilTrMatrixTableGUI\fillRow(), ilLPStatusStudyProgramme\getAssignmentsLPMatrix(), ilCourseMailTemplateTutorContext\getCachedPeriodByObjId(), ilObjLearningSequenceLPPollingGUI\getCurrentItemLearningProgress(), ilScormMailTemplateLPContext\getDescription(), ilLPObjectStatisticsLPTableGUI\getGraph(), ilLPStatusIcons\getImagePathForStatus(), ilTrMatrixTableGUI\getItems(), ilTrSummaryTableGUI\getItems(), ilLearnerProgressDB\getLearningProgressFor(), ilLPStatusCourseReference\getNotAttempted(), ilTrQuery\getObjectivesStatusForUser(), ilTrQuery\getObjectsDataForUser(), ilTrQuery\getObjectsStatusForUser(), ILIAS\Forum\Statistics\ForumStatisticsTable\getProgressStatus(), ilLPStatusStudyProgramme\getStatusForAssignments(), ilTrQuery\getSubItemsStatusForUser(), ilTrQuery\getUserObjectiveMatrix(), ilCertificateAppEventListener\handleLPUpdate(), ilObjSCORM2004LearningModule\importSuccess(), ilObjSCORMLearningModule\importSuccess(), ilLPObjectStatisticsLPTableGUI\init(), ilLearningProgressGUI\initCollectionManualForm(), ilMStListCoursesTableGUI\initFilter(), ilMStShowUserCoursesTableGUI\initFilter(), ilTrObjectUsersPropsTableGUI\initFilter(), ilTrSummaryTableGUI\initFilter(), ilCourseObjectiveListGUI\insertProgressInfo(), ilLPStatusCmiXapiAbstract\loadStatusInfo(), ilLPStatusIcons\lookupNumStatus(), ilLPStatusCourseReference\readStatusInfo(), ilLearningProgressGUI\showtlt(), ilFileKioskModeView\toggleLearningProgress(), and ilLTIAppEventListener\tryOutcomeService().

◆ LP_STATUS_NOT_PARTICIPATED

const ilLPStatus::LP_STATUS_NOT_PARTICIPATED = 'trac_not_participated'

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

◆ LP_STATUS_NOT_REGISTERED

const ilLPStatus::LP_STATUS_NOT_REGISTERED = 'trac_not_registered'

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

◆ LP_STATUS_PARTICIPATED

const ilLPStatus::LP_STATUS_PARTICIPATED = 'trac_participated'

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

◆ LP_STATUS_REGISTERED

const ilLPStatus::LP_STATUS_REGISTERED = 'trac_registered'

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

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

components/ILIAS/Tracking/classes/class.ilLPStatus.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getCompleted()

◆ _getCountCompleted()

◆ _getCountFailed()

◆ _getCountInProgress()

◆ _getCountNotAttempted()

◆ _getFailed()

◆ _getInProgress()

◆ _getNotAttempted()

◆ _getStatusInfo()

◆ _getTypicalLearningTime()

◆ _hasUserCompleted()

◆ _lookupCompletedForObject()

◆ _lookupFailedForObject()

◆ _lookupInProgressForObject()

◆ _lookupPercentage()

◆ _lookupStatus()

◆ _lookupStatusChanged()

◆ _lookupStatusForObject()

◆ _updateStatus()

- ilLearningProgress->_tracProgress() added to:

◆ checkLPModesForObjects()

◆ checkStatusForObject()

◆ determinePercentage()

◆ determineStatus()

◆ getListGUIStatus()

◆ getLPStatusForObjects()

◆ hasListGUIStatus()

◆ preloadListGUIData()

◆ raiseEvent()

◆ refreshStatus()

◆ setAllDirty()

◆ setDirty()

◆ setInProgressIfNotAttempted()

◆ validateLPForObjects()

◆ writeStatus()

Field Documentation

◆ $db

◆ $ilObjDataCache

◆ $list_gui_cache

◆ $obj_id

◆ LP_STATUS_COMPLETED

◆ LP_STATUS_COMPLETED_NUM

◆ LP_STATUS_FAILED

◆ LP_STATUS_FAILED_NUM

◆ LP_STATUS_IN_PROGRESS

◆ LP_STATUS_IN_PROGRESS_NUM

◆ LP_STATUS_NOT_ATTEMPTED

◆ LP_STATUS_NOT_ATTEMPTED_NUM

◆ LP_STATUS_NOT_PARTICIPATED

◆ LP_STATUS_NOT_REGISTERED

◆ LP_STATUS_PARTICIPATED

◆ LP_STATUS_REGISTERED