Inheritance diagram for XapiProxy\XapiProxy:

Collaboration diagram for XapiProxy\XapiProxy:

Public Member Functions
	__construct ($client, $token, $plugin=false)

	setRequestParams ($request)

	token ()

	client ()

	lrsType ()

	replacedValues ()

	specificAllowedStatements ()

	blockSubStatements ()

	cmdParts ()

	method ()

	getDefaultLrsEndpoint ()

	getDefaultLrsKey ()

	getDefaultLrsSecret ()

	getFallbackLrsEndpoint ()

	getFallbackLrsKey ()

	getFallbackLrsSecret ()

	setXapiProxyRequest ($xapiProxyRequest)

	getXapiProxyRequest ()

	setXapiProxyResponse ($xapiProxyResponse)

	getXapiProxyResponse ()

	processStatements ($request, $body)

	modifyBody ($body)

Public Member Functions inherited from XapiProxy\XapiProxyPolyFill
	__construct ($client, $token, $plugin=false)

	log ()

	msg ($msg)

	initLrs ()

Private Member Functions
	handleStatementEvaluation ($xapiStatement)

	setValue (&$obj, $path, $value)

	setStatus ($obj)

	isSubStatementCheck ($obj)

Private Attributes
	$xapiProxyRequest

	$xapiProxyResponse

Additional Inherited Members
Data Fields inherited from XapiProxy\XapiProxyPolyFill
const	PARTS_REG = '/^(.?xapiproxy\.php)(\/([^?]+)?\??(.))/'

const	TERMINATED_VERB = "http://adlnet.gov/expapi/verbs/terminated"

Protected Attributes inherited from XapiProxy\XapiProxyPolyFill
	$client

	$token

	$plugin

	$table_prefix

	$lrsType

	$authToken = null

	$objId = null

	$specificAllowedStatements = null

	$replacedValues = null

	$blockSubStatements = false

	$cmdParts

	$method

	$defaultLrsEndpoint = ''

	$defaultLrsKey = ''

	$defaultLrsSecret = ''

	$fallbackLrsEndpoint = ''

	$fallbackLrsKey = ''

	$fallbackLrsSecret = ''

	$sniffVerbs

Detailed Description

Definition at line 6 of file XapiProxy.php.

Constructor & Destructor Documentation

◆ __construct()

XapiProxy\XapiProxy::__construct	(	$client,
		$token,
		$plugin = `false`
	)

Definition at line 11 of file XapiProxy.php.

References $client, XapiProxy\$plugin, $token, and ILIAS\GlobalScreen\Provider\__construct().

         {
             parent::__construct($client, $token, $plugin);
             $this->log()->debug($this->msg('proxy initialized'));
         }

Here is the call graph for this function:

Member Function Documentation

◆ blockSubStatements()

XapiProxy\XapiProxy::blockSubStatements ( )

Definition at line 47 of file XapiProxy.php.

         {
             return $this->blockSubStatements;
         }

◆ client()

XapiProxy\XapiProxy::client ( )

Definition at line 27 of file XapiProxy.php.

References $client.

         {
             return $this->client;
         }

◆ cmdParts()

XapiProxy\XapiProxy::cmdParts ( )

Definition at line 52 of file XapiProxy.php.

         {
             return $this->cmdParts;
         }

◆ getDefaultLrsEndpoint()

XapiProxy\XapiProxy::getDefaultLrsEndpoint ( )

Definition at line 62 of file XapiProxy.php.

         {
             return $this->defaultLrsEndpoint;
         }

◆ getDefaultLrsKey()

XapiProxy\XapiProxy::getDefaultLrsKey ( )

Definition at line 67 of file XapiProxy.php.

         {
             return $this->defaultLrsKey;
         }

◆ getDefaultLrsSecret()

XapiProxy\XapiProxy::getDefaultLrsSecret ( )

Definition at line 72 of file XapiProxy.php.

         {
             return $this->defaultLrsSecret;
         }

◆ getFallbackLrsEndpoint()

XapiProxy\XapiProxy::getFallbackLrsEndpoint ( )

