Inheritance diagram for ilLPStatusObjectives:

Collaboration diagram for ilLPStatusObjectives:

Public Member Functions
	__construct ($a_obj_id)

	determineStatus ($a_obj_id, $a_user_id, $a_obj=null)
	Determine status. More...

Public Member Functions inherited from ilLPStatus
	__construct ($a_obj_id)

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

	determinePercentage ($a_obj_id, $a_usr_id, $a_obj=null)
	Determine percentage. More...

	determineStatus ($a_obj_id, $a_usr_id, $a_obj=null)
	Determine status. More...

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

Static Public Member Functions
static	_getNotAttempted ($a_obj_id)

static	_getInProgress ($a_obj_id)

static	_getCompleted ($a_obj_id)

static	_getFailed ($a_obj_id)

static	_getStatusInfo ($a_obj_id)

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

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

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

Static Public Member Functions inherited from ilLPStatus
static	_getCountNotAttempted ($a_obj_id)

static	_getNotAttempted ($a_obj_id)

static	_getCountInProgress ($a_obj_id)

static	_getInProgress ($a_obj_id)

static	_getCountCompleted ($a_obj_id)

static	_getCompleted ($a_obj_id)

static	_getFailed ($a_obj_id)

static	_getCountFailed ()

static	_getStatusInfo ($a_obj_id)

static	_getTypicalLearningTime ($a_obj_id)

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

static	writeStatus ($a_obj_id, $a_user_id, $a_status, $a_percentage=false, $a_force_per=false)
	Write status for user and object. More...

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

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

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

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

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

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

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

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

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

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

static	preloadListGUIData ($a_obj_ids)

static	getListGUIStatus ($a_obj_id, $a_image_only=false)

Static Protected Member Functions
static	getMembers ($a_obj_id)
	Get members for object. More...

Static Protected Member Functions inherited from ilLPStatus
static	raiseEvent ($a_obj_id, $a_usr_id, $a_status, $a_percentage)

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

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

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

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

Additional Inherited Members
Data Fields inherited from ilLPStatus
	$obj_id = null

	$db = null

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

Detailed Description

Definition at line 16 of file class.ilLPStatusObjectives.php.

Constructor & Destructor Documentation

◆ __construct()

ilLPStatusObjectives::__construct ( $a_obj_id )

Definition at line 18 of file class.ilLPStatusObjectives.php.

References $ilDB.

     {
         global $ilDB;
 
         parent::__construct($a_obj_id);
         $this->db = $ilDB;
     }

Member Function Documentation

◆ _getCompleted()

static ilLPStatusObjectives::_getCompleted ( $a_obj_id )

static

Definition at line 63 of file class.ilLPStatusObjectives.php.

References ilLPStatusWrapper\_getStatusInfo(), and array.

     {
         $objective_results = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
         $usr_ids = (array) $objective_results['user_status'][self::LP_STATUS_COMPLETED_NUM];
                 
         if ($usr_ids) {
             // Exclude all non members
             $usr_ids = array_intersect(self::getMembers($a_obj_id), (array) $usr_ids);
         }
         
         return $usr_ids ? $usr_ids : array();
     }

Here is the call graph for this function:

◆ _getFailed()

static ilLPStatusObjectives::_getFailed ( $a_obj_id )

static

Definition at line 76 of file class.ilLPStatusObjectives.php.

References ilLPStatusWrapper\_getStatusInfo(), and array.

     {
         $objective_results = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
         $usr_ids = (array) $objective_results['user_status'][self::LP_STATUS_FAILED_NUM];
         
         if ($usr_ids) {
             // Exclude all non members
             $usr_ids = array_intersect(self::getMembers($a_obj_id), (array) $usr_ids);
         }
         
         return $usr_ids ? $usr_ids : array();
     }

Here is the call graph for this function:

◆ _getInProgress()

static ilLPStatusObjectives::_getInProgress ( $a_obj_id )

static

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

