ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
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 319 of file class.ilXapiStatementEvaluation.php.

320 {
321 if ($oldResultStatus == '' ) {
322 return true;
323 }
324
325 if (in_array($newResultStatus, ['passed', 'failed'])) {
326 return true;
327 }
328
329 if (!in_array($oldResultStatus, ['passed', 'failed'])) {
330 return true;
331 }
332
333 return false;
334 }

◆ 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 ilLPStatusWrapper::_updateStatus($this->object->getId(), $cmixUser->getUsrId());
73 }
74 }
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

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

+ Here is the call graph for this function:

◆ evaluateStatement()

ilXapiStatementEvaluation::evaluateStatement (   $xapiStatement,
  $usrId 
)

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

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

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 76 of file class.ilXapiStatementEvaluation.php.

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

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 233 of file class.ilXapiStatementEvaluation.php.

234 {
235 if (!isset($xapiStatement->result)) {
236 return false;
237 }
238
239 if (!isset($xapiStatement->result->extensions)) {
240 return false;
241 }
242
243 if (!isset($xapiStatement->result->extensions->{'https://w3id.org/xapi/cmi5/result/extensions/progress'})) {
244 return false;
245 }
246 return $xapiStatement->result->extensions->{'https://w3id.org/xapi/cmi5/result/extensions/progress'};
247 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ getResultProgressForXapiVerb()

ilXapiStatementEvaluation::getResultProgressForXapiVerb (   $xapiVerb)
protected

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

202 {
203 return $this->resultProgressByXapiVerbMap[$xapiVerb];
204 }

◆ getResultStatusForXapiVerb()

ilXapiStatementEvaluation::getResultStatusForXapiVerb (   $xapiVerb)
protected

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

192 {
193 return $this->resultStatusByXapiVerbMap[$xapiVerb];
194 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ getUserResult()

ilXapiStatementEvaluation::getUserResult (   $usrId)
protected

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

250 {
251 try {
252 $result = ilCmiXapiResult::getInstanceByObjIdAndUsrId($this->object->getId(), $usrId);
253 } catch (ilCmiXapiException $e) {
254 $result = ilCmiXapiResult::getEmptyInstance();
255 $result->setObjId($this->object->getId());
256 $result->setUsrId($usrId);
257 }
258
259 return $result;
260 }
$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 228 of file class.ilXapiStatementEvaluation.php.

229 {
230 return $xapiStatement->result->score->scaled;
231 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ getXapiVerb()

ilXapiStatementEvaluation::getXapiVerb (   $xapiStatement)
protected

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

187 {
188 return $xapiStatement->verb->id;
189 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ hasResultProgressRelevantXapiVerb()

ilXapiStatementEvaluation::hasResultProgressRelevantXapiVerb (   $xapiVerb)
protected

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

207 {
208 return isset($this->resultProgressByXapiVerbMap[$xapiVerb]);
209 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ hasResultStatusRelevantXapiVerb()

ilXapiStatementEvaluation::hasResultStatusRelevantXapiVerb (   $xapiVerb)
protected

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

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

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ hasXapiScore()

ilXapiStatementEvaluation::hasXapiScore (   $xapiStatement)
protected

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

212 {
213 if (!isset($xapiStatement->result)) {
214 return false;
215 }
216
217 if (!isset($xapiStatement->result->score)) {
218 return false;
219 }
220
221 if (!isset($xapiStatement->result->score->scaled)) {
222 return false;
223 }
224
225 return true;
226 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ isLpModeInterestedInResultStatus()

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

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

283 {
284 if ($this->lpMode == ilLPObjSettings::LP_MODE_DEACTIVATED) {
285 return $deactivated;
286 }
287
288 switch ($resultStatus) {
289 case 'failed':
290
291 return in_array($this->lpMode, [
292 ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED,
293 ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED,
294 ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
295 ]);
296
297 case 'passed':
298
299 return in_array($this->lpMode, [
300 ilLPObjSettings::LP_MODE_CMIX_PASSED,
301 ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED,
302 ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED,
303 ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
304 ]);
305
306 case 'completed':
307
308 return in_array($this->lpMode, [
309 ilLPObjSettings::LP_MODE_CMIX_COMPLETED,
310 ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED,
311 ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED,
312 ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
313 ]);
314 }
315
316 return false;
317 }
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 262 of file class.ilXapiStatementEvaluation.php.

263 {
264 if (!$this->isLpModeInterestedInResultStatus($newResultStatus)) {
265 $this->log->debug("isLpModeInterestedInResultStatus: false");
266 return false;
267 }
268
269 if (!$this->doesNewResultStatusDominateOldOne($oldResultStatus, $newResultStatus)) {
270 $this->log->debug("doesNewResultStatusDominateOldOne: false");
271 return false;
272 }
273
274 if ($this->needsAvoidFailedEvaluation($oldResultStatus, $newResultStatus)) {
275 $this->log->debug("needsAvoidFailedEvaluation: false");
276 return false;
277 }
278
279 return true;
280 }
ilXapiStatementEvaluation\needsAvoidFailedEvaluation
needsAvoidFailedEvaluation($oldResultStatus, $newResultStatus)
Definition: class.ilXapiStatementEvaluation.php:336
ilXapiStatementEvaluation\doesNewResultStatusDominateOldOne
doesNewResultStatusDominateOldOne($oldResultStatus, $newResultStatus)
Definition: class.ilXapiStatementEvaluation.php:319

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ isValidObject()

ilXapiStatementEvaluation::isValidObject (   $xapiStatement)
protected

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

176 {
177 if ($xapiStatement->object->id != $this->object->getActivityId())
178 {
179 $this->log->debug($xapiStatement->object->id . " != " . $this->object->getActivityId());
180 return false;
181 }
182 return true;
183 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ isValidXapiStatement()

ilXapiStatementEvaluation::isValidXapiStatement (   $xapiStatement)
protected

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

156 {
157 if (!isset($xapiStatement->actor)) {
158 return false;
159 }
160
161 if (!isset($xapiStatement->verb) || !isset($xapiStatement->verb->id)) {
162 return false;
163 }
164
165 if (!isset($xapiStatement->object) || !isset($xapiStatement->object->id)) {
166 return false;
167 }
168
169 return true;
170 }

Referenced by evaluateStatement().

+ Here is the caller graph for this function:

◆ needsAvoidFailedEvaluation()

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

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

337 {
338 if (!$this->object->isKeepLpStatusEnabled()) {
339 return false;
340 }
341
342 if ($newResultStatus != 'failed') {
343 return false;
344 }
345
346 return $oldResultStatus == 'completed' || $oldResultStatus == 'passed';
347 }

◆ sendSatisfiedStatement()

ilXapiStatementEvaluation::sendSatisfiedStatement (   $cmixUser)
protected

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

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