ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilLPStatusSCORMPackage Class Reference
+ Inheritance diagram for ilLPStatusSCORMPackage:
+ Collaboration diagram for ilLPStatusSCORMPackage:

Public Member Functions

 ilLPStatusSCORMPackage ($a_obj_id)
 
 _getInProgress ($a_obj_id)
 
 _getCompleted ($a_obj_id)
 
 _getFailed ($a_obj_id)
 
 _getStatusInfo ($a_obj_id)
 
 determineStatus ($a_obj_id, $a_user_id, $a_obj=null)
 Determine status. More...
 
 refreshStatus ($a_obj_id)
 
 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...
 

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

Detailed Description

Member Function Documentation

◆ _getCompleted()

ilLPStatusSCORMPackage::_getCompleted (   $a_obj_id)

Reimplemented from ilLPStatus.

Definition at line 52 of file class.ilLPStatusSCORMPackage.php.

53 {
54 $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
55 $users = $status_info['completed'];
56 return array_unique($users);
57 }
_getStatusInfo($a_obj_id)
Reads informations about the object e.g test results, tlt, number of visits.

References ilLPStatusWrapper\_getStatusInfo().

+ Here is the call graph for this function:

◆ _getFailed()

ilLPStatusSCORMPackage::_getFailed (   $a_obj_id)

Reimplemented from ilLPStatus.

Definition at line 59 of file class.ilLPStatusSCORMPackage.php.

60 {
61 $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
62 $users = $status_info['failed'];
63 return array_unique($users);
64 }

References ilLPStatusWrapper\_getStatusInfo().

+ Here is the call graph for this function:

◆ _getInProgress()

ilLPStatusSCORMPackage::_getInProgress (   $a_obj_id)

Reimplemented from ilLPStatus.

Definition at line 45 of file class.ilLPStatusSCORMPackage.php.

46 {
47 $status_info = ilLPStatusWrapper::_getStatusInfo($a_obj_id);
48 $users = $status_info['in_progress'];
49 return array_unique($users);
50 }

References ilLPStatusWrapper\_getStatusInfo().

+ Here is the call graph for this function:

◆ _getStatusInfo()

ilLPStatusSCORMPackage::_getStatusInfo (   $a_obj_id)

Reimplemented from ilLPStatus.

Definition at line 67 of file class.ilLPStatusSCORMPackage.php.

68 {
69 include_once './Modules/Scorm2004/classes/class.ilSCORM2004Tracking.php';
70 $status_info['subtype'] = "scorm2004";
72
73 $status_info['completed'] = $info['completed'];
74 $status_info['failed'] = $info['failed'];
75 $status_info['in_progress'] = $info['in_progress'];
76
77 return $status_info;
78 }
_getProgressInfo($a_obj_id)
Get overall scorm status.
$info
Definition: example_052.php:80

References $info, and ilSCORM2004Tracking\_getProgressInfo().

+ Here is the call graph for this function:

◆ determinePercentage()

ilLPStatusSCORMPackage::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 147 of file class.ilLPStatusSCORMPackage.php.

148 {
149 return null;//todo!
150 }

◆ determineStatus()

ilLPStatusSCORMPackage::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 88 of file class.ilLPStatusSCORMPackage.php.

89 {
90 global $ilObjDataCache, $ilDB, $ilLog;
91
92 include_once("./Modules/Scorm2004/classes/class.ilSCORM2004Tracking.php");
93 $scorm_status = ilSCORM2004Tracking::_getProgressInfoOfUser($a_obj_id, $a_user_id);
95 switch ($scorm_status)
96 {
97 case "in_progress":
99 break;
100 case "completed":
102 break;
103 case "failed":
105 break;
106 }
107
108 return $status;
109 }
const LP_STATUS_COMPLETED_NUM
const LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM
const LP_STATUS_FAILED_NUM
_getProgressInfoOfUser($a_obj_id, $a_user_id)
Get overall scorm status.
global $ilDB

References $ilDB, $ilLog, ilSCORM2004Tracking\_getProgressInfoOfUser(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_FAILED_NUM, ilLPStatus\LP_STATUS_IN_PROGRESS_NUM, and ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM.

+ Here is the call graph for this function:

◆ ilLPStatusSCORMPackage()

ilLPStatusSCORMPackage::ilLPStatusSCORMPackage (   $a_obj_id)

Definition at line 37 of file class.ilLPStatusSCORMPackage.php.

38 {
39 global $ilDB;
40
41 parent::ilLPStatus($a_obj_id);
42 $this->db =& $ilDB;
43 }

References $ilDB.

◆ refreshStatus()

ilLPStatusSCORMPackage::refreshStatus (   $a_obj_id)

Definition at line 111 of file class.ilLPStatusSCORMPackage.php.

112 {
113 parent::refreshStatus($a_obj_id);
114
115 include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
116 $in_progress = ilLPStatusWrapper::_getInProgress($a_obj_id);
117 $completed = ilLPStatusWrapper::_getCompleted($a_obj_id);
119 $all_active_users = array_unique(array_merge($in_progress, $completed, $failed));
120
121 // get all tracked users regardless of SCOs
122 include_once("./Modules/Scorm2004/classes/class.ilSCORM2004Tracking.php");
123 $all_tracked_users = ilSCORM2004Tracking::_getTrackedUsers($a_obj_id);
124
125 $not_attempted_users = array_diff($all_tracked_users, $all_active_users);
126 unset($all_tracked_users);
127 unset($all_active_users);
128
129 // reset all users which have no data for the current SCOs
130 if($not_attempted_users)
131 {
132 foreach($not_attempted_users as $usr_id)
133 {
134 // this will update any (parent) collections if necessary
135 ilLPStatus::writeStatus($a_obj_id, $usr_id, self::LP_STATUS_NOT_ATTEMPTED_NUM, 0);
136 }
137 }
138 }
$failed
Definition: Utf8Test.php:86
_getCompleted($a_obj_id)
Static function to read the users who have the status 'completed'.
_getFailed($a_obj_id)
Static function to read the users who have the status 'completed'.
_getInProgress($a_obj_id)
Static function to read users who have the status 'in_progress'.
static writeStatus($a_obj_id, $a_user_id, $a_status, $a_percentage=false, $a_force_per=false)
Write status for user and object.
_getTrackedUsers($a_obj_id)
Get all tracked users.

References $failed, ilLPStatusWrapper\_getCompleted(), ilLPStatusWrapper\_getFailed(), ilLPStatusWrapper\_getInProgress(), ilSCORM2004Tracking\_getTrackedUsers(), and ilLPStatus\writeStatus().

+ Here is the call graph for this function:

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