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.

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

     {
         $this->log = $log;
         $this->object = $object;
         
         $objLP = ilObjectLP::getInstance($this->object->getId());
         $this->lpMode = $objLP->getCurrentMode();
     }

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.

Referenced by isResultStatusToBeReplaced().

     {
         if ($oldResultStatus == '' ) {
             return true;
         }
         
         if (in_array($newResultStatus, ['passed', 'failed'])) {
             return true;
         }
         
         if (!in_array($oldResultStatus, ['passed', 'failed'])) {
             return true;
         }
         
         return false;
     }

Here is the caller graph for this function:

◆ evaluateReport()

ilXapiStatementEvaluation::evaluateReport ( ilCmiXapiStatementsReport $report )

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

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

     {
         foreach ($report->getStatements() as $xapiStatement) {
             #$this->log->debug(
             #   "handle statement:\n".json_encode($xapiStatement, JSON_PRETTY_PRINT)
             #);
             
             // ensure json decoded non assoc
             $xapiStatement = json_decode(json_encode($xapiStatement));
             $cmixUser = $this->getCmixUser($xapiStatement);
 
             $this->evaluateStatement($xapiStatement, $cmixUser->getUsrId());
 
             $this->log->debug('update lp for object (' . $this->object->getId() . ')');
             ilLPStatusWrapper::_updateStatus($this->object->getId(), $cmixUser->getUsrId());
         }
     }

Here is the call graph for this function:

◆ evaluateStatement()

ilXapiStatementEvaluation::evaluateStatement	(	$xapiStatement,
		$usrId
	)

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

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

     {
         global $DIC;
         $xapiVerb = $this->getXapiVerb($xapiStatement);      
         
         if ($this->isValidXapiStatement($xapiStatement))
         {
             // result status and if exists scaled score
             if ($this->hasResultStatusRelevantXapiVerb($xapiVerb))
             {
                 if (!$this->isValidObject($xapiStatement))
                 {
                     return;
                 }
                 $userResult = $this->getUserResult($usrId);
                 
                 $oldResultStatus = $userResult->getStatus();
                 $newResultStatus = $this->getResultStatusForXapiVerb($xapiVerb);
 
                 // this is for both xapi and cmi5
                 if ($this->isResultStatusToBeReplaced($oldResultStatus, $newResultStatus)) {
                     $this->log->debug("isResultStatusToBeReplaced: true");
                     $userResult->setStatus($newResultStatus);
                 }
                 
                 if ($this->hasXapiScore($xapiStatement)) {
                     $xapiScore = $this->getXapiScore($xapiStatement);
                     $this->log->debug("Score: " . $xapiScore);
                     $userResult->setScore((float) $xapiScore);
                 }
                 $userResult->save();
 
                 // only cmi5
                 if ($this->object->getContentType() == ilObjCmiXapi::CONT_TYPE_CMI5) 
                 {
                     if (($xapiVerb == ilCmiXapiVerbList::COMPLETED || $xapiVerb == ilCmiXapiVerbList::PASSED) && $this->isLpModeInterestedInResultStatus($newResultStatus,false)) 
                     {
                         // it is possible to check against authToken usrId!
                         $cmixUser = $this->getCmixUser($xapiStatement);
                         $cmixUser->setSatisfied(true);
                         $cmixUser->save();
                         $this->sendSatisfiedStatement($cmixUser);
                     }
                 }
             }
             // result progress (i think only cmi5 relevant)
             if ($this->hasResultProgressRelevantXapiVerb($xapiVerb))
             {
                 $userResult = $this->getUserResult($usrId);
                 $progressedScore = $this->getProgressedScore($xapiStatement);
                 if ($progressedScore !== false && (float) $progressedScore > 0)
                 {
                     $userResult->setScore((float) ($progressedScore / 100));
                     $userResult->save();
                 }
             }
         }
     }

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.

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

Referenced by evaluateReport(), and evaluateStatement().

     {
         $cmixUser = null;
         if ($this->object->getContentType() == ilObjCmiXapi::CONT_TYPE_CMI5)
         {
             $cmixUser = ilCmiXapiUser::getInstanceByObjectIdAndUsrIdent(
                 $this->object->getId(),
                 $xapiStatement->actor->account->name
             );
         }
         else
         {
             $cmixUser = ilCmiXapiUser::getInstanceByObjectIdAndUsrIdent(
                 $this->object->getId(),
                 str_replace('mailto:', '', $xapiStatement->actor->mbox)
             );
         }
         return $cmixUser;
     }

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.

Referenced by evaluateStatement().

     {
         if (!isset($xapiStatement->result)) {
             return false;
         }
         
         if (!isset($xapiStatement->result->extensions)) {
             return false;
         }
         
         if (!isset($xapiStatement->result->extensions->{'https://w3id.org/xapi/cmi5/result/extensions/progress'})) {
             return false;
         }
         return $xapiStatement->result->extensions->{'https://w3id.org/xapi/cmi5/result/extensions/progress'};
     }

