ILIAS  release_7 Revision v7.30-3-g800a261c036
Public Member Functions | Protected Member Functions | Protected Attributes
ilXapiStatementEvaluation Class Reference
+ Collaboration diagram for ilXapiStatementEvaluation:

Public Member Functions

 __construct (ilLogger $log, ilObjCmiXapi $object)
 ilXapiStatementEvaluation constructor. More...
 
 evaluateReport (ilCmiXapiStatementsReport $report)
 
 getCmixUser ($xapiStatement)
 
 evaluateStatement ($xapiStatement, $usrId)
 

Protected Member Functions

 isValidXapiStatement ($xapiStatement)
 
 isValidObject ($xapiStatement)
 
 getXapiVerb ($xapiStatement)
 
 getResultStatusForXapiVerb ($xapiVerb)
 
 hasResultStatusRelevantXapiVerb ($xapiVerb)
 
 getResultProgressForXapiVerb ($xapiVerb)
 
 hasResultProgressRelevantXapiVerb ($xapiVerb)
 
 hasXapiScore ($xapiStatement)
 
 getXapiScore ($xapiStatement)
 
 getProgressedScore ($xapiStatement)
 
 getUserResult ($usrId)
 
 isResultStatusToBeReplaced ($oldResultStatus, $newResultStatus)
 
 isLpModeInterestedInResultStatus ($resultStatus, $deactivated=true)
 
 doesNewResultStatusDominateOldOne ($oldResultStatus, $newResultStatus)
 
 needsAvoidFailedEvaluation ($oldResultStatus, $newResultStatus)
 
 sendSatisfiedStatement ($cmixUser)
 

Protected Attributes

 $resultStatusByXapiVerbMap
 
 $resultProgressByXapiVerbMap
 
 $object
 
 $log
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilXapiStatementEvaluation::__construct ( ilLogger  $log,
ilObjCmiXapi  $object 
)

ilXapiStatementEvaluation constructor.

Parameters
ilLogger$log
ilObjCmiXapi$object

Definition at line 49 of file class.ilXapiStatementEvaluation.php.

50 {
51 $this->log = $log;
52 $this->object = $object;
53
54 $objLP = ilObjectLP::getInstance($this->object->getId());
55 $this->lpMode = $objLP->getCurrentMode();
56 }
ilObjectLP\getInstance
static getInstance($a_obj_id)
Definition: class.ilObjectLP.php:45

References $log, $object, and ilObjectLP\getInstance().

+ Here is the call graph for this function:

Member Function Documentation

◆ doesNewResultStatusDominateOldOne()

ilXapiStatementEvaluation::doesNewResultStatusDominateOldOne (   $oldResultStatus,
  $newResultStatus 
)
protected

Definition at line 310 of file class.ilXapiStatementEvaluation.php.

311 {
312 if ($oldResultStatus == '') {
313 return true;
314 }
315
316 if (in_array($newResultStatus, ['passed', 'failed'])) {
317 return true;
318 }
319
320 if (!in_array($oldResultStatus, ['passed', 'failed'])) {
321 return true;
322 }
323
324 return false;
325 }

◆ evaluateReport()

ilXapiStatementEvaluation::evaluateReport ( ilCmiXapiStatementsReport  $report)

Definition at line 58 of file class.ilXapiStatementEvaluation.php.

59 {
60 foreach ($report->getStatements() as $xapiStatement) {
61 #$this->log->debug(
62 # "handle statement:\n".json_encode($xapiStatement, JSON_PRETTY_PRINT)
63 #);
64
65 // ensure json decoded non assoc
66 $xapiStatement = json_decode(json_encode($xapiStatement));
67 $cmixUser = $this->getCmixUser($xapiStatement);
68
69 $this->evaluateStatement($xapiStatement, $cmixUser->getUsrId());
70
71 $this->log->debug('update lp for object (' . $this->object->getId() . ')');
72 if ($cmixUser->getUsrId() != ANONYMOUS_USER_ID) {
73 ilLPStatusWrapper::_updateStatus($this->object->getId(), $cmixUser->getUsrId());
74 }
75 }
76 }
ilLPStatusWrapper\_updateStatus
static _updateStatus($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_force_raise=false)
Update status.
Definition: class.ilLPStatusWrapper.php:265
ANONYMOUS_USER_ID
const ANONYMOUS_USER_ID
Definition: constants.php:25

