XapiProxy\XapiProxyPolyFill Class Reference

Inheritance diagram for XapiProxy\XapiProxyPolyFill:

Collaboration diagram for XapiProxy\XapiProxyPolyFill:

Public Member Functions
	__construct (string $client, string $token, ?bool $plugin=false)
	log ()
	msg (string $msg)
	initLrs ()

Data Fields
const	PARTS_REG = '/^(.*?xapiproxy\.php)(\/([^?]+)?\??(.*))/'
const	TERMINATED_VERB = "http://adlnet.gov/expapi/verbs/terminated"

Protected Attributes
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

Private Member Functions
	getLrsTypePlugin ()
	getLrsType ()
	getLrsTypeAndMoreByToken ()
	hybrid function, maybe two distinct functions would be better? More...

Detailed Description

Definition at line 22 of file XapiProxyPolyFill.php.

Constructor & Destructor Documentation

__construct()

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

Reimplemented in XapiProxy\XapiProxy.

Definition at line 57 of file XapiProxyPolyFill.php.

    {
        $this->client = $client;
        $this->token = $token;
        $this->plugin = $plugin;
        $this->table_prefix = $this->plugin ? "xxcf" : "cmix";
        preg_match(self::PARTS_REG, (string) $GLOBALS['DIC']->http()->request()->getUri(), $this->cmdParts);
        $this->method = strtolower($GLOBALS['DIC']->http()->request()->getMethod());
    }

References $client, $GLOBALS, XapiProxy\$plugin, $token, ILIAS\UI\examples\Progress\Bar\client(), and ILIAS\FileDelivery\http().

Here is the call graph for this function:

Member Function Documentation

getLrsType()

XapiProxy\XapiProxyPolyFill::getLrsType ( )

private

Returns

\ilCmiXapiLrsType|void|null

Definition at line 153 of file XapiProxyPolyFill.php.

                                 : \ilCmiXapiLrsType
    { // Core new > 6
        try {
            $lrsType = $this->getLrsTypeAndMoreByToken();
            $this->defaultLrsEndpoint = $lrsType->getLrsEndpoint();
            $this->defaultLrsKey = $lrsType->getLrsKey();
            $this->defaultLrsSecret = $lrsType->getLrsSecret();
            $this->lrsType = $lrsType;
            // one query IS better :-)
            // $lrsType = new ilCmiXapiLrsType($authToken->getLrsTypeId());
            $objId = $this->authToken->getObjId();
            $this->objId = $objId;
            if (!$lrsType->isAvailable()) {
                throw new \ilCmiXapiException(
                    'lrs endpoint (id=' . $this->authToken->getLrsTypeId() . ') unavailable (responded 401-unauthorized)'
                );
            }
        } catch (\ilCmiXapiException $e) {
            $this->log()->error($this->msg($e->getMessage()));
            header('Access-Control-Allow-Origin: ' . $_SERVER["HTTP_ORIGIN"]);
            header('Access-Control-Allow-Credentials: true');
            header('HTTP/1.1 401 Unauthorized');
            exit;
        }
        \ilCmiXapiUser::saveProxySuccess($this->authToken->getObjId(), $this->authToken->getUsrId(), $this->lrsType->getPrivacyIdent());
        return $lrsType;
    }

References $_SERVER, Vendor\Package\$e, $objId, exit, ILIAS\UI\examples\Symbol\Glyph\Header\header(), and ilCmiXapiUser\saveProxySuccess().

Here is the call graph for this function:

getLrsTypeAndMoreByToken()

XapiProxy\XapiProxyPolyFill::getLrsTypeAndMoreByToken ( )

private

hybrid function, maybe two distinct functions would be better?

Returns

\ilCmiXapiLrsType|null

