XapiProxy\XapiProxy Class Reference

Inheritance diagram for XapiProxy\XapiProxy:

Collaboration diagram for XapiProxy\XapiProxy:

Public Member Functions
	__construct (string $client, string $token, ?bool $plugin=false)
	setRequestParams (Request $request)
	token ()
	client ()
	lrsType ()
	replacedValues ()
	specificAllowedStatements ()
	blockSubStatements ()
	cmdParts ()
	method ()
	getDefaultLrsEndpoint ()
	getDefaultLrsKey ()
	getDefaultLrsSecret ()
	getFallbackLrsEndpoint ()
	getFallbackLrsKey ()
	getFallbackLrsSecret ()
	setXapiProxyRequest (XapiProxyRequest $xapiProxyRequest)
	getXapiProxyRequest ()
	setXapiProxyResponse (XapiProxyResponse $xapiProxyResponse)
	getXapiProxyResponse ()
	processStatements (\Psr\Http\Message\RequestInterface $request, $body)
	modifyBody (string $body)
Public Member Functions inherited from XapiProxy\XapiProxyPolyFill
	__construct (string $client, string $token, ?bool $plugin=false)
	log ()
	msg (string $msg)
	initLrs ()

Private Member Functions
	handleStatementEvaluation (object $xapiStatement)
	setValue (object &$obj, string $path, string $value)
	setStatus (object $obj)
	isSubStatementCheck (object $obj)

Private Attributes
XapiProxyRequest	$xapiProxyRequest
XapiProxyResponse	$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
string	$client
string	$token
bool	$plugin = false
string	$table_prefix
ilCmiXapiLrsType	$lrsType = null
ilCmiXapiAuthToken	$authToken = null
int	$objId = null
array	$specificAllowedStatements = null
array	$replacedValues = null
bool	$blockSubStatements = false
array	$cmdParts = []
string	$method
string	$defaultLrsEndpoint = ''
string	$defaultLrsKey = ''
string	$defaultLrsSecret = ''
string	$fallbackLrsEndpoint = ''
string	$fallbackLrsKey = ''
string	$fallbackLrsSecret = ''
array	$sniffVerbs

Detailed Description

Definition at line 25 of file XapiProxy.php.

Constructor & Destructor Documentation

__construct()

XapiProxy\XapiProxy::__construct	(	string	$client,
		string	$token,
		?bool	$plugin = false
	)

Definition at line 30 of file XapiProxy.php.

References XapiProxy\$plugin, 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 66 of file XapiProxy.php.

                                        : bool
    {
        return $this->blockSubStatements;
    }

client()

XapiProxy\XapiProxy::client

(

)

Definition at line 46 of file XapiProxy.php.

References $client.

                            : string
    {
        return $this->client;
    }

cmdParts()

XapiProxy\XapiProxy::cmdParts

(

)

Returns

mixed[]

Definition at line 74 of file XapiProxy.php.

                              : array
    {
        return $this->cmdParts;
    }

getDefaultLrsEndpoint()

XapiProxy\XapiProxy::getDefaultLrsEndpoint

(

)

Definition at line 84 of file XapiProxy.php.

                                           : string
    {
        return $this->defaultLrsEndpoint;
    }

getDefaultLrsKey()

XapiProxy\XapiProxy::getDefaultLrsKey

(

)

Definition at line 89 of file XapiProxy.php.

                                      : string
    {
        return $this->defaultLrsKey;
    }

getDefaultLrsSecret()

XapiProxy\XapiProxy::getDefaultLrsSecret

(

)

Definition at line 94 of file XapiProxy.php.

                                         : string
    {
        return $this->defaultLrsSecret;
    }

getFallbackLrsEndpoint()

XapiProxy\XapiProxy::getFallbackLrsEndpoint

(

)

Definition at line 99 of file XapiProxy.php.

                                            : string
    {
        return $this->fallbackLrsEndpoint;
    }

getFallbackLrsKey()

XapiProxy\XapiProxy::getFallbackLrsKey

(

)

Definition at line 104 of file XapiProxy.php.

                                       : string
    {
        return $this->fallbackLrsKey;
    }

getFallbackLrsSecret()

XapiProxy\XapiProxy::getFallbackLrsSecret

(

)

Definition at line 109 of file XapiProxy.php.

                                          : string
    {
        return $this->fallbackLrsSecret;
    }