Definition at line 77 of file XapiProxy.php.

         {
             return $this->fallbackLrsEndpoint;
         }

◆ getFallbackLrsKey()

XapiProxy\XapiProxy::getFallbackLrsKey ( )

Definition at line 82 of file XapiProxy.php.

         {
             return $this->fallbackLrsKey;
         }

◆ getFallbackLrsSecret()

XapiProxy\XapiProxy::getFallbackLrsSecret ( )

Definition at line 87 of file XapiProxy.php.

         {
             return $this->fallbackLrsSecret;
         }

◆ getXapiProxyRequest()

XapiProxy\XapiProxy::getXapiProxyRequest ( )

Definition at line 97 of file XapiProxy.php.

         {
             return $this->xapiProxyRequest;
         }

◆ getXapiProxyResponse()

XapiProxy\XapiProxy::getXapiProxyResponse ( )

Definition at line 107 of file XapiProxy.php.

         {
             return $this->xapiProxyResponse;
         }

◆ handleStatementEvaluation()

XapiProxy\XapiProxy::handleStatementEvaluation ( $xapiStatement )

private

Definition at line 206 of file XapiProxy.php.

References $DIC, ilLPStatusWrapper\_updateStatus(), ANONYMOUS_USER_ID, ilObjectFactory\getInstanceByObjId(), and ilObjCmiXapi\LAUNCH_MODE_NORMAL.

         {
             global $DIC;
             if ($this->plugin) {
                 require_once __DIR__ . '/../class.ilObjXapiCmi5.php';
                 // ToDo: handle terminate -> delete session
                 $this->setStatus($xapiStatement);
             } else {
                 /* @var $object */
                 $object = \ilObjectFactory::getInstanceByObjId($this->authToken->getObjId());
                 if ((string) $object->getLaunchMode() === (string) \ilObjCmiXapi::LAUNCH_MODE_NORMAL) {
                     // ToDo: check function hasContextActivitiesParentNotEqualToObject!
                     $statementEvaluation = new \ilXapiStatementEvaluation($this->log(), $object);
                     $statementEvaluation->evaluateStatement($xapiStatement, $this->authToken->getUsrId());
 
                     if ($this->authToken->getUsrId() != ANONYMOUS_USER_ID) {
                         \ilLPStatusWrapper::_updateStatus(
                             $this->authToken->getObjId(),
                             $this->authToken->getUsrId()
                         );
                     }
                 }
                 if ($xapiStatement->verb->id == self::TERMINATED_VERB) {
                     // ToDo : only cmi5 or also xapi? authToken object still used after that?
                     $this->authToken->delete();
                 }
             }
         }

Here is the call graph for this function:

◆ isSubStatementCheck()

XapiProxy\XapiProxy::isSubStatementCheck ( $obj )

private

Definition at line 269 of file XapiProxy.php.

References ilObjectFactory\getInstanceByObjId().

         {
             $object = \ilObjectFactory::getInstanceByObjId($this->authToken->getObjId()); // get ActivityId in Constructor for better performance, is also used in handleEvaluationStatement
             $objActivityId = $object->getActivityId();
             $statementActivityId = $obj->object->id;
             if ($statementActivityId != $objActivityId) {
                 $this->log()->debug($this->msg("statement object id " . $statementActivityId . " != activityId " . $objActivityId));
                 $this->log()->debug($this->msg("is Substatement"));
                 return true;
             } else {
                 $this->log()->debug($this->msg("is not Substatement"));
                 return false;
             }
         }

Here is the call graph for this function:

◆ lrsType()

XapiProxy\XapiProxy::lrsType ( )

Definition at line 32 of file XapiProxy.php.

         {
             return $this->lrsType;
         }

◆ method()

XapiProxy\XapiProxy::method ( )

Definition at line 57 of file XapiProxy.php.

         {
             return $this->method;
         }

◆ modifyBody()

XapiProxy\XapiProxy::modifyBody ( $body )

Definition at line 173 of file XapiProxy.php.