Definition at line 185 of file XapiProxyPolyFill.php.

                                               : ?\ilCmiXapiLrsType
    {
        $type_id = null;
        $lrs = null;
        $db = $GLOBALS['DIC']->database();
        $query = "SELECT {$this->table_prefix}_settings.lrs_type_id,
                                {$this->table_prefix}_settings.only_moveon,
                                {$this->table_prefix}_settings.achieved,
                                {$this->table_prefix}_settings.answered,
                                {$this->table_prefix}_settings.completed,
                                {$this->table_prefix}_settings.failed,
                                {$this->table_prefix}_settings.initialized,
                                {$this->table_prefix}_settings.passed,
                                {$this->table_prefix}_settings.progressed,
                                {$this->table_prefix}_settings.satisfied,
                                {$this->table_prefix}_settings.c_terminated,
                                {$this->table_prefix}_settings.hide_data,
                                {$this->table_prefix}_settings.c_timestamp,
                                {$this->table_prefix}_settings.duration,
                                {$this->table_prefix}_settings.no_substatements,
                                {$this->table_prefix}_settings.privacy_ident
                        FROM {$this->table_prefix}_settings, {$this->table_prefix}_token
                        WHERE {$this->table_prefix}_settings.obj_id = {$this->table_prefix}_token.obj_id AND {$this->table_prefix}_token.token = " . $db->quote($this->token, 'text');
 
        $res = $db->query($query);
        while ($row = $db->fetchObject($res)) {
            $type_id = (int) $row->lrs_type_id;
            if ($type_id) {
                //                    $lrs = ($this->plugin) ? new \ilXapiCmi5LrsType($type_id) : new \ilCmiXapiLrsType($type_id);
                $lrs = new \ilCmiXapiLrsType($type_id);
            }
 
            $sarr = [];
            if ((bool) $row->only_moveon) {
                if ((bool) $row->achieved) {
                    $sarr[] = "https://w3id.org/xapi/dod-isd/verbs/achieved";
                }
                if ((bool) $row->answered) {
                    $sarr[] = "http://adlnet.gov/expapi/verbs/answered";
                    $sarr[] = "https://w3id.org/xapi/dod-isd/verbs/answered";
                }
                if ((bool) $row->completed) {
                    $sarr[] = "http://adlnet.gov/expapi/verbs/completed";
                    $sarr[] = "https://w3id.org/xapi/dod-isd/verbs/completed";
                }
                if ((bool) $row->failed) {
                    $sarr[] = "http://adlnet.gov/expapi/verbs/failed";
                }
                if ((bool) $row->initialized) {
                    $sarr[] = "http://adlnet.gov/expapi/verbs/initialized";
                    $sarr[] = "https://w3id.org/xapi/dod-isd/verbs/initialized";
                }
                if ((bool) $row->passed) {
                    $sarr[] = "http://adlnet.gov/expapi/verbs/passed";
                }
                if ((bool) $row->progressed) {
                    $sarr[] = "http://adlnet.gov/expapi/verbs/progressed";
                }
                if ((bool) $row->satisfied) {
                    $sarr[] = "https://w3id.org/xapi/adl/verbs/satisfied";
                }
                if ((bool) $row->c_terminated) {
                    $sarr[] = "http://adlnet.gov/expapi/verbs/terminated";
                }
                if (count($sarr) > 0) {
                    $this->specificAllowedStatements = $sarr;
                    $this->log()->debug($this->msg('getSpecificAllowedStatements: ' . var_export($this->specificAllowedStatements, true)));
                }
            }
            if ((bool) $row->hide_data) {
                $rarr = array();
                if ((bool) $row->c_timestamp) {
                    $rarr['timestamp'] = '1970-01-01T00:00:00.000Z';
                }
                if ((bool) $row->duration) {
                    $rarr['result.duration'] = 'PT00.000S';
                }
                if (count($rarr) > 0) {
                    $this->replacedValues = $rarr;
                    $this->log()->debug($this->msg('getReplacedValues: ' . var_export($this->replacedValues, true)));
                }
            }
            if ((bool) $row->no_substatements) {
                $this->blockSubStatements = true;
                $this->log()->debug($this->msg('getBlockSubStatements: ' . $this->blockSubStatements));
            }
            $lrs->setPrivacyIdent((int) $row->privacy_ident);
        }
        return $lrs;
    }

References $GLOBALS, $res, if, and ILIAS\Repository\int().