References ilLPStatusWrapper\_getStatusInfo(), and array.

     {
         $objective_results = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
         $usr_ids = (array) $objective_results['user_status'][self::LP_STATUS_IN_PROGRESS_NUM];
         
         /* change_event is of no use when no objective has been tried yet
         include_once './Services/Tracking/classes/class.ilChangeEvent.php';
         $users = ilChangeEvent::lookupUsersInProgress($a_obj_id);
 
         // Exclude all users with status completed/failed.
         $users = array_diff((array) $users,ilLPStatusWrapper::_getCompleted($a_obj_id));
         $users = array_diff((array) $users,ilLPStatusWrapper::_getFailed($a_obj_id));
         */
         
         if ($usr_ids) {
             // Exclude all non members
             $usr_ids = array_intersect(self::getMembers($a_obj_id), (array) $usr_ids);
         }
         
         return $usr_ids ? $usr_ids : array();
     }

Here is the call graph for this function:

◆ _getNotAttempted()

static ilLPStatusObjectives::_getNotAttempted ( $a_obj_id )

static

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

References $users, ilLPStatusWrapper\_getCompleted(), ilLPStatusWrapper\_getFailed(), ilLPStatusWrapper\_getInProgress(), and array.

     {
         $users = array();
         
         $members = self::getMembers($a_obj_id);
         if ($members) {
             // diff in progress, completed and failed (use stored result in LPStatusWrapper)
             $users = array_diff((array) $members, ilLPStatusWrapper::_getInProgress($a_obj_id));
             $users = array_diff((array) $members, ilLPStatusWrapper::_getCompleted($a_obj_id));
             $users = array_diff((array) $members, ilLPStatusWrapper::_getFailed($a_obj_id));
         }
 
         return $users;
     }

Here is the call graph for this function:

◆ _getStatusInfo()

static ilLPStatusObjectives::_getStatusInfo ( $a_obj_id )

static

Definition at line 89 of file class.ilLPStatusObjectives.php.

References $ilDB, $in, $query, $res, $row, ilCourseObjective\_getObjectiveIds(), array, ilDBConstants\FETCHMODE_OBJECT, ilLOUserResults\getSummarizedObjectiveStatusForLP(), ilChangeEvent\lookupUsersInProgress(), and ilLPStatus\LP_STATUS_IN_PROGRESS_NUM.

     {
         global $ilDB;
 
         include_once 'Modules/Course/classes/class.ilCourseObjective.php';
 
         $status_info = array();
         $status_info['user_status'] = array();
         $status_info['objectives'] = ilCourseObjective::_getObjectiveIds($a_obj_id, true);
         $status_info['num_objectives'] = count($status_info['objectives']);
 
         if ($status_info['num_objectives']) {
             $in = $ilDB->in('objective_id', $status_info['objectives'], false, 'integer');
                         
             include_once "Modules/Course/classes/Objectives/class.ilLOUserResults.php";
             foreach (ilLOUserResults::getSummarizedObjectiveStatusForLP($a_obj_id, $status_info['objectives']) as $user_id => $user_status) {
                 $status_info['user_status'][$user_status][] = $user_id;
             }
             
             // change event should lead to "in progress" - see determineStatus()
             include_once("./Services/Tracking/classes/class.ilChangeEvent.php");
             foreach (ilChangeEvent::lookupUsersInProgress($a_obj_id) as $user_id) {
                 if (!is_array($status_info['user_status'][ilLPStatus::LP_STATUS_IN_PROGRESS_NUM]) ||
                     !in_array($user_id, $status_info['user_status'][ilLPStatus::LP_STATUS_IN_PROGRESS_NUM])) {
                     $status_info['user_status'][ilLPStatus::LP_STATUS_IN_PROGRESS_NUM][] = $user_id;
                 }
             }
             
             // Read title/description
             $query = "SELECT * FROM crs_objectives WHERE " . $in;
             $res = $ilDB->query($query);
             while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                 $status_info['objective_title'][$row->objective_id] = $row->title;
                 $status_info['objective_description'][$row->objective_id] = $row->description;
             }
         }
         
         return $status_info;
     }

Here is the call graph for this function:

◆ _lookupCompletedForObject()

static ilLPStatusObjectives::_lookupCompletedForObject	(	$a_obj_id,
		$a_user_ids = `null`
	)

static

Get completed users for object.

Parameters

int	$a_obj_id
array	$a_user_ids

Returns: array

Definition at line 194 of file class.ilLPStatusObjectives.php.

References array.

     {
         if (!$a_user_ids) {
             $a_user_ids = self::getMembers($a_obj_id);
             if (!$a_user_ids) {
                 return array();
             }
         }
         return self::_lookupStatusForObject($a_obj_id, self::LP_STATUS_COMPLETED_NUM, $a_user_ids);
     }

