ILIAS  release_7 Revision v7.30-3-g800a261c036
ilLPStatusLtiOutcome Class Reference

Class ilLPStatusLtiOutcome. More...

+ Inheritance diagram for ilLPStatusLtiOutcome:
+ Collaboration diagram for ilLPStatusLtiOutcome:

Public Member Functions

 determineStatus ($a_obj_id, $a_usr_id, $a_obj=null)
 Determine status. More...
 
 determinePercentage ($a_obj_id, $a_usr_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...
 

Private Member Functions

 getLtiUserResult ($objId, $usrId)
 
 ensureObject ($objId, $object)
 

Static Private Attributes

static $userResultCache = array()
 

Additional Inherited Members

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

Member Function Documentation

◆ determinePercentage()

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

Determine percentage.

Parameters

return

Reimplemented from ilLPStatus.

Definition at line 63 of file class.ilLPStatusLtiOutcome.php.

64 {
65 $ltiResult = $this->getLtiUserResult($a_obj_id, $a_usr_id);
66
67 if ($ltiResult instanceof ilLTIConsumerResult) {
68 return $ltiResult->getResult() * 100;
69 }
70
71 return 0;
72 }

References getLtiUserResult().

+ Here is the call graph for this function:

◆ determineStatus()

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

Determine status.

Parameters

return

Reimplemented from ilLPStatus.

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

46 {
47 $ltiResult = $this->getLtiUserResult($a_obj_id, $a_usr_id);
48
49 if ($ltiResult instanceof ilLTIConsumerResult) {
50 $object = $this->ensureObject($a_obj_id, $a_obj);
51 $ltiMasteryScore = $object->getMasteryScore();
52
53 if ($ltiResult->getResult() >= $ltiMasteryScore) {
55 }
56
58 }
59
61 }
const LP_STATUS_COMPLETED_NUM
const LP_STATUS_IN_PROGRESS_NUM
const LP_STATUS_NOT_ATTEMPTED_NUM

References ensureObject(), getLtiUserResult(), 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:

◆ ensureObject()

ilLPStatusLtiOutcome::ensureObject (   $objId,
  $object 
)
private

Definition at line 36 of file class.ilLPStatusLtiOutcome.php.

37 {
38 if (!($object instanceof ilObjLTIConsumer)) {
40 }
41
42 return $object;
43 }
static getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
$objId
Definition: xapitoken.php:39

References $objId, and ilObjectFactory\getInstanceByObjId().

Referenced by determineStatus().

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

◆ getLtiUserResult()

ilLPStatusLtiOutcome::getLtiUserResult (   $objId,
  $usrId 
)
private
Parameters
$objId
$usrId
Returns
ilLTIConsumerResult

Definition at line 22 of file class.ilLPStatusLtiOutcome.php.

23 {
24 if (!isset(self::$userResultCache[$objId])) {
25 self::$userResultCache[$objId] = array();
26 }
27
28 if (!isset(self::$userResultCache[$objId][$usrId])) {
29 $ltiUserResult = ilLTIConsumerResult::getByKeys($objId, $usrId);
30 self::$userResultCache[$objId][$usrId] = $ltiUserResult;
31 }
32
33 return self::$userResultCache[$objId][$usrId];
34 }
static getByKeys($a_obj_id, $a_usr_id, $a_create=false)
Get a result by object and user key.

References $objId, and ilLTIConsumerResult\getByKeys().

Referenced by determinePercentage(), and determineStatus().

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

Field Documentation

◆ $userResultCache

ilLPStatusLtiOutcome::$userResultCache = array()
staticprivate

Definition at line 15 of file class.ilLPStatusLtiOutcome.php.


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