References ilLPStatusWrapper\_updateStatus(), ANONYMOUS_USER_ID, evaluateStatement(), getCmixUser(), and ilCmiXapiStatementsReport\getStatements().

+ Here is the call graph for this function:

◆ evaluateStatement()

ilXapiStatementEvaluation::evaluateStatement (   $xapiStatement,
  $usrId 
)

Definition at line 95 of file class.ilXapiStatementEvaluation.php.

96 {
97 global $DIC;
98 $xapiVerb = $this->getXapiVerb($xapiStatement);
99
100 if ($this->isValidXapiStatement($xapiStatement)) {
101 // result status and if exists scaled score
102 if ($this->hasResultStatusRelevantXapiVerb($xapiVerb)) {
103 if (!$this->isValidObject($xapiStatement)) {
104 return;
105 }
106 $userResult = $this->getUserResult($usrId);
107
108 $oldResultStatus = $userResult->getStatus();
109 $newResultStatus = $this->getResultStatusForXapiVerb($xapiVerb);
110
111 // this is for both xapi and cmi5
112 if ($this->isResultStatusToBeReplaced($oldResultStatus, $newResultStatus)) {
113 $this->log->debug("isResultStatusToBeReplaced: true");
114 $userResult->setStatus($newResultStatus);
115 }
116
117 if ($this->hasXapiScore($xapiStatement)) {
118 $xapiScore = $this->getXapiScore($xapiStatement);
119 $this->log->debug("Score: " . $xapiScore);
120 $userResult->setScore((float) $xapiScore);
121 }
122 $userResult->save();
123
124 // only cmi5
125 if ($this->object->getContentType() == ilObjCmiXapi::CONT_TYPE_CMI5) {
126 if (($xapiVerb == ilCmiXapiVerbList::COMPLETED || $xapiVerb == ilCmiXapiVerbList::PASSED) && $this->isLpModeInterestedInResultStatus($newResultStatus, false)) {
127 // it is possible to check against authToken usrId!
128 $cmixUser = $this->getCmixUser($xapiStatement);
129 $cmixUser->setSatisfied(true);
130 $cmixUser->save();
131 $this->sendSatisfiedStatement($cmixUser);
132 }
133 }
134 }
135 // result progress (i think only cmi5 relevant)
136 if ($this->hasResultProgressRelevantXapiVerb($xapiVerb)) {
137 $userResult = $this->getUserResult($usrId);
138 $progressedScore = $this->getProgressedScore($xapiStatement);
139 if ($progressedScore !== false && (float) $progressedScore > 0) {
140 $userResult->setScore((float) ($progressedScore / 100));
141 $userResult->save();
142 }
143 }
144 }
145 }
ilXapiStatementEvaluation\isResultStatusToBeReplaced
isResultStatusToBeReplaced($oldResultStatus, $newResultStatus)
Definition: class.ilXapiStatementEvaluation.php:253
ilXapiStatementEvaluation\isLpModeInterestedInResultStatus
isLpModeInterestedInResultStatus($resultStatus, $deactivated=true)
Definition: class.ilXapiStatementEvaluation.php:273
$DIC
global $DIC
Definition: goto.php:24

References $DIC, ilCmiXapiVerbList\COMPLETED, ilObjCmiXapi\CONT_TYPE_CMI5, getCmixUser(), getProgressedScore(), getResultStatusForXapiVerb(), getUserResult(), getXapiScore(), getXapiVerb(), hasResultProgressRelevantXapiVerb(), hasResultStatusRelevantXapiVerb(), hasXapiScore(), isLpModeInterestedInResultStatus(), isResultStatusToBeReplaced(), isValidObject(), isValidXapiStatement(), ilCmiXapiVerbList\PASSED, and sendSatisfiedStatement().

Referenced by evaluateReport().

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

◆ getCmixUser()

ilXapiStatementEvaluation::getCmixUser (   $xapiStatement)

Definition at line 78 of file class.ilXapiStatementEvaluation.php.

79 {
80 $cmixUser = null;
81 if ($this->object->getContentType() == ilObjCmiXapi::CONT_TYPE_CMI5) {
82 $cmixUser = ilCmiXapiUser::getInstanceByObjectIdAndUsrIdent(
83 $this->object->getId(),
84 $xapiStatement->actor->account->name
85 );
86 } else {
87 $cmixUser = ilCmiXapiUser::getInstanceByObjectIdAndUsrIdent(
88 $this->object->getId(),
89 str_replace('mailto:', '', $xapiStatement->actor->mbox)
90 );
91 }
92 return $cmixUser;
93 }
ilCmiXapiUser\getInstanceByObjectIdAndUsrIdent
static getInstanceByObjectIdAndUsrIdent($objId, $usrIdent)
Definition: class.ilCmiXapiUser.php:287

