Collaboration diagram for ilXapiStatementEvaluation:

Public Member Functions
	__construct (ilLogger $log, ilObject $object)
	ilXapiStatementEvaluation constructor. More...

	evaluateReport (ilCmiXapiStatementsReport $report)

	getCmixUser (object $xapiStatement)

	evaluateStatement (object $xapiStatement, int $usrId)

Protected Member Functions
	isValidXapiStatement (object $xapiStatement)

	isValidObject (object $xapiStatement)

	getXapiVerb (object $xapiStatement)

	getResultStatusForXapiVerb (string $xapiVerb)

	hasResultStatusRelevantXapiVerb (string $xapiVerb)

	getResultProgressForXapiVerb (string $xapiVerb)

	hasResultProgressRelevantXapiVerb (string $xapiVerb)

	hasXapiScore (object $xapiStatement)

	getXapiScore (object $xapiStatement)

	getProgressedScore (object $xapiStatement)

	getUserResult (int $usrId)

	isResultStatusToBeReplaced (string $oldResultStatus, string $newResultStatus)

	isLpModeInterestedInResultStatus (string $resultStatus, ?bool $deactivated=true)

	doesNewResultStatusDominateOldOne (string $oldResultStatus, string $newResultStatus)

	needsAvoidFailedEvaluation (string $oldResultStatus, string $newResultStatus)

	sendSatisfiedStatement (ilCmiXapiUser $cmixUser)

Protected Attributes
array	$resultStatusByXapiVerbMap
	http://adlnet.gov/expapi/verbs/satisfied: should never be sent by AU https://github.com/AICC/CMI-5_Spec_Current/blob/quartz/cmi5_spec.md#939-satisfied More...

array	$resultProgressByXapiVerbMap

ilObject	$object

ilLogger	$log

int	$lpMode

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

ilXapiStatementEvaluation constructor.

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ doesNewResultStatusDominateOldOne()

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

protected

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

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

◆ evaluateReport()

ilXapiStatementEvaluation::evaluateReport ( ilCmiXapiStatementsReport $report )

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

                                                                     : void
    {
        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() . ')');
            if ($cmixUser->getUsrId() != ANONYMOUS_USER_ID) {
                ilLPStatusWrapper::_updateStatus($this->object->getId(), $cmixUser->getUsrId());
            }
        }
    }

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

Here is the call graph for this function:

◆ evaluateStatement()

ilXapiStatementEvaluation::evaluateStatement	(	object	$xapiStatement,
		int	$usrId
	)

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

                                                                        : void
    {
        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);
                        // avoid multiple satisfied
                        if (!$cmixUser->getSatisfied()) {
                            $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 !== null && $progressedScore > 0) {
                    $userResult->setScore((float) ($progressedScore / 100));
                    $userResult->save();
                }
            }
        }
    }

References $DIC, ilCmiXapiVerbList\COMPLETED, ilObjCmiXapi\CONT_TYPE_CMI5, getCmixUser(), getProgressedScore(), getResultStatusForXapiVerb(), getUserResult(), getXapiScore(), getXapiVerb(), hasResultProgressRelevantXapiVerb(), hasResultStatusRelevantXapiVerb(), hasXapiScore(), isLpModeInterestedInResultStatus(), isResultStatusToBeReplaced(), isValidObject(), isValidXapiStatement(), ILIAS\Repository\object(), 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 ( object $xapiStatement )

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

                                                      : \ilCmiXapiUser
    {
        $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;
    }

References ilObjCmiXapi\CONT_TYPE_CMI5, ilCmiXapiUser\getInstanceByObjectIdAndUsrIdent(), and ILIAS\Repository\object().

Referenced by evaluateReport(), and evaluateStatement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProgressedScore()

ilXapiStatementEvaluation::getProgressedScore ( object $xapiStatement )

protected

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

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

Referenced by evaluateStatement().

Here is the caller graph for this function:

◆ getResultProgressForXapiVerb()

ilXapiStatementEvaluation::getResultProgressForXapiVerb ( string $xapiVerb )

protected

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

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

◆ getResultStatusForXapiVerb()