References $i.

         {
             $obj = json_decode($body, false);
 
             if (json_last_error() != JSON_ERROR_NONE) {
                 // JSON is not valid
                 $this->log()->error($this->msg(json_last_error_msg()));
                 return $body;
             }
 
             // $log->debug(json_encode($obj, JSON_PRETTY_PRINT)); // only in DEBUG mode for better performance
             if (is_object($obj)) {
                 if (is_array($this->replacedValues)) {
                     foreach ($this->replacedValues as $key => $value) {
                         $this->setValue($obj, $key, $value);
                     }
                 }
                 $this->handleStatementEvaluation($obj); // ToDo
             }
 
             if (is_array($obj)) {
                 for ($i = 0; $i < count($obj); $i++) {
                     if (is_array($this->replacedValues)) {
                         foreach ($this->replacedValues as $key => $value) {
                             $this->setValue($obj[$i], $key, $value);
                         }
                     }
                     $this->handleStatementEvaluation($obj[$i]); // ToDo
                 }
             }
             return json_encode($obj);
         }

◆ processStatements()

XapiProxy\XapiProxy::processStatements	(	$request,
		$body
	)

Definition at line 112 of file XapiProxy.php.

References $i, and $ret.

         {
             // everything is allowed
             if (!is_array($this->specificAllowedStatements) && !$this->blockSubStatements) {
                 $this->log()->debug($this->msg("all statement are allowed"));
                 return null;
             }
             $obj = json_decode($body, false);
             // single statement object
             if (is_object($obj) && isset($obj->verb)) {
                 $this->log()->debug($this->msg("json is object and statement"));
                 $isSubStatement = $this->isSubStatementCheck($obj);
                 $verb = $obj->verb->id;
                 if ($this->blockSubStatements && $isSubStatement) {
                     $this->log()->debug($this->msg("sub-statement is NOT allowed, fake response - " . $verb));
                     $this->xapiProxyResponse->fakeResponseBlocked(null);
                 }
                 // $specificAllowedStatements
                 if (!is_array($this->specificAllowedStatements)) {
                     return null;
                 }
                 if (in_array($verb, $this->specificAllowedStatements)) {
                     $this->log()->debug($this->msg("statement is allowed, do nothing - " . $verb));
                     return null;
                 } else {
                     $this->log()->debug($this->msg("statement is NOT allowed, fake response - " . $verb));
                     $this->xapiProxyResponse->fakeResponseBlocked(null);
                 }
             }
             // array of statement objects
             if (is_array($obj) && count($obj) > 0 && isset($obj[0]->verb)) {
                 $this->log()->debug($this->msg("json is array of statements"));
                 $ret = array();
                 $up = array();
                 for ($i = 0; $i < count($obj); $i++) {
                     array_push($ret, $obj[$i]->id); // push every statementid for fakePostResponse
                     $isSubStatement = $this->isSubStatementCheck($obj[$i]);
                     $verb = $obj[$i]->verb->id;
                     if ($this->blockSubStatements && $isSubStatement) {
                         $this->log()->debug($this->msg("sub-statement is NOT allowed - " . $verb));
                     } else {
                         if (!is_array($this->specificAllowedStatements) || (is_array($this->specificAllowedStatements) && in_array($verb, $this->specificAllowedStatements))) {
                             $this->log()->debug($this->msg("statement is allowed - " . $verb));
                             array_push($up, $obj[$i]);
                         }
                     }
                 }
                 if (count($up) === 0) { // nothing allowed
                     $this->log()->debug($this->msg("no allowed statements in array - fake response..."));
                     $this->xapiProxyResponse->fakeResponseBlocked($ret);
                 } elseif (count($up) !== count($ret)) { // mixed request with allowed and not allowed statements
                     $this->log()->debug($this->msg("mixed with allowed and unallowed statements"));
                     return array($up,$ret);
                 } else {
                     // just return nothing
                     return null;
                 }
             }
             return null;
         }

◆ replacedValues()

XapiProxy\XapiProxy::replacedValues ( )

Definition at line 37 of file XapiProxy.php.

         {
             return $this->replacedValues;
         }