getXapiProxyRequest()

XapiProxy\XapiProxy::getXapiProxyRequest

(

)

Definition at line 119 of file XapiProxy.php.

                                         : XapiProxyRequest
    {
        return $this->xapiProxyRequest;
    }

getXapiProxyResponse()

XapiProxy\XapiProxy::getXapiProxyResponse

(

)

Definition at line 129 of file XapiProxy.php.

                                          : XapiProxyResponse
    {
        return $this->xapiProxyResponse;
    }

handleStatementEvaluation()

XapiProxy\XapiProxy::handleStatementEvaluation ( object  $xapiStatement )

private

Definition at line 230 of file XapiProxy.php.

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

                                                                     : void
    {
        global $DIC;
        if ($this->plugin) {
            // 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 ( object  $obj )

private

Definition at line 293 of file XapiProxy.php.

References ilObjectFactory\getInstanceByObjId().

                                                     : bool
    {
        $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 51 of file XapiProxy.php.

                             : ?\ilCmiXapiLrsType
    {
        return $this->lrsType;
    }

method()

XapiProxy\XapiProxy::method

(

)

Definition at line 79 of file XapiProxy.php.

                            : string
    {
        return $this->method;
    }

modifyBody()

XapiProxy\XapiProxy::modifyBody

(

string

$body

)

Definition at line 197 of file XapiProxy.php.

                                            : string
    {
        $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, (string) $key, (string) $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], (string) $key, (string) $value);
                    }
                }
                $this->handleStatementEvaluation($obj[$i]); // ToDo
            }
        }
        return json_encode($obj);
    }

processStatements()

XapiProxy\XapiProxy::processStatements	(	\Psr\Http\Message\RequestInterface	$request,
			$body
	)

Definition at line 134 of file XapiProxy.php.

References null.

                                                                                         : ?array
    {
        // 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();
            foreach ($obj as $i => $singleObj) {
                $ret[] = $singleObj->id;
                // push every statementid for fakePostResponse
                $isSubStatement = $this->isSubStatementCheck($singleObj);
                $verb = $singleObj->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));
                        $up[] = $singleObj;
                    }
                }
            }
            if ($up === []) { // nothing allowed
                $this->log()->debug($this->msg("no allowed statements in array - fake response..."));
                $this->xapiProxyResponse->fakeResponseBlocked("");
                //                    $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 56 of file XapiProxy.php.

                                    : ?array
    {
        return $this->replacedValues;
    }

setRequestParams()

XapiProxy\XapiProxy::setRequestParams

(

Request

$request

)

Definition at line 36 of file XapiProxy.php.

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

setStatus()

XapiProxy\XapiProxy::setStatus ( object  $obj )

private

Definition at line 272 of file XapiProxy.php.

                                           : void
    {
        //            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 ( object &  $obj, string  $path, string  $value  )

private

Definition at line 258 of file XapiProxy.php.

                                                                        : void
    {
        $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

$xapiProxyRequest

)

Definition at line 114 of file XapiProxy.php.

                                                                           : void
    {
        $this->xapiProxyRequest = $xapiProxyRequest;
    }

setXapiProxyResponse()

XapiProxy\XapiProxy::setXapiProxyResponse

(

XapiProxyResponse

$xapiProxyResponse

)

Definition at line 124 of file XapiProxy.php.

                                                                              : void
    {
        $this->xapiProxyResponse = $xapiProxyResponse;
    }

specificAllowedStatements()

XapiProxy\XapiProxy::specificAllowedStatements

(

)

Definition at line 61 of file XapiProxy.php.

                                               : ?array
    {
        return $this->specificAllowedStatements;
    }

token()

XapiProxy\XapiProxy::token

(

)

Definition at line 41 of file XapiProxy.php.

References $token.

                           : string
    {
        return $this->token;
    }

Field Documentation

$xapiProxyRequest

XapiProxyRequest XapiProxy\XapiProxy::$xapiProxyRequest

private

Definition at line 27 of file XapiProxy.php.

$xapiProxyResponse

XapiProxyResponse XapiProxy\XapiProxy::$xapiProxyResponse

private

Definition at line 28 of file XapiProxy.php.

---

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

• components/ILIAS/CmiXapi/classes/XapiProxy/XapiProxy.php