ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilLPStatusVisits Class Reference
+ Inheritance diagram for ilLPStatusVisits:
+ Collaboration diagram for ilLPStatusVisits:

Public Member Functions

 __construct ($a_obj_id)
 
 determineStatus ($a_obj_id, $a_user_id, $a_obj=null)
 Determine status. More...
 
 determinePercentage ($a_obj_id, $a_user_id, $a_obj=null)
 Determine percentage. 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 _getInProgress ($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)
 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)
 

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

Detailed Description

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilLPStatusVisits::__construct (   $a_obj_id)

Reimplemented from ilLPStatus.

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

19 {
20 global $ilDB;
21
22 parent::__construct($a_obj_id);
23 $this->db = $ilDB;
24 }
global $ilDB

References $ilDB.

Member Function Documentation

◆ _getCompleted()

static ilLPStatusVisits::_getCompleted (   $a_obj_id)
static

Reimplemented from ilLPStatus.

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

44 {
45 global $ilDB;
46
47 $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
48 $required_visits = $status_info['visits'];
49
50 include_once './Services/Tracking/classes/class.ilChangeEvent.php';
51 $all = ilChangeEvent::_lookupReadEvents($a_obj_id);
52 foreach ($all as $event) {
53 if ($event['read_count'] >= $required_visits) {
54 $user_ids[] = $event['usr_id'];
55 }
56 }
57 return $user_ids ? $user_ids : array();
58 }
static _lookupReadEvents($obj_id, $usr_id=null)
Reads all read events which occured on the object which happened after the last time the user caught ...
static _getStatusInfo($a_obj_id)
Reads informations about the object e.g test results, tlt, number of visits.

References $ilDB, ilLPStatusWrapper\_getStatusInfo(), and ilChangeEvent\_lookupReadEvents().

+ Here is the call graph for this function:

◆ _getInProgress()

static ilLPStatusVisits::_getInProgress (   $a_obj_id)
static

Reimplemented from ilLPStatus.

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

27 {
28 global $ilDB;
29
30 $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
31 $required_visits = $status_info['visits'];
32
33 include_once './Services/Tracking/classes/class.ilChangeEvent.php';
34 $all = ilChangeEvent::_lookupReadEvents($a_obj_id);
35 foreach ($all as $event) {
36 if ($event['read_count'] < $required_visits) {
37 $user_ids[] = $event['usr_id'];
38 }
39 }
40 return $user_ids ? $user_ids : array();
41 }

References $ilDB, ilLPStatusWrapper\_getStatusInfo(), and ilChangeEvent\_lookupReadEvents().

+ Here is the call graph for this function:

◆ _getStatusInfo()

static ilLPStatusVisits::_getStatusInfo (   $a_obj_id)
static

Reimplemented from ilLPStatus.

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

61 {
62 include_once 'Services/Tracking/classes/class.ilLPObjSettings.php';
63 $status_info['visits'] = ilLPObjSettings::_lookupVisits($a_obj_id);
64
65 return $status_info;
66 }
static _lookupVisits($a_obj_id)

References ilLPObjSettings\_lookupVisits().

+ Here is the call graph for this function:

◆ determinePercentage()

ilLPStatusVisits::determinePercentage (   $a_obj_id,
  $a_user_id,
  $a_obj = null 
)

Determine percentage.

Parameters
integerobject id
integeruser id
objectobject (optional depends on object type)
Returns
integer percentage

Reimplemented from ilLPStatus.

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

111 {
112 include_once 'Services/Tracking/classes/class.ilLPObjSettings.php';
113 $reqv = ilLPObjSettings::_lookupVisits($a_obj_id);
114
115 $re = ilChangeEvent::_lookupReadEvents($a_obj_id, $a_user_id);
116 $rc = (int) $re[0]["read_count"];
117
118 if ($reqv > 0) {
119 $per = min(100, 100 / $reqv * $rc);
120 } else {
121 $per = 100;
122 }
123
124 return $per;
125 }

References ilChangeEvent\_lookupReadEvents(), and ilLPObjSettings\_lookupVisits().

+ Here is the call graph for this function:

◆ determineStatus()

ilLPStatusVisits::determineStatus (   $a_obj_id,
  $a_user_id,
  $a_obj = null 
)

Determine status.

Parameters
integerobject id
integeruser id
objectobject (optional depends on object type)
Returns
integer status

Reimplemented from ilLPStatus.

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

77 {
78 global $ilObjDataCache, $ilDB;
79
81 switch ($ilObjDataCache->lookupType($a_obj_id)) {
82 case 'lm':
83 include_once './Services/Tracking/classes/class.ilChangeEvent.php';
84 if (ilChangeEvent::hasAccessed($a_obj_id, $a_user_id)) {
86
87 // completed?
88 $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
89 $required_visits = $status_info['visits'];
90
91 include_once './Services/Tracking/classes/class.ilChangeEvent.php';
92 $re = ilChangeEvent::_lookupReadEvents($a_obj_id, $a_user_id);
93 if ($re[0]['read_count'] >= $required_visits) {
95 }
96 }
97 break;
98 }
99 return $status;
100 }
static hasAccessed($a_obj_id, $a_usr_id)
Has accessed.
const LP_STATUS_COMPLETED_NUM
const LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM

References $ilDB, ilLPStatusWrapper\_getStatusInfo(), ilChangeEvent\_lookupReadEvents(), ilChangeEvent\hasAccessed(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

+ Here is the call graph for this function:

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