Here is the call graph for this function:

getLrsTypePlugin()

XapiProxy\XapiProxyPolyFill::getLrsTypePlugin ( )

private

Definition at line 119 of file XapiProxyPolyFill.php.

                                       : void
    {
        try {
            $lrsType = $this->getLrsTypeAndMoreByToken();
            if ($lrsType == null) {
                // why not using $log?
                $GLOBALS['DIC']->logger()->root()->log("XapiCmi5Plugin: 401 Unauthorized for token");
                header('HTTP/1.1 401 Unauthorized');
                header('Access-Control-Allow-Origin: ' . $_SERVER["HTTP_ORIGIN"]);
                header('Access-Control-Allow-Credentials: true');
                exit;
            }
            //                $this->defaultLrsEndpoint = $lrsType->getDefaultLrsEndpoint();
            //                $this->defaultLrsKey = $lrsType->getDefaultLrsKey();
            //                $this->defaultLrsSecret = $lrsType->getDefaultLrsSecret();
            //
            //                $this->fallbackLrsEndpoint = $lrsType->getFallbackLrsEndpoint();
            //                $this->fallbackLrsKey = $lrsType->getFallbackLrsKey();
            //                $this->fallbackLrsSecret = $lrsType->getFallbackLrsSecret();
 
            $this->lrsType = $lrsType;
        } catch (\Exception $e) {
            // why not using $log?
            $GLOBALS['DIC']->logger()->root()->log("XapiCmi5Plugin: " . $e->getMessage());
            header('HTTP/1.1 401 Unauthorized');
            header('Access-Control-Allow-Origin: ' . $_SERVER["HTTP_ORIGIN"]);
            header('Access-Control-Allow-Credentials: true');
            exit;
        }
    }

References $_SERVER, Vendor\Package\$e, $GLOBALS, exit, and ILIAS\UI\examples\Symbol\Glyph\Header\header().

Here is the call graph for this function:

initLrs()

XapiProxy\XapiProxyPolyFill::initLrs

(

)

Definition at line 86 of file XapiProxyPolyFill.php.

                             : void
    {
        $this->log()->debug($this->msg('initLrs'));
        //            if ($this->plugin) {
        //                try {
        //                    $authToken = \ilXapiCmi5AuthToken::getInstanceByToken($this->token);
        //                }
        //                catch (\ilXapiCmi5Exception $e) {
        //                    $this->log()->error($this->msg($e->getMessage()));
        //                    header('HTTP/1.1 401 Unauthorized');
        //                    header('Access-Control-Allow-Origin: '.$_SERVER["HTTP_ORIGIN"]);
        //                    header('Access-Control-Allow-Credentials: true');
        //                    exit;
        //                }
        //                $this->authToken = $authToken;
        //                $this->getLrsTypePlugin();
        //            }
        //            else {
        try {
            $authToken = \ilCmiXapiAuthToken::getInstanceByToken($this->token);
        } catch (\ilCmiXapiException $e) {
            $this->log()->error($this->msg($e->getMessage()));
            header('HTTP/1.1 401 Unauthorized');
            header('Access-Control-Allow-Origin: ' . $_SERVER["HTTP_ORIGIN"]);
            header('Access-Control-Allow-Credentials: true');
            exit;
        }
 
        $this->authToken = $authToken;
        $this->getLrsType();
        //            }
    }

References $_SERVER, Vendor\Package\$e, exit, ilCmiXapiAuthToken\getInstanceByToken(), and ILIAS\UI\examples\Symbol\Glyph\Header\header().

Here is the call graph for this function:

log()

XapiProxy\XapiProxyPolyFill::log

(

)

Definition at line 67 of file XapiProxyPolyFill.php.

                         : \ilLogger
    {
        if ($this->plugin) {
            global $log;
            return $log;
        } else {
            return \ilLoggerFactory::getLogger('cmix');
        }
    }

References $log.

msg()

XapiProxy\XapiProxyPolyFill::msg

(

string

$msg

)

