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

Inheritance diagram for ilLPStatusStudyProgramme:

Collaboration diagram for ilLPStatusStudyProgramme:

Public Member Functions
	determineStatus ($a_obj_id, $a_user_id, $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	_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 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)

Static Protected Member Functions
static	getAssignments (int $obj_id, int $usr_id=null)

static	getStatusForAssignments (array $assignments, int $prg_obj_id)

static	getAssignmentsLPMatrix (array $assignments, int $prg_obj_id)

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...

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

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

Definition at line 21 of file class.ilLPStatusStudyProgramme.php.

Member Function Documentation

◆ _getCompleted()

static ilLPStatusStudyProgramme::_getCompleted ( $a_obj_id )

static

Definition at line 117 of file class.ilLPStatusStudyProgramme.php.

References ilLPStatus\LP_STATUS_COMPLETED_NUM.

                                                    : array
     {
         $assignments = self::getAssignments((int) $a_obj_id);
         $matrix = self::getAssignmentsLPMatrix($assignments, (int) $a_obj_id);
         return $matrix[ilLPStatus::LP_STATUS_COMPLETED_NUM];
     }

◆ _getCountCompleted()

static ilLPStatusStudyProgramme::_getCountCompleted ( $a_obj_id )

static

Definition at line 112 of file class.ilLPStatusStudyProgramme.php.

                                                         : int
     {
         return count(self::_getCompleted($a_obj_id));
     }

◆ _getCountInProgress()

static ilLPStatusStudyProgramme::_getCountInProgress ( $a_obj_id )

static

Definition at line 99 of file class.ilLPStatusStudyProgramme.php.

                                                          : int
     {
         throw new \Exception('called');
         return count(self::_getInProgress($a_obj_id));
     }

◆ _getFailed()

static ilLPStatusStudyProgramme::_getFailed ( $a_obj_id )

static

Definition at line 124 of file class.ilLPStatusStudyProgramme.php.

References ilLPStatus\LP_STATUS_FAILED_NUM.

                                                 : array
     {
         $assignments = self::getAssignments((int) $a_obj_id);
         $matrix = self::getAssignmentsLPMatrix($assignments, (int) $a_obj_id);
         return $matrix[ilLPStatus::LP_STATUS_FAILED_NUM];
     }

◆ _getInProgress()

static ilLPStatusStudyProgramme::_getInProgress ( $a_obj_id )

static

Definition at line 105 of file class.ilLPStatusStudyProgramme.php.

References ilLPStatus\LP_STATUS_IN_PROGRESS_NUM.

                                                     : array
     {
         $assignments = self::getAssignments((int) $a_obj_id);
         $matrix = self::getAssignmentsLPMatrix($assignments, (int) $a_obj_id);
         return $matrix[ilLPStatus::LP_STATUS_IN_PROGRESS_NUM];
     }

◆ determineStatus()

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

Definition at line 131 of file class.ilLPStatusStudyProgramme.php.

                                                                          : int
     {
         $assignments = self::getAssignments((int) $a_obj_id, (int) $a_user_id);
         return self::getStatusForAssignments($assignments, (int) $a_obj_id);
     }

◆ getAssignments()

static ilLPStatusStudyProgramme::getAssignments	(	int	$obj_id,
		int	$usr_id = `null`
	)

staticprotected

Definition at line 23 of file class.ilLPStatusStudyProgramme.php.

References $dic, and ilStudyProgrammeDIC\dic().

                                                                              : array
     {
         $dic = ilStudyProgrammeDIC::dic();
         $repo = $dic['repo.assignment'];
 
         if ($usr_id) {
             $usr_id = [$usr_id];
         }
         $assignments = $repo->getAllForNodeIsContained((int) $obj_id, $usr_id);
 
         //restarted assignments will lose validity for LPStatus
         $assignments = array_filter($assignments, fn ($ass) => !$ass->isRestarted());
 
         return $assignments;
     }

Here is the call graph for this function:

◆ getAssignmentsLPMatrix()

static ilLPStatusStudyProgramme::getAssignmentsLPMatrix	(	array	$assignments,
		int	$prg_obj_id
	)

staticprotected

Parameters

ilPRGAssignment[] $assignments

Definition at line 74 of file class.ilLPStatusStudyProgramme.php.

References ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

                                                                                          : array
     {
         $matrix = [
             ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM => [],
             ilLPStatus::LP_STATUS_IN_PROGRESS_NUM => [],
             ilLPStatus::LP_STATUS_COMPLETED_NUM => [],
             ilLPStatus::LP_STATUS_FAILED_NUM => []
         ];
 
         $user_centric = [];
         foreach ($assignments as $ass) {
             $usr_id = $ass->getUserId();
             if (!array_key_exists($usr_id, $user_centric)) {
                 $user_centric[$usr_id] = [];
             }
             $user_centric[$usr_id][] = $ass;
         }
         foreach ($user_centric as $usr_id => $assignments) {
             $status = self::getStatusForAssignments($assignments, $prg_obj_id);
             $matrix[$status][] = $usr_id;
         }
 
         return $matrix;
     }

◆ getStatusForAssignments()

static ilLPStatusStudyProgramme::getStatusForAssignments	(	array	$assignments,
		int	$prg_obj_id
	)

staticprotected

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

References ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

                                                                                           : int
     {
         $now = new DateTimeImmutable();
         $pgss = [];
         foreach ($assignments as $ass) {
             $pgs = $ass->getProgressForNode($prg_obj_id);
             $pgss[$ass->getId()] = $pgs;
         }
 
         //use the highest assignment first
         sort($pgss);
         $pgss = array_reverse($pgss);
         $pgs = reset($pgss);
 
         if (!$pgs || !$pgs->isRelevant()) {
             return ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
         }
 
         if ($pgs->hasValidQualification($now)) {
             return ilLPStatus::LP_STATUS_COMPLETED_NUM;
         }
 
         //successful, but expired
         //or failed
         if ($pgs->isSuccessful() || $pgs->isFailed()) {
             return ilLPStatus::LP_STATUS_FAILED_NUM;
         }
 
         return ilLPStatus::LP_STATUS_IN_PROGRESS_NUM;
     }

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

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

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _getCompleted()

◆ _getCountCompleted()

◆ _getCountInProgress()

◆ _getFailed()

◆ _getInProgress()

◆ determineStatus()

◆ getAssignments()

◆ getAssignmentsLPMatrix()

◆ getStatusForAssignments()