ILIAS  release_7 Revision v7.30-3-g800a261c036
Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes
ilLPStatusCourseReference Class Reference

Class ilLPStatusCourseReference. More...

+ Inheritance diagram for ilLPStatusCourseReference:
+ Collaboration diagram for ilLPStatusCourseReference:

Public Member Functions

 __construct ($a_obj_id)
 ilLPStatusCourseReference constructor. More...
 
 getNotAttempted ()
 
 getInProgress ()
 
 getCompleted ()
 
 getStatusInfo ()
 
 readStatusInfo ($a_obj_id)
 
 determineStatus ($a_obj_id, $a_usr_id, $a_obj=null)
 Determine status.
Parameters

return 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 _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 _getStatusInfo ($a_obj_id)
 
- 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, &$a_old_status=self::LP_STATUS_NOT_ATTEMPTED_NUM)
 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=true)
 

Private Member Functions

 readTargetObjId ($a_obj_id)
 

Static Private Member Functions

static getInstanceByObjId ($a_reference_obj_id)
 

Private Attributes

 $logger = null
 
 $target_obj_id = 0
 
 $status_info = []
 

Static Private Attributes

static $instances = []
 

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 ($a_obj_id, $a_usr_id, $a_status, $a_old_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...
 
- Protected Attributes inherited from ilLPStatus
 $obj_id = null
 
 $db = null
 

Detailed Description

Class ilLPStatusCourseReference.

Author
Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 8 of file class.ilLPStatusCourseReference.php.

Constructor & Destructor Documentation

◆ __construct()

ilLPStatusCourseReference::__construct (   $a_obj_id)

ilLPStatusCourseReference constructor.

Parameters
int$a_obj_id

Reimplemented from ilLPStatus.

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

33 {
34 global $DIC;
35
36 $this->logger = $DIC->logger()->trac();
37
38 parent::__construct($a_obj_id);
39 $this->readTargetObjId($a_obj_id);
40 $this->readStatusInfo($a_obj_id);
41 }
$DIC
global $DIC
Definition: goto.php:24
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
Definition: PluginProviderHelper.php:40

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), readStatusInfo(), and readTargetObjId().

+ Here is the call graph for this function:

Member Function Documentation

◆ _getCompleted()

static ilLPStatusCourseReference::_getCompleted (   $a_obj_id)
static

Reimplemented from ilLPStatus.

Definition at line 107 of file class.ilLPStatusCourseReference.php.

108 {
109 $self = self::getInstanceByObjId($a_obj_id);
110 return $self->getCompleted();
111 }
ilLPStatusCourseReference\getInstanceByObjId
static getInstanceByObjId($a_reference_obj_id)
Definition: class.ilLPStatusCourseReference.php:180

References getInstanceByObjId().

+ Here is the call graph for this function:

◆ _getCountCompleted()

static ilLPStatusCourseReference::_getCountCompleted (   $a_obj_id)
static

Reimplemented from ilLPStatus.

Definition at line 98 of file class.ilLPStatusCourseReference.php.

99 {
100 $self = self::getInstanceByObjId($a_obj_id);
101 return count($self->getCompleted());
102 }

References getInstanceByObjId().

+ Here is the call graph for this function:

◆ _getCountInProgress()

static ilLPStatusCourseReference::_getCountInProgress (   $a_obj_id)
static

Reimplemented from ilLPStatus.

Definition at line 72 of file class.ilLPStatusCourseReference.php.

73 {
74 $self = self::getInstanceByObjId($a_obj_id);
75 return count($self->getInProgress());
76 }

References getInstanceByObjId().

+ Here is the call graph for this function:

◆ _getCountNotAttempted()

static ilLPStatusCourseReference::_getCountNotAttempted (   $a_obj_id)
static

Reimplemented from ilLPStatus.

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

47 {
48 $self = self::getInstanceByObjId($a_obj_id);
49 return count($self->getNotAttempted());
50 }

References getInstanceByObjId().

+ Here is the call graph for this function:

◆ _getInProgress()

static ilLPStatusCourseReference::_getInProgress (   $a_obj_id)
static

Reimplemented from ilLPStatus.

Definition at line 81 of file class.ilLPStatusCourseReference.php.

82 {
83 $self = self::getInstanceByObjId($a_obj_id);
84 return $self->getInProgress();
85 }

References getInstanceByObjId().

+ Here is the call graph for this function:

◆ _getNotAttempted()

static ilLPStatusCourseReference::_getNotAttempted (   $a_obj_id)
static

Reimplemented from ilLPStatus.

Definition at line 55 of file class.ilLPStatusCourseReference.php.

56 {
57 $self = self::getInstanceByObjId($a_obj_id);
58 return $self->getNotAttempted();
59 }

References getInstanceByObjId().

+ Here is the call graph for this function:

◆ _getStatusInfo()

static ilLPStatusCourseReference::_getStatusInfo (   $a_obj_id)
static

Reimplemented from ilLPStatus.

Definition at line 125 of file class.ilLPStatusCourseReference.php.

126 {
127 $self = self::getInstanceByObjId($a_obj_id);
128 return $self->getStatusInfo();
129 }

References getInstanceByObjId().

+ Here is the call graph for this function:

◆ determineStatus()

ilLPStatusCourseReference::determineStatus (   $a_obj_id,
  $a_usr_id,
  $a_obj = null 
)