ilXapiStatementEvaluation::getResultStatusForXapiVerb ( string $xapiVerb )

protected

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

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

Referenced by evaluateStatement().

Here is the caller graph for this function:

◆ getUserResult()

ilXapiStatementEvaluation::getUserResult ( int $usrId )

protected

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

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

References Vendor\Package\$e, ilCmiXapiResult\getEmptyInstance(), ilCmiXapiResult\getInstanceByObjIdAndUsrId(), and ILIAS\Repository\object().

Referenced by evaluateStatement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getXapiScore()

ilXapiStatementEvaluation::getXapiScore ( object $xapiStatement )

protected

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

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

Referenced by evaluateStatement().

Here is the caller graph for this function:

◆ getXapiVerb()

ilXapiStatementEvaluation::getXapiVerb ( object $xapiStatement )

protected

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

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

Referenced by evaluateStatement().

Here is the caller graph for this function:

◆ hasResultProgressRelevantXapiVerb()

ilXapiStatementEvaluation::hasResultProgressRelevantXapiVerb ( string $xapiVerb )

protected

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

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

Referenced by evaluateStatement().

Here is the caller graph for this function:

◆ hasResultStatusRelevantXapiVerb()

ilXapiStatementEvaluation::hasResultStatusRelevantXapiVerb ( string $xapiVerb )

protected

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

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

Referenced by evaluateStatement().

Here is the caller graph for this function:

◆ hasXapiScore()

ilXapiStatementEvaluation::hasXapiScore ( object $xapiStatement )

protected

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

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

Referenced by evaluateStatement().

Here is the caller graph for this function:

◆ isLpModeInterestedInResultStatus()

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

protected

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

                                                                                                        : ?bool
    {
        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;
    }

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	(	string	$oldResultStatus,
		string	$newResultStatus
	)

protected

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

                                                                                                   : bool
    {
        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;
    }

Referenced by evaluateStatement().

Here is the caller graph for this function:

◆ isValidObject()

ilXapiStatementEvaluation::isValidObject ( object $xapiStatement )

protected

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

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

Referenced by evaluateStatement().

Here is the caller graph for this function:

◆ isValidXapiStatement()

ilXapiStatementEvaluation::isValidXapiStatement ( object $xapiStatement )

protected

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

                                                                  : bool
    {
        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;
    }

Referenced by evaluateStatement().

Here is the caller graph for this function:

◆ needsAvoidFailedEvaluation()

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

protected

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

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

References ILIAS\Repository\object().

Here is the call graph for this function:

◆ sendSatisfiedStatement()

ilXapiStatementEvaluation::sendSatisfiedStatement ( ilCmiXapiUser $cmixUser )

protected

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

                                                                      : void
    {
        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());
        }
    }

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

ilLogger ilXapiStatementEvaluation::$log

protected

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

Referenced by __construct().

◆ $lpMode

int ilXapiStatementEvaluation::$lpMode

protected

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

◆ $object

ilObject ilXapiStatementEvaluation::$object

protected

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

Referenced by __construct().

◆ $resultProgressByXapiVerbMap

array ilXapiStatementEvaluation::$resultProgressByXapiVerbMap

protected

Initial value:

= [
        ilCmiXapiVerbList::PROGRESSED => "progressed",
        ilCmiXapiVerbList::EXPERIENCED => "experienced"
    ]

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

◆ $resultStatusByXapiVerbMap

array ilXapiStatementEvaluation::$resultStatusByXapiVerbMap

protected

Initial value:

= [
        ilCmiXapiVerbList::COMPLETED => "completed",
        ilCmiXapiVerbList::PASSED => "passed",
        ilCmiXapiVerbList::FAILED => "failed",
        ilCmiXapiVerbList::SATISFIED => "passed"
    ]

http://adlnet.gov/expapi/verbs/satisfied: should never be sent by AU https://github.com/AICC/CMI-5_Spec_Current/blob/quartz/cmi5_spec.md#939-satisfied

Definition at line 36 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

◆ $lpMode

◆ $object

◆ $resultProgressByXapiVerbMap

◆ $resultStatusByXapiVerbMap