References ilObjCmiXapi\CONT_TYPE_CMI5, and ilCmiXapiUser\getInstanceByObjectIdAndUsrIdent().

Referenced by evaluateReport(), and evaluateStatement().

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

◆ getProgressedScore()

ilXapiStatementEvaluation::getProgressedScore (   $xapiStatement)
protected

Definition at line 224 of file class.ilXapiStatementEvaluation.php.

225 {
226 if (!isset($xapiStatement->result)) {
227 return false;
228 }
229
230 if (!isset($xapiStatement->result->extensions)) {
231 return false;
232 }
233
234 if (!isset($xapiStatement->result->extensions->{'https://w3id.org/xapi/cmi5/result/extensions/progress'})) {
235 return false;
236 }
237 return $xapiStatement->result->extensions->{'https://w3id.org/xapi/cmi5/result/extensions/progress'};
238 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ getResultProgressForXapiVerb()

ilXapiStatementEvaluation::getResultProgressForXapiVerb (   $xapiVerb)
protected

Definition at line 192 of file class.ilXapiStatementEvaluation.php.

193 {
194 return $this->resultProgressByXapiVerbMap[$xapiVerb];
195 }

◆ getResultStatusForXapiVerb()

ilXapiStatementEvaluation::getResultStatusForXapiVerb (   $xapiVerb)
protected

Definition at line 182 of file class.ilXapiStatementEvaluation.php.

183 {
184 return $this->resultStatusByXapiVerbMap[$xapiVerb];
185 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ getUserResult()

ilXapiStatementEvaluation::getUserResult (   $usrId)
protected

Definition at line 240 of file class.ilXapiStatementEvaluation.php.

241 {
242 try {
243 $result = ilCmiXapiResult::getInstanceByObjIdAndUsrId($this->object->getId(), $usrId);
244 } catch (ilCmiXapiException $e) {
245 $result = ilCmiXapiResult::getEmptyInstance();
246 $result->setObjId($this->object->getId());
247 $result->setUsrId($usrId);
248 }
249
250 return $result;
251 }
$result
$result
Definition: CleanUpTest.php:463
ilCmiXapiResult\getInstanceByObjIdAndUsrId
static getInstanceByObjIdAndUsrId($objId, $usrId)
Definition: class.ilCmiXapiResult.php:242

References Vendor\Package\$e, $result, ilCmiXapiResult\getEmptyInstance(), and ilCmiXapiResult\getInstanceByObjIdAndUsrId().

Referenced by evaluateStatement().

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

◆ getXapiScore()

ilXapiStatementEvaluation::getXapiScore (   $xapiStatement)
protected

Definition at line 219 of file class.ilXapiStatementEvaluation.php.

220 {
221 return $xapiStatement->result->score->scaled;
222 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ getXapiVerb()

ilXapiStatementEvaluation::getXapiVerb (   $xapiStatement)
protected

Definition at line 177 of file class.ilXapiStatementEvaluation.php.

178 {
179 return $xapiStatement->verb->id;
180 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ hasResultProgressRelevantXapiVerb()

ilXapiStatementEvaluation::hasResultProgressRelevantXapiVerb (   $xapiVerb)
protected

Definition at line 197 of file class.ilXapiStatementEvaluation.php.

198 {
199 return isset($this->resultProgressByXapiVerbMap[$xapiVerb]);
200 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ hasResultStatusRelevantXapiVerb()

ilXapiStatementEvaluation::hasResultStatusRelevantXapiVerb (   $xapiVerb)
protected

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

188 {
189 return isset($this->resultStatusByXapiVerbMap[$xapiVerb]);
190 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ hasXapiScore()

ilXapiStatementEvaluation::hasXapiScore (   $xapiStatement)
protected

Definition at line 202 of file class.ilXapiStatementEvaluation.php.

203 {
204 if (!isset($xapiStatement->result)) {
205 return false;
206 }
207
208 if (!isset($xapiStatement->result->score)) {
209 return false;
210 }
211
212 if (!isset($xapiStatement->result->score->scaled)) {
213 return false;
214 }
215
216 return true;
217 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ isLpModeInterestedInResultStatus()

ilXapiStatementEvaluation::isLpModeInterestedInResultStatus (   $resultStatus,
  $deactivated = true 
)
protected

Definition at line 273 of file class.ilXapiStatementEvaluation.php.

274 {
275 if ($this->lpMode == ilLPObjSettings::LP_MODE_DEACTIVATED) {
276 return $deactivated;
277 }
278
279 switch ($resultStatus) {
280 case 'failed':
281
282 return in_array($this->lpMode, [
283 ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED,
284 ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED,
285 ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
286 ]);
287
288 case 'passed':
289
290 return in_array($this->lpMode, [
291 ilLPObjSettings::LP_MODE_CMIX_PASSED,
292 ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED,
293 ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED,
294 ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
295 ]);
296
297 case 'completed':
298
299 return in_array($this->lpMode, [
300 ilLPObjSettings::LP_MODE_CMIX_COMPLETED,
301 ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED,
302 ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED,
303 ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
304 ]);
305 }
306
307 return false;
308 }
ilLPObjSettings\LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
const LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
Definition: class.ilLPObjSettings.php:54

References ilLPObjSettings\LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED, ilLPObjSettings\LP_MODE_CMIX_COMPL_WITH_FAILED, ilLPObjSettings\LP_MODE_CMIX_COMPLETED, ilLPObjSettings\LP_MODE_CMIX_COMPLETED_OR_PASSED, ilLPObjSettings\LP_MODE_CMIX_PASSED, ilLPObjSettings\LP_MODE_CMIX_PASSED_WITH_FAILED, and ilLPObjSettings\LP_MODE_DEACTIVATED.

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ isResultStatusToBeReplaced()

ilXapiStatementEvaluation::isResultStatusToBeReplaced (   $oldResultStatus,
  $newResultStatus 
)
protected

Definition at line 253 of file class.ilXapiStatementEvaluation.php.

254 {
255 if (!$this->isLpModeInterestedInResultStatus($newResultStatus)) {
256 $this->log->debug("isLpModeInterestedInResultStatus: false");
257 return false;
258 }
259
260 if (!$this->doesNewResultStatusDominateOldOne($oldResultStatus, $newResultStatus)) {
261 $this->log->debug("doesNewResultStatusDominateOldOne: false");
262 return false;
263 }
264
265 if ($this->needsAvoidFailedEvaluation($oldResultStatus, $newResultStatus)) {
266 $this->log->debug("needsAvoidFailedEvaluation: false");
267 return false;
268 }
269
270 return true;
271 }
ilXapiStatementEvaluation\needsAvoidFailedEvaluation
needsAvoidFailedEvaluation($oldResultStatus, $newResultStatus)
Definition: class.ilXapiStatementEvaluation.php:327
ilXapiStatementEvaluation\doesNewResultStatusDominateOldOne
doesNewResultStatusDominateOldOne($oldResultStatus, $newResultStatus)
Definition: class.ilXapiStatementEvaluation.php:310

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ isValidObject()

ilXapiStatementEvaluation::isValidObject (   $xapiStatement)
protected

Definition at line 167 of file class.ilXapiStatementEvaluation.php.

168 {
169 if ($xapiStatement->object->id != $this->object->getActivityId()) {
170 $this->log->debug($xapiStatement->object->id . " != " . $this->object->getActivityId());
171 return false;
172 }
173 return true;
174 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ isValidXapiStatement()

ilXapiStatementEvaluation::isValidXapiStatement (   $xapiStatement)
protected

Definition at line 147 of file class.ilXapiStatementEvaluation.php.

148 {
149 if (!isset($xapiStatement->actor)) {
150 return false;
151 }
152
153 if (!isset($xapiStatement->verb) || !isset($xapiStatement->verb->id)) {
154 return false;
155 }
156
157 if (!isset($xapiStatement->object) || !isset($xapiStatement->object->id)) {
158 return false;
159 }
160
161 return true;
162 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ needsAvoidFailedEvaluation()

ilXapiStatementEvaluation::needsAvoidFailedEvaluation (   $oldResultStatus,
  $newResultStatus 
)
protected

Definition at line 327 of file class.ilXapiStatementEvaluation.php.

328 {
329 if (!$this->object->isKeepLpStatusEnabled()) {
330 return false;
331 }
332
333 if ($newResultStatus != 'failed') {
334 return false;
335 }
336
337 return $oldResultStatus == 'completed' || $oldResultStatus == 'passed';
338 }

◆ sendSatisfiedStatement()

ilXapiStatementEvaluation::sendSatisfiedStatement (   $cmixUser)
protected

Definition at line 340 of file class.ilXapiStatementEvaluation.php.

341 {
342 global $DIC;
343
344 $lrsType = $this->object->getLrsType();
345 $defaultLrs = $lrsType->getLrsEndpoint();
346 //$fallbackLrs = $lrsType->getLrsFallbackEndpoint();
347 $defaultBasicAuth = $lrsType->getBasicAuth();
348 //$fallbackBasicAuth = $lrsType->getFallbackBasicAuth();
349 $defaultHeaders = [
350 'X-Experience-API-Version' => '1.0.3',
351 'Authorization' => $defaultBasicAuth,
352 'Content-Type' => 'application/json;charset=utf-8',
353 'Cache-Control' => 'no-cache, no-store, must-revalidate'
354 ];
355 /*
356 $fallbackHeaders = [
357 'X-Experience-API-Version' => '1.0.3',
358 'Authorization' => $fallbackBasicAuth,
359 'Content-Type' => 'application/json;charset=utf-8',
360 'Cache-Control' => 'no-cache, no-store, must-revalidate'
361 ];
362 */
363 $satisfiedStatement = $this->object->getSatisfiedStatement($cmixUser);
364 $satisfiedStatementParams = [];
365 $satisfiedStatementParams['statementId'] = $satisfiedStatement['id'];
366 $defaultStatementsUrl = $defaultLrs . "/statements";
367 $defaultSatisfiedStatementUrl = $defaultStatementsUrl . '?' . ilCmiXapiAbstractRequest::buildQuery($satisfiedStatementParams);
368
369 $client = new GuzzleHttp\Client();
370 $req_opts = array(
371 GuzzleHttp\RequestOptions::VERIFY => true,
372 GuzzleHttp\RequestOptions::CONNECT_TIMEOUT => 10,
373 GuzzleHttp\RequestOptions::HTTP_ERRORS => false
374 );
375
376 $defaultSatisfiedStatementRequest = new GuzzleHttp\Psr7\Request(
377 'PUT',
378 $defaultSatisfiedStatementUrl,
379 $defaultHeaders,
380 json_encode($satisfiedStatement)
381 );
382 $promises = array();
383 $promises['defaultSatisfiedStatement'] = $client->sendAsync($defaultSatisfiedStatementRequest, $req_opts);
384 try {
385 $responses = GuzzleHttp\Promise\Utils::settle($promises)->wait();
386 $body = '';
387 ilCmiXapiAbstractRequest::checkResponse($responses['defaultSatisfiedStatement'], $body, [204]);
388 } catch (Exception $e) {
389 $this->log->error('error:' . $e->getMessage());
390 }
391 }
ilCmiXapiAbstractRequest\buildQuery
static buildQuery(array $params, $encoding=PHP_QUERY_RFC3986)
Definition: class.ilCmiXapiAbstractRequest.php:87
ilCmiXapiAbstractRequest\checkResponse
static checkResponse($response, &$body, $allowedStatus=[200, 204])
Definition: class.ilCmiXapiAbstractRequest.php:66
$client
if($_SERVER['argc']< 4) $client
Definition: cron.php:12

References $client, $DIC, Vendor\Package\$e, ilCmiXapiAbstractRequest\buildQuery(), and ilCmiXapiAbstractRequest\checkResponse().

Referenced by evaluateStatement().

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

Field Documentation

◆ $log

ilXapiStatementEvaluation::$log
protected

Definition at line 42 of file class.ilXapiStatementEvaluation.php.

Referenced by __construct().

◆ $object

ilXapiStatementEvaluation::$object
protected

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

Referenced by __construct().

◆ $resultProgressByXapiVerbMap

ilXapiStatementEvaluation::$resultProgressByXapiVerbMap
protected
Initial value:
= array(
ilCmiXapiVerbList::PROGRESSED => "progressed",
ilCmiXapiVerbList::EXPERIENCED => "experienced"
)

Definition at line 29 of file class.ilXapiStatementEvaluation.php.

◆ $resultStatusByXapiVerbMap

ilXapiStatementEvaluation::$resultStatusByXapiVerbMap
protected
Initial value:
= array(
ilCmiXapiVerbList::COMPLETED => "completed",
ilCmiXapiVerbList::PASSED => "passed",
ilCmiXapiVerbList::FAILED => "failed",
ilCmiXapiVerbList::SATISFIED => "passed"
)

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

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