Determine status.

Parameters

return

Reimplemented from ilLPStatus.

Definition at line 166 of file class.ilLPStatusCourseReference.php.

167 {
168 $status = \ilLPStatus::_lookupStatus($this->target_obj_id, $a_usr_id, false);
169 if ($status) {
170 return $status;
171 }
172 return \ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
173 }
ilLPStatus\_lookupStatus
static _lookupStatus($a_obj_id, $a_user_id, $a_create=true)
Lookup status.
Definition: class.ilLPStatus.php:573

References ilLPStatus\_lookupStatus().

+ Here is the call graph for this function:

◆ getCompleted()

ilLPStatusCourseReference::getCompleted ( )
Returns
int[]

Definition at line 116 of file class.ilLPStatusCourseReference.php.

117 {
118 return $this->status_info[\ilLPStatus::LP_STATUS_COMPLETED_NUM];
119 }
ilLPStatus\LP_STATUS_COMPLETED_NUM
const LP_STATUS_COMPLETED_NUM
Definition: class.ilLPStatus.php:30

References ilLPStatus\LP_STATUS_COMPLETED_NUM.

◆ getInProgress()

ilLPStatusCourseReference::getInProgress ( )
Returns
int[]

Definition at line 90 of file class.ilLPStatusCourseReference.php.

91 {
92 return $this->status_info[\ilLPStatus::LP_STATUS_IN_PROGRESS_NUM];
93 }
ilLPStatus\LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_IN_PROGRESS_NUM
Definition: class.ilLPStatus.php:29

References ilLPStatus\LP_STATUS_IN_PROGRESS_NUM.

◆ getInstanceByObjId()

static ilLPStatusCourseReference::getInstanceByObjId (   $a_reference_obj_id)
staticprivate
Parameters
$a_reference_obj_id
Returns
\ilLPStatusCourseReference

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

181 {
182 if (!isset(self::$instances[$a_reference_obj_id])) {
183 self::$instances[$a_reference_obj_id] = new self($a_reference_obj_id);
184 }
185 return self::$instances[$a_reference_obj_id];
186 }

Referenced by _getCompleted(), _getCountCompleted(), _getCountInProgress(), _getCountNotAttempted(), _getInProgress(), _getNotAttempted(), and _getStatusInfo().

+ Here is the caller graph for this function:

◆ getNotAttempted()

ilLPStatusCourseReference::getNotAttempted ( )
Returns
int[]

Definition at line 64 of file class.ilLPStatusCourseReference.php.

65 {
66 return $this->status_info[\ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM];
67 }
ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM
Definition: class.ilLPStatus.php:28

References ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

◆ getStatusInfo()

ilLPStatusCourseReference::getStatusInfo ( )

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

132 {
133 return $this->status_info;
134 }

References $status_info.

◆ readStatusInfo()

ilLPStatusCourseReference::readStatusInfo (   $a_obj_id)

Definition at line 139 of file class.ilLPStatusCourseReference.php.

140 {
141 global $DIC;
142
143 $database = $DIC->database();
144 $query = 'select status,usr_id from ut_lp_marks ' .
145 'where obj_id = ' . $database->quote($this->target_obj_id, \ilDBConstants::T_INTEGER);
146 $res = $database->query($query);
147
148 $info = [
149 \ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM => [],
150 \ilLPStatus::LP_STATUS_IN_PROGRESS_NUM => [],
151 \ilLPStatus::LP_STATUS_COMPLETED_NUM => [],
152 \ilLPStatus::LP_STATUS_FAILED_NUM => []
153 ];
154 while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
155 if (array_key_exists((int) $row->status, $info)) {
156 $info[(int) $row->status][] = (int) $row->usr_id;
157 }
158 }
159 $this->status_info = $info;
160 }
ilLPStatus\LP_STATUS_FAILED_NUM
const LP_STATUS_FAILED_NUM
Definition: class.ilLPStatus.php:31
$query
$query
Definition: proxy_ylocal.php:13
$res
foreach($_POST as $key=> $value) $res
Definition: save_question_post_data.php:15

References $DIC, $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, and ilDBConstants\T_INTEGER.

Referenced by __construct().

+ Here is the caller graph for this function:

◆ readTargetObjId()

ilLPStatusCourseReference::readTargetObjId (   $a_obj_id)
private
Parameters
$a_obj_id

Definition at line 191 of file class.ilLPStatusCourseReference.php.

192 {
193 $this->target_obj_id = ilObject::_lookupObjId(ilObjCourseReference::_lookupTargetRefId($a_obj_id));
194 }
ilContainerReference\_lookupTargetRefId
static _lookupTargetRefId($a_obj_id)
Lookup target ref_id.
Definition: class.ilContainerReference.php:95
ilObject\_lookupObjId
static _lookupObjId($a_id)
Definition: class.ilObject.php:1110

References ilObject\_lookupObjId(), and ilContainerReference\_lookupTargetRefId().

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $instances

ilLPStatusCourseReference::$instances = []
staticprivate

Definition at line 13 of file class.ilLPStatusCourseReference.php.

◆ $logger

ilLPStatusCourseReference::$logger = null
private

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

◆ $status_info

ilLPStatusCourseReference::$status_info = []
private

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

Referenced by getStatusInfo().

◆ $target_obj_id

ilLPStatusCourseReference::$target_obj_id = 0
private

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

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