ilCmiXapiAbstractRequest Class Reference

Inheritance diagram for ilCmiXapiAbstractRequest:

Collaboration diagram for ilCmiXapiAbstractRequest:

Public Member Functions
	__construct (string $basicAuth)
	ilCmiXapiAbstractRequest constructor. More...

Static Public Member Functions
static	checkResponse (array $response, &$body, array $allowedStatus=[200, 204])
static	buildQuery (array $params, $encoding=PHP_QUERY_RFC3986)

Static Public Attributes
static bool	$plugin = false

Protected Member Functions
	sendRequest (string $url)

Private Attributes
string	$basicAuth

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilCmiXapiAbstractRequest::__construct

(

string

$basicAuth

)

ilCmiXapiAbstractRequest constructor.

Definition at line 38 of file class.ilCmiXapiAbstractRequest.php.

References $basicAuth.

    {
        $this->basicAuth = $basicAuth;
    }

Member Function Documentation

buildQuery()

static ilCmiXapiAbstractRequest::buildQuery ( array  $params,   $encoding = PHP_QUERY_RFC3986  )

static

Definition at line 92 of file class.ilCmiXapiAbstractRequest.php.

Referenced by ilCmiXapiLaunchGUI\CMI5preLaunch(), and ilXapiStatementEvaluation\sendSatisfiedStatement().

                                                                                   : string
    {
        if ($params === []) {
            return '';
        }

        if ($encoding === false) {
            $encoder = fn ($str) => $str;
        } elseif ($encoding === PHP_QUERY_RFC3986) {
            $encoder = 'rawurlencode';
        } elseif ($encoding === PHP_QUERY_RFC1738) {
            $encoder = 'urlencode';
        } else {
            throw new \InvalidArgumentException('Invalid type');
        }

        $qs = '';
        foreach ($params as $k => $v) {
            $k = $encoder($k);
            if (!is_array($v)) {
                $qs .= $k;
                if ($v !== null) {
                    $qs .= '=' . $encoder($v);
                }
                $qs .= '&';
            } else {
                foreach ($v as $vv) {
                    $qs .= $k;
                    if ($vv !== null) {
                        $qs .= '=' . $encoder($vv);
                    }
                    $qs .= '&';
                }
            }
        }
        return $qs ? (string) substr($qs, 0, -1) : '';
    }

Here is the caller graph for this function:

checkResponse()

static ilCmiXapiAbstractRequest::checkResponse ( array  $response, &  $body, array  $allowedStatus = [200, 204]    )

static

Definition at line 70 of file class.ilCmiXapiAbstractRequest.php.

References Vendor\Package\$e, and ilObjCmiXapi\log().

Referenced by ilCmiXapiLaunchGUI\CMI5preLaunch(), ilObjCmiXapi\getLastStatement(), ilCmiXapiStatementsGUI\getVerbs(), and ilXapiStatementEvaluation\sendSatisfiedStatement().

                                                                                                    : bool
    {
        if ($response['state'] == 'fulfilled') {
            $status = $response['value']->getStatusCode();
            if (in_array($status, $allowedStatus)) {
                $body = $response['value']->getBody()->getContents();
                return true;
            } else {
                ilObjCmiXapi::log()->error("LRS error: " . $response['value']->getBody()->getContents());
                return false;
            }
        } else {
            try {
                ilObjCmiXapi::log()->error("Connection error: " . $response['reason']->getMessage());
            } catch (Exception $e) {
                ilObjCmiXapi::log()->error('error:' . $e->getMessage());
            }
            return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendRequest()

ilCmiXapiAbstractRequest::sendRequest ( string  $url )

protected

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

References $client, Vendor\Package\$e, and ilObjCmiXapi\log().

Referenced by ilCmiXapiStatementsReportRequest\queryReport(), and ilCmiXapiHighscoreReportRequest\queryReport().

                                               : string
    {
        $client = new GuzzleHttp\Client();
        $req_opts = array(
            GuzzleHttp\RequestOptions::VERIFY => true,
            GuzzleHttp\RequestOptions::CONNECT_TIMEOUT => 10,
            GuzzleHttp\RequestOptions::HTTP_ERRORS => false
        );
        ilObjCmiXapi::log()->debug($url);
        $request = new GuzzleHttp\Psr7\Request('GET', $url, [
            'Authorization' => $this->basicAuth,
            'X-Experience-API-Version' => '1.0.3'
        ]);
        try {
            $body = '';
            $promises = array();
            $promises['default'] = $client->sendAsync($request, $req_opts);
            $responses = GuzzleHttp\Promise\Utils::settle($promises)->wait();
            self::checkResponse($responses['default'], $body);
            return $body;
        } catch (Exception $e) {
            ilObjCmiXapi::log()->error($e->getMessage());
            throw new Exception("LRS Connection Problems", $e->getCode(), $e);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$basicAuth

string ilCmiXapiAbstractRequest::$basicAuth

private

Definition at line 32 of file class.ilCmiXapiAbstractRequest.php.

Referenced by __construct().

$plugin

bool ilCmiXapiAbstractRequest::$plugin = false

static

Definition at line 33 of file class.ilCmiXapiAbstractRequest.php.

---

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

• Modules/CmiXapi/classes/XapiReport/class.ilCmiXapiAbstractRequest.php