◆ _lookupFailedForObject()

static ilLPStatusObjectives::_lookupFailedForObject	(	$a_obj_id,
		$a_user_ids = `null`
	)

static

Get failed users for object.

Parameters

int	$a_obj_id
array	$a_user_ids

Returns: array

Definition at line 212 of file class.ilLPStatusObjectives.php.

References array.

     {
         return array();
     }

◆ _lookupInProgressForObject()

static ilLPStatusObjectives::_lookupInProgressForObject	(	$a_obj_id,
		$a_user_ids = `null`
	)

static

Get in progress users for object.

Parameters

int	$a_obj_id
array	$a_user_ids

Returns: array

Definition at line 224 of file class.ilLPStatusObjectives.php.

References array.

     {
         if (!$a_user_ids) {
             $a_user_ids = self::getMembers($a_obj_id);
             if (!$a_user_ids) {
                 return array();
             }
         }
         return self::_lookupStatusForObject($a_obj_id, self::LP_STATUS_IN_PROGRESS_NUM, $a_user_ids);
     }

◆ determineStatus()

ilLPStatusObjectives::determineStatus	(	$a_obj_id,
		$a_user_id,
		$a_obj = `null`
	)

Determine status.

Parameters

integer	object id
integer	user id
object	object (optional depends on object type)

Returns: integer status

Definition at line 137 of file class.ilLPStatusObjectives.php.

References $ilDB, ilCourseObjective\_getObjectiveIds(), ilLOUserResults\getSummarizedObjectiveStatusForLP(), and ilChangeEvent\hasAccessed().

     {
         global $ilObjDataCache, $ilDB;
     
         // the status completed depends on:
         // $status_info['num_objectives'] (ilLPStatusWrapper::_getStatusInfo($a_obj_id);)
         // - ilCourseObjective::_getObjectiveIds($a_obj_id);
         // - table crs_objectives manipulated in
         // - ilCourseObjective
         
         // $status_info['objective_result']  (ilLPStatusWrapper::_getStatusInfo($a_obj_id);)
         // table crs_objective_status (must not contain a dataset)
         // ilCourseObjectiveResult -> added ilLPStatusWrapper::_updateStatus()
     
         $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
         switch ($ilObjDataCache->lookupType($a_obj_id)) {
             case "crs":
                 include_once("./Services/Tracking/classes/class.ilChangeEvent.php");
                 if (ilChangeEvent::hasAccessed($a_obj_id, $a_user_id)) {
                     // an initial test (only) should also lead to "in progress"
                     $status = self::LP_STATUS_IN_PROGRESS_NUM;
 
                     include_once 'Modules/Course/classes/class.ilCourseObjective.php';
                     $objectives = ilCourseObjective::_getObjectiveIds($a_obj_id, true);
                     if ($objectives) {
                         // #14051 - getSummarizedObjectiveStatusForLP() might return null
                         include_once "Modules/Course/classes/Objectives/class.ilLOUserResults.php";
                         $objtv_status = ilLOUserResults::getSummarizedObjectiveStatusForLP($a_obj_id, $objectives, $a_user_id);
                         if ($objtv_status !== null) {
                             $status = $objtv_status;
                         }
                     }
                 }
                 break;
         }
         return $status;
     }

Here is the call graph for this function:

◆ getMembers()

static ilLPStatusObjectives::getMembers ( $a_obj_id )

staticprotected

Get members for object.

Parameters

int $a_obj_id

Returns: array

Definition at line 180 of file class.ilLPStatusObjectives.php.

References ilCourseParticipants\_getInstanceByObjId().

     {
         include_once 'Modules/Course/classes/class.ilCourseParticipants.php';
         $member_obj = ilCourseParticipants::_getInstanceByObjId($a_obj_id);
         return $member_obj->getMembers();
     }

Here is the call graph for this function:

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

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

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getCompleted()

◆ _getFailed()

◆ _getInProgress()

◆ _getNotAttempted()

◆ _getStatusInfo()

◆ _lookupCompletedForObject()

◆ _lookupFailedForObject()

◆ _lookupInProgressForObject()

◆ determineStatus()

◆ getMembers()