Here is the caller graph for this function:

◆ getResultProgressForXapiVerb()

ilXapiStatementEvaluation::getResultProgressForXapiVerb ( $xapiVerb )

protected

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

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

◆ getResultStatusForXapiVerb()

ilXapiStatementEvaluation::getResultStatusForXapiVerb ( $xapiVerb )

protected

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

Referenced by evaluateStatement().

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

Here is the caller graph for this function:

◆ getUserResult()

ilXapiStatementEvaluation::getUserResult ( $usrId )

protected

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

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

Referenced by evaluateStatement().

     {
         try {
             $result = ilCmiXapiResult::getInstanceByObjIdAndUsrId($this->object->getId(), $usrId);
         } catch (ilCmiXapiException $e) {
             $result = ilCmiXapiResult::getEmptyInstance();
             $result->setObjId($this->object->getId());
             $result->setUsrId($usrId);
         }
         
         return $result;
     }

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.

Referenced by evaluateStatement().

     {
         return $xapiStatement->result->score->scaled;
     }

Here is the caller graph for this function:

◆ getXapiVerb()

ilXapiStatementEvaluation::getXapiVerb ( $xapiStatement )

protected

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

Referenced by evaluateStatement().

     {
         return $xapiStatement->verb->id;
     }

Here is the caller graph for this function:

◆ hasResultProgressRelevantXapiVerb()

ilXapiStatementEvaluation::hasResultProgressRelevantXapiVerb ( $xapiVerb )

protected

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

Referenced by evaluateStatement().

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

Here is the caller graph for this function:

◆ hasResultStatusRelevantXapiVerb()

ilXapiStatementEvaluation::hasResultStatusRelevantXapiVerb ( $xapiVerb )

protected

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

Referenced by evaluateStatement().

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

Here is the caller graph for this function:

◆ hasXapiScore()

ilXapiStatementEvaluation::hasXapiScore ( $xapiStatement )

protected

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

Referenced by evaluateStatement().

     {
         if (!isset($xapiStatement->result)) {
             return false;
         }
         
         if (!isset($xapiStatement->result->score)) {
             return false;
         }
         
         if (!isset($xapiStatement->result->score->scaled)) {
             return false;
         }
         
         return true;
     } 

Here is the caller graph for this function:

◆ isLpModeInterestedInResultStatus()

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

protected

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

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(), and isResultStatusToBeReplaced().

     {
         if ($this->lpMode == ilLPObjSettings::LP_MODE_DEACTIVATED) {
             return $deactivated;
         }
         
         switch ($resultStatus) {
             case 'failed':
                 
                 return in_array($this->lpMode, [
                     ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED,
                     ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED,
                     ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
                 ]);
             
             case 'passed':
                 
                 return in_array($this->lpMode, [
                     ilLPObjSettings::LP_MODE_CMIX_PASSED,
                     ilLPObjSettings::LP_MODE_CMIX_PASSED_WITH_FAILED,
                     ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED,
                     ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
                 ]);
             
             case 'completed':
                 
                 return in_array($this->lpMode, [
                     ilLPObjSettings::LP_MODE_CMIX_COMPLETED,
                     ilLPObjSettings::LP_MODE_CMIX_COMPL_WITH_FAILED,
                     ilLPObjSettings::LP_MODE_CMIX_COMPLETED_OR_PASSED,
                     ilLPObjSettings::LP_MODE_CMIX_COMPL_OR_PASSED_WITH_FAILED
                 ]);
         }
         
         return false;
     }

Here is the caller graph for this function:

◆ isResultStatusToBeReplaced()

ilXapiStatementEvaluation::isResultStatusToBeReplaced	(	$oldResultStatus,
		$newResultStatus
	)

protected

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

References doesNewResultStatusDominateOldOne(), isLpModeInterestedInResultStatus(), and needsAvoidFailedEvaluation().