Definition at line 77 of file XapiProxyPolyFill.php.

                                    : string
    {
        if ($this->plugin) {
            return "XapiCmi5Plugin: " . $msg;
        } else {
            return $msg;
        }
    }

Field Documentation

$authToken

ilCmiXapiAuthToken XapiProxy\XapiProxyPolyFill::$authToken = null

protected

Definition at line 30 of file XapiProxyPolyFill.php.

$blockSubStatements

bool XapiProxy\XapiProxyPolyFill::$blockSubStatements = false

protected

Definition at line 34 of file XapiProxyPolyFill.php.

$client

string XapiProxy\XapiProxyPolyFill::$client

protected

Definition at line 24 of file XapiProxyPolyFill.php.

$cmdParts

array XapiProxy\XapiProxyPolyFill::$cmdParts = []

protected

Definition at line 35 of file XapiProxyPolyFill.php.

$defaultLrsEndpoint

string XapiProxy\XapiProxyPolyFill::$defaultLrsEndpoint = ''

protected

Definition at line 38 of file XapiProxyPolyFill.php.

$defaultLrsKey

string XapiProxy\XapiProxyPolyFill::$defaultLrsKey = ''

protected

Definition at line 39 of file XapiProxyPolyFill.php.

$defaultLrsSecret

string XapiProxy\XapiProxyPolyFill::$defaultLrsSecret = ''

protected

Definition at line 40 of file XapiProxyPolyFill.php.

$fallbackLrsEndpoint

string XapiProxy\XapiProxyPolyFill::$fallbackLrsEndpoint = ''

protected

Definition at line 42 of file XapiProxyPolyFill.php.

$fallbackLrsKey

string XapiProxy\XapiProxyPolyFill::$fallbackLrsKey = ''

protected

Definition at line 43 of file XapiProxyPolyFill.php.

$fallbackLrsSecret

string XapiProxy\XapiProxyPolyFill::$fallbackLrsSecret = ''

protected

Definition at line 44 of file XapiProxyPolyFill.php.

$lrsType

ilCmiXapiLrsType XapiProxy\XapiProxyPolyFill::$lrsType = null

protected

Definition at line 29 of file XapiProxyPolyFill.php.

$method

string XapiProxy\XapiProxyPolyFill::$method

protected

Definition at line 36 of file XapiProxyPolyFill.php.

$objId

int XapiProxy\XapiProxyPolyFill::$objId = null

protected

Definition at line 31 of file XapiProxyPolyFill.php.

$plugin

bool XapiProxy\XapiProxyPolyFill::$plugin = false

protected

Definition at line 27 of file XapiProxyPolyFill.php.

$replacedValues

array XapiProxy\XapiProxyPolyFill::$replacedValues = null

protected

Definition at line 33 of file XapiProxyPolyFill.php.

$sniffVerbs

array XapiProxy\XapiProxyPolyFill::$sniffVerbs

protected

Initial value:

= array(
        "http://adlnet.gov/expapi/verbs/completed" => "completed",
        "http://adlnet.gov/expapi/verbs/passed" => "passed",
        "http://adlnet.gov/expapi/verbs/failed" => "failed",
        "http://adlnet.gov/expapi/verbs/satisfied" => "passed"
    )

Definition at line 48 of file XapiProxyPolyFill.php.

$specificAllowedStatements

array XapiProxy\XapiProxyPolyFill::$specificAllowedStatements = null

protected

Definition at line 32 of file XapiProxyPolyFill.php.

$table_prefix

string XapiProxy\XapiProxyPolyFill::$table_prefix

protected

Definition at line 28 of file XapiProxyPolyFill.php.

$token

string XapiProxy\XapiProxyPolyFill::$token

protected

Definition at line 25 of file XapiProxyPolyFill.php.

PARTS_REG

const XapiProxy\XapiProxyPolyFill::PARTS_REG = '/^(.*?xapiproxy\.php)(\/([^?]+)?\??(.*))/'

Definition at line 46 of file XapiProxyPolyFill.php.

TERMINATED_VERB

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

Definition at line 55 of file XapiProxyPolyFill.php.

---

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

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