ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
Public Member Functions | Static Protected Member Functions
ilLPStatusPlugin Class Reference
+ Inheritance diagram for ilLPStatusPlugin:
+ Collaboration diagram for ilLPStatusPlugin:

Public Member Functions

 _getNotAttempted ($a_obj_id)
 
 _getInProgress ($a_obj_id)
 
 _getCompleted ($a_obj_id)
 
 _getFailed ($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
 ilLPStatus ($a_obj_id)
 
 _getCountNotAttempted ($a_obj_id)
 
 _getNotAttempted ($a_obj_id)
 
 _getCountInProgress ($a_obj_id)
 
 _getInProgress ($a_obj_id)
 
 _getCountCompleted ($a_obj_id)
 
 _getCompleted ($a_obj_id)
 
 _getFailed ($a_obj_id)
 
 _getCountFailed ()
 
 _getStatusInfo ($a_obj_id)
 
 _getTypicalLearningTime ($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...
 
 _lookupStatusChanged ($a_obj_id, $a_user_id)
 Lookup status changed. More...
 

Static Protected Member Functions

static initPluginObj ($a_obj_id)
 Get ilObjectPlugin for object id. More...
 
static getLPStatusData ($a_obj_id, $a_status)
 Read existing LP status data. More...
 
static getLPDataForUser ($a_obj_id, $a_user_id)
 Read existing LP status data for user. More...
 
static getPercentageForUser ($a_obj_id, $a_user_id)
 
- Static Protected Member Functions inherited from ilLPStatus
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

- Static Public Member Functions inherited from ilLPStatus
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 _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)
 
- 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
 
- Protected Member Functions inherited from ilLPStatus
 raiseEvent ($a_obj_id, $a_usr_id, $a_status, $a_percentage)
 

Detailed Description

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

Member Function Documentation

◆ _getCompleted()

ilLPStatusPlugin::_getCompleted (   $a_obj_id)

Reimplemented from ilLPStatus.

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

65 {
66 $plugin = self::initPluginObj($a_obj_id);
67 if($plugin)
68 {
69 if($plugin !== ilPluginLP::INACTIVE_PLUGIN)
70 {
71 return (array)$plugin->getLPCompleted();
72 }
73 else
74 {
75 // re-use existing data for inactive plugin
76 return self::getLPStatusData($a_obj_id, self::LP_STATUS_COMPLETED_NUM);
77 }
78 }
79 return array();
80 }
ilLPStatusPlugin\initPluginObj
static initPluginObj($a_obj_id)
Get ilObjectPlugin for object id.
Definition: class.ilLPStatusPlugin.php:21
ilLPStatusPlugin\getLPStatusData
static getLPStatusData($a_obj_id, $a_status)
Read existing LP status data.
Definition: class.ilLPStatusPlugin.php:146
ilPluginLP\INACTIVE_PLUGIN
const INACTIVE_PLUGIN
Definition: class.ilPluginLP.php:18

References getLPStatusData(), ilPluginLP\INACTIVE_PLUGIN, and initPluginObj().

+ Here is the call graph for this function:

◆ _getFailed()

ilLPStatusPlugin::_getFailed (   $a_obj_id)

Reimplemented from ilLPStatus.

Definition at line 82 of file class.ilLPStatusPlugin.php.

83 {
84 $plugin = self::initPluginObj($a_obj_id);
85 if($plugin)
86 {
87 if($plugin !== ilPluginLP::INACTIVE_PLUGIN)
88 {
89 return (array)$plugin->getLPFailed();
90 }
91 else
92 {
93 // re-use existing data for inactive plugin
94 return self::getLPStatusData($a_obj_id, self::LP_STATUS_FAILED_NUM);
95 }
96 }
97 return array();
98 }

References getLPStatusData(), ilPluginLP\INACTIVE_PLUGIN, and initPluginObj().

+ Here is the call graph for this function:

◆ _getInProgress()

ilLPStatusPlugin::_getInProgress (   $a_obj_id)

Reimplemented from ilLPStatus.

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

47 {
48 $plugin = self::initPluginObj($a_obj_id);
49 if($plugin)
50 {
51 if($plugin !== ilPluginLP::INACTIVE_PLUGIN)
52 {
53 return (array)$plugin->getLPInProgress();
54 }
55 else
56 {
57 // re-use existing data for inactive plugin
58 return self::getLPStatusData($a_obj_id, self::LP_STATUS_IN_PROGRESS_NUM);
59 }
60 }
61 return array();
62 }

References getLPStatusData(), ilPluginLP\INACTIVE_PLUGIN, and initPluginObj().

+ Here is the call graph for this function:

◆ _getNotAttempted()

ilLPStatusPlugin::_getNotAttempted (   $a_obj_id)

Reimplemented from ilLPStatus.

Definition at line 28 of file class.ilLPStatusPlugin.php.

29 {
30 $plugin = self::initPluginObj($a_obj_id);
31 if($plugin)
32 {
33 if($plugin !== ilPluginLP::INACTIVE_PLUGIN)
34 {
35 return (array)$plugin->getLPNotAttempted();
36 }
37 else
38 {
39 // re-use existing data for inactive plugin
40 return self::getLPStatusData($a_obj_id, self::LP_STATUS_NOT_ATTEMPTED_NUM);
41 }
42 }
43 return array();
44 }

References getLPStatusData(), ilPluginLP\INACTIVE_PLUGIN, and initPluginObj().

+ Here is the call graph for this function:

◆ determinePercentage()

ilLPStatusPlugin::determinePercentage (   $a_obj_id,
  $a_usr_id,
  $a_obj = null 
)

Determine percentage.

Parameters

return

Reimplemented from ilLPStatus.

Definition at line 120 of file class.ilLPStatusPlugin.php.

121 {
122 $plugin = self::initPluginObj($a_obj_id);
123 if($plugin)
124 {
125 if($plugin !== ilPluginLP::INACTIVE_PLUGIN)
126 {
127 if (method_exists($plugin, "getPercentageForUser"))
128 {
129 return $plugin->getPercentageForUser($a_user_id);
130 }
131 }
132 // re-use existing data for inactive plugin
133 return self::getPercentageForUser($a_obj_id, $a_user_id);
134 }
135 // #11368
136 return 0;
137 }
ilLPStatusPlugin\getPercentageForUser
static getPercentageForUser($a_obj_id, $a_user_id)
Definition: class.ilLPStatusPlugin.php:187

References getPercentageForUser(), ilPluginLP\INACTIVE_PLUGIN, and initPluginObj().

+ Here is the call graph for this function:

◆ determineStatus()

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

Determine status.

Parameters

return

Reimplemented from ilLPStatus.

Definition at line 100 of file class.ilLPStatusPlugin.php.

101 {
102 $plugin = self::initPluginObj($a_obj_id);
103 if($plugin)
104 {
105 if($plugin !== ilPluginLP::INACTIVE_PLUGIN)
106 {
107 // :TODO: create read_event here to make sure?
108 return $plugin->getLPStatusForUser($a_user_id);
109 }
110 else
111 {
112 // re-use existing data for inactive plugin
113 return self::getLPDataForUser($a_obj_id, $a_user_id);
114 }
115 }
116 // #11368
117 return self::LP_STATUS_NOT_ATTEMPTED_NUM;
118 }
ilLPStatusPlugin\getLPDataForUser
static getLPDataForUser($a_obj_id, $a_user_id)
Read existing LP status data for user.
Definition: class.ilLPStatusPlugin.php:170
ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM
Definition: class.ilLPStatus.php:28

References getLPDataForUser(), ilPluginLP\INACTIVE_PLUGIN, initPluginObj(), and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

+ Here is the call graph for this function:

◆ getLPDataForUser()

static ilLPStatusPlugin::getLPDataForUser (   $a_obj_id,
  $a_user_id 
)
staticprotected

Read existing LP status data for user.

Parameters
int$a_obj_id
int$a_user_id
Returns
int

Definition at line 170 of file class.ilLPStatusPlugin.php.

171 {
172 global $ilDB;
173
174 $set = $ilDB->query("SELECT status".
175 " FROM ut_lp_marks".
176 " WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer").
177 " AND usr_id = ".$ilDB->quote($a_user_id, "integer"));
178 $row = $ilDB->fetchAssoc($set);
179 $status = $row["status"];
180 if(!$status)
181 {
182 $status = self::LP_STATUS_NOT_ATTEMPTED_NUM;
183 }
184 return $status;
185 }
$ilDB
global $ilDB
Definition: storeScorm2004.php:19

