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

Inheritance diagram for ilLPStatusVisits:

Collaboration diagram for ilLPStatusVisits:

Public Member Functions
	determineStatus (int $a_obj_id, int $a_usr_id, object $a_obj=null)

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

Public Member Functions inherited from ilLPStatus
	__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	_getInProgress (int $a_obj_id)

static	_getCompleted (int $a_obj_id)

static	_getStatusInfo (int $a_obj_id)

Static Public Member Functions inherited from ilLPStatus
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 (int $a_obj_id)

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)

Additional Inherited Members
Data Fields inherited from ilLPStatus
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 inherited from ilLPStatus
static	$list_gui_cache

Static Protected Member Functions inherited from ilLPStatus
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 inherited from ilLPStatus
int	$obj_id

ilDBInterface	$db

ilObjectDataCache	$ilObjDataCache

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

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

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

Member Function Documentation

◆ _getCompleted()

static ilLPStatusVisits::_getCompleted ( int $a_obj_id )

static

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

References $DIC, $ilDB, ilLPStatusWrapper\_getStatusInfo(), ilChangeEvent\_lookupReadEvents(), and ILIAS\Repository\int().

                                                        : array
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
         $required_visits = $status_info['visits'];
 
         $all = ilChangeEvent::_lookupReadEvents($a_obj_id);
         $user_ids = [];
         foreach ($all as $event) {
             if ($event['read_count'] >= $required_visits) {
                 $user_ids[] = (int) $event['usr_id'];
             }
         }
         return $user_ids;
     }

Here is the call graph for this function:

◆ _getInProgress()

static ilLPStatusVisits::_getInProgress ( int $a_obj_id )

static

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

References $DIC, $ilDB, ilLPStatusWrapper\_getStatusInfo(), ilChangeEvent\_lookupReadEvents(), and ILIAS\Repository\int().

                                                         : array
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
         $required_visits = $status_info['visits'];
 
         $all = ilChangeEvent::_lookupReadEvents($a_obj_id);
         $user_ids = [];
         foreach ($all as $event) {
             if ($event['read_count'] < $required_visits) {
                 $user_ids[] = (int) $event['usr_id'];
             }
         }
         return $user_ids;
     }

Here is the call graph for this function:

◆ _getStatusInfo()

static ilLPStatusVisits::_getStatusInfo ( int $a_obj_id )

static

Definition at line 65 of file class.ilLPStatusVisits.php.

References ilLPObjSettings\_lookupVisits().

                                                         : array
     {
         $status_info['visits'] = ilLPObjSettings::_lookupVisits($a_obj_id);
         return $status_info;
     }

Here is the call graph for this function:

◆ determinePercentage()

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

Definition at line 104 of file class.ilLPStatusVisits.php.

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

      : int {
         $reqv = ilLPObjSettings::_lookupVisits($a_obj_id);
 
         $re = ilChangeEvent::_lookupReadEvents($a_obj_id, $a_usr_id);
         $rc = (int) ($re[0]["read_count"] ?? 0);
 
         if ($reqv > 0 && $rc) {
             $per = min(100, 100 / $reqv * $rc);
         } else {
             $per = 100;
         }
         return $per;
     }

Here is the call graph for this function:

◆ determineStatus()

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

Definition at line 71 of file class.ilLPStatusVisits.php.

References $DIC, $ilDB, ilLPStatus\$ilObjDataCache, ilLPStatusWrapper\_getStatusInfo(), ilChangeEvent\_lookupReadEvents(), and ilChangeEvent\hasAccessed().

      : int {
         global $DIC;
 
         $ilObjDataCache = $DIC['ilObjDataCache'];
         $ilDB = $DIC['ilDB'];
 
         $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
         switch ($this->ilObjDataCache->lookupType($a_obj_id)) {
             case 'lm':
                 if (ilChangeEvent::hasAccessed($a_obj_id, $a_usr_id)) {
                     $status = self::LP_STATUS_IN_PROGRESS_NUM;
 
                     // completed?
                     $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
                     $required_visits = $status_info['visits'];
 
                     $re = ilChangeEvent::_lookupReadEvents(
                         $a_obj_id,
                         $a_usr_id
                     );
                     if (($re[0]['read_count'] ?? 0) >= $required_visits) {
                         $status = self::LP_STATUS_COMPLETED_NUM;
                     }
                 }
                 break;
         }
         return $status;
     }

Here is the call graph for this function:

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

Services/Tracking/classes/status/class.ilLPStatusVisits.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _getCompleted()

◆ _getInProgress()

◆ _getStatusInfo()

◆ determinePercentage()

◆ determineStatus()