Referenced by evaluateStatement().

     {
         if (!$this->isLpModeInterestedInResultStatus($newResultStatus)) {
             $this->log->debug("isLpModeInterestedInResultStatus: false");
             return false;
         }
         
         if (!$this->doesNewResultStatusDominateOldOne($oldResultStatus, $newResultStatus)) {
             $this->log->debug("doesNewResultStatusDominateOldOne: false");
             return false;
         }
         
         if ($this->needsAvoidFailedEvaluation($oldResultStatus, $newResultStatus)) {
             $this->log->debug("needsAvoidFailedEvaluation: false");
             return false;
         }
         
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValidObject()

ilXapiStatementEvaluation::isValidObject ( $xapiStatement )

protected

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

Referenced by evaluateStatement().

     {
         if ($xapiStatement->object->id != $this->object->getActivityId())
         {
             $this->log->debug($xapiStatement->object->id . " != " . $this->object->getActivityId());
             return false;
         }
         return true;
     }

Here is the caller graph for this function:

◆ isValidXapiStatement()

ilXapiStatementEvaluation::isValidXapiStatement ( $xapiStatement )

protected

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

Referenced by evaluateStatement().

     {
         if (!isset($xapiStatement->actor)) {
             return false;
         }
         
         if (!isset($xapiStatement->verb) || !isset($xapiStatement->verb->id)) {
             return false;
         }
         
         if (!isset($xapiStatement->object) || !isset($xapiStatement->object->id)) {
             return false;
         }
         
         return true;
     }

Here is the caller graph for this function:

◆ needsAvoidFailedEvaluation()

ilXapiStatementEvaluation::needsAvoidFailedEvaluation	(	$oldResultStatus,
		$newResultStatus
	)

protected

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

Referenced by isResultStatusToBeReplaced().

     {
         if (!$this->object->isKeepLpStatusEnabled()) {
             return false;
         }
         
         if ($newResultStatus != 'failed') {
             return false;
         }
         
         return $oldResultStatus == 'completed' || $oldResultStatus == 'passed';
     }

Here is the caller graph for this function:

◆ sendSatisfiedStatement()

ilXapiStatementEvaluation::sendSatisfiedStatement ( $cmixUser )

protected

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

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

Referenced by evaluateStatement().

     {
         global $DIC;
         
         $lrsType = $this->object->getLrsType();
         $defaultLrs = $lrsType->getLrsEndpoint();
         //$fallbackLrs = $lrsType->getLrsFallbackEndpoint();
         $defaultBasicAuth = $lrsType->getBasicAuth();
         //$fallbackBasicAuth = $lrsType->getFallbackBasicAuth();
         $defaultHeaders = [
             'X-Experience-API-Version' => '1.0.3',
             'Authorization' => $defaultBasicAuth,
             'Content-Type' => 'application/json;charset=utf-8',
             'Cache-Control' => 'no-cache, no-store, must-revalidate'
         ];
         /*
         $fallbackHeaders = [
             'X-Experience-API-Version' => '1.0.3',
             'Authorization' => $fallbackBasicAuth,
             'Content-Type' => 'application/json;charset=utf-8',
             'Cache-Control' => 'no-cache, no-store, must-revalidate'
         ];
         */
         $satisfiedStatement = $this->object->getSatisfiedStatement($cmixUser);
         $satisfiedStatementParams = [];
         $satisfiedStatementParams['statementId'] = $satisfiedStatement['id'];
         $defaultStatementsUrl = $defaultLrs . "/statements";
         $defaultSatisfiedStatementUrl = $defaultStatementsUrl . '?' .  ilCmiXapiAbstractRequest::buildQuery($satisfiedStatementParams);
         
         $client = new GuzzleHttp\Client();
         $req_opts = array(
             GuzzleHttp\RequestOptions::VERIFY => true,
             GuzzleHttp\RequestOptions::CONNECT_TIMEOUT => 10,
             GuzzleHttp\RequestOptions::HTTP_ERRORS => false
         );
         
         $defaultSatisfiedStatementRequest = new GuzzleHttp\Psr7\Request(
             'PUT',
             $defaultSatisfiedStatementUrl,
             $defaultHeaders,
             json_encode($satisfiedStatement)
         );
         $promises = array();
         $promises['defaultSatisfiedStatement'] = $client->sendAsync($defaultSatisfiedStatementRequest, $req_opts);
         try
         {
             $responses = GuzzleHttp\Promise\Utils::settle($promises)->wait();
             $body = '';
             ilCmiXapiAbstractRequest::checkResponse($responses['defaultSatisfiedStatement'],$body,[204]);
         }
         catch(Exception $e)
         {
             $this->log->error('error:' . $e->getMessage());
         }
     }

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:

Modules/CmiXapi/classes/XapiResults/class.ilXapiStatementEvaluation.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doesNewResultStatusDominateOldOne()

◆ evaluateReport()

◆ evaluateStatement()

◆ getCmixUser()

◆ getProgressedScore()

◆ getResultProgressForXapiVerb()

◆ getResultStatusForXapiVerb()

◆ getUserResult()

◆ getXapiScore()

◆ getXapiVerb()

◆ hasResultProgressRelevantXapiVerb()

◆ hasResultStatusRelevantXapiVerb()

◆ hasXapiScore()

◆ isLpModeInterestedInResultStatus()

◆ isResultStatusToBeReplaced()

◆ isValidObject()

◆ isValidXapiStatement()

◆ needsAvoidFailedEvaluation()

◆ sendSatisfiedStatement()

Field Documentation

◆ $log

◆ $object

◆ $resultProgressByXapiVerbMap

◆ $resultStatusByXapiVerbMap