◆ setRequestParams()

XapiProxy\XapiProxy::setRequestParams ( $request )

Definition at line 17 of file XapiProxy.php.

         {
             preg_match(self::PARTS_REG, $request->getUri(), $this->cmdParts);
         }

◆ setStatus()

XapiProxy\XapiProxy::setStatus ( $obj )

private

Definition at line 249 of file XapiProxy.php.

         {
             if (isset($obj->verb) && isset($obj->actor) && isset($obj->object)) {
                 $verb = $obj->verb->id;
                 $score = 'NOT_SET';
                 if (array_key_exists($verb, $this->sniffVerbs)) {
                     // check context
                     if ($this->isSubStatementCheck($obj)) {
                         $this->log()->debug($this->msg("statement is sub-statement, ignore status verb " . $verb));
                         return;
                     }
                     if (isset($obj->result) && isset($obj->result->score) && isset($obj->result->score->scaled)) {
                         $score = $obj->result->score->scaled;
                     }
                     $this->log()->debug($this->msg("handleLPStatus: " . $this->sniffVerbs[$verb] . " : " . $score));
                     \ilObjXapiCmi5::handleLPStatusFromProxy($this->client, $this->token, $this->sniffVerbs[$verb], $score);//UK check
                 }
             }
         }

◆ setValue()

XapiProxy\XapiProxy::setValue	(	&	$obj,
			$path,
			$value
	)

private

Definition at line 235 of file XapiProxy.php.

         {
             $path_components = explode('.', $path);
             if (count($path_components) == 1) {
                 if (property_exists($obj, $path_components[0])) {
                     $obj->{$path_components[0]} = $value;
                 }
             } else {
                 if (property_exists($obj, $path_components[0])) {
                     $this->setValue($obj->{array_shift($path_components)}, implode('.', $path_components), $value);
                 }
             }
         }

◆ setXapiProxyRequest()

XapiProxy\XapiProxy::setXapiProxyRequest ( $xapiProxyRequest )

Definition at line 92 of file XapiProxy.php.

         {
             $this->xapiProxyRequest = $xapiProxyRequest;
         }

◆ setXapiProxyResponse()

XapiProxy\XapiProxy::setXapiProxyResponse ( $xapiProxyResponse )

Definition at line 102 of file XapiProxy.php.

         {
             $this->xapiProxyResponse = $xapiProxyResponse;
         }

◆ specificAllowedStatements()

XapiProxy\XapiProxy::specificAllowedStatements ( )

Definition at line 42 of file XapiProxy.php.

         {
             return $this->specificAllowedStatements;
         }

◆ token()

XapiProxy\XapiProxy::token ( )

Definition at line 22 of file XapiProxy.php.

References $token.

         {
             return $this->token;
         }

Field Documentation

◆ $xapiProxyRequest

XapiProxy\XapiProxy::$xapiProxyRequest

private

Definition at line 8 of file XapiProxy.php.

◆ $xapiProxyResponse

XapiProxy\XapiProxy::$xapiProxyResponse

private

Definition at line 9 of file XapiProxy.php.

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

Modules/CmiXapi/classes/XapiProxy/XapiProxy.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ blockSubStatements()

◆ client()

◆ cmdParts()

◆ getDefaultLrsEndpoint()

◆ getDefaultLrsKey()

◆ getDefaultLrsSecret()

◆ getFallbackLrsEndpoint()

◆ getFallbackLrsKey()

◆ getFallbackLrsSecret()

◆ getXapiProxyRequest()

◆ getXapiProxyResponse()

◆ handleStatementEvaluation()

◆ isSubStatementCheck()

◆ lrsType()

◆ method()

◆ modifyBody()

◆ processStatements()

◆ replacedValues()

◆ setRequestParams()

◆ setStatus()

◆ setValue()

◆ setXapiProxyRequest()

◆ setXapiProxyResponse()

◆ specificAllowedStatements()

◆ token()

Field Documentation

◆ $xapiProxyRequest

◆ $xapiProxyResponse