References $ilDB, $row, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

Referenced by determineStatus().

+ Here is the caller graph for this function:

◆ getLPStatusData()

static ilLPStatusPlugin::getLPStatusData (   $a_obj_id,
  $a_status 
)
staticprotected

Read existing LP status data.

Parameters
int$a_obj_id
int$a_status
Returns
array user ids

Definition at line 146 of file class.ilLPStatusPlugin.php.

147 {
148 global $ilDB;
149
150 $all = array();
151
152 $set = $ilDB->query("SELECT usr_id".
153 " FROM ut_lp_marks".
154 " WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer").
155 " AND status = ".$ilDB->quote($a_status, "integer"));
156 while($row = $ilDB->fetchAssoc($set))
157 {
158 $all[] = $row["usr_id"];
159 }
160 return $all;
161 }

References $ilDB, and $row.

Referenced by _getCompleted(), _getFailed(), _getInProgress(), and _getNotAttempted().

+ Here is the caller graph for this function:

◆ getPercentageForUser()

static ilLPStatusPlugin::getPercentageForUser (   $a_obj_id,
  $a_user_id 
)
staticprotected

Definition at line 187 of file class.ilLPStatusPlugin.php.

188 {
189 global $ilDB;
190
191 $set = $ilDB->query("SELECT percentage".
192 " FROM ut_lp_marks".
193 " WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer").
194 " AND usr_id = ".$ilDB->quote($a_user_id, "integer"));
195 $row = $ilDB->fetchAssoc($set);
196 return (int) $row["percentage"];
197 }

References $ilDB, and $row.

Referenced by determinePercentage().

+ Here is the caller graph for this function:

◆ initPluginObj()

static ilLPStatusPlugin::initPluginObj (   $a_obj_id)
staticprotected

Get ilObjectPlugin for object id.

Parameters
int$a_obj_id
Returns
ilObjectPlugin

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

22 {
23 include_once "Services/Object/classes/class.ilObjectLP.php";
24 $olp = ilObjectLP::getInstance($a_obj_id);
25 return $olp->getPluginInstance();
26 }
ilObjectLP\getInstance
static getInstance($a_obj_id)
Definition: class.ilObjectLP.php:25

References ilObjectLP\getInstance().

Referenced by _getCompleted(), _getFailed(), _getInProgress(), _getNotAttempted(), determinePercentage(), and determineStatus().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:
The documentation for this class was generated from the following file: