ilCmiXapiStatementsReport Class Reference

Collaboration diagram for ilCmiXapiStatementsReport:

Public Member Functions
	__construct (string $responseBody, int $objId)
	getMaxCount ()
	getStatements ()
	hasStatements ()
	getTableData ()

Static Public Member Functions
static	getLanguageEntry (array $obj, string $userLanguage)
	with multiple language keys like [de-DE] [en-US] More...

Protected Member Functions
	fetchDate (array $statement)
	fetchActor (array $statement)
	fetchVerbId (array $statement)
	fetchVerbDisplay (array $statement)
	fetchObjectName (array $statement)
	fetchObjectInfo (array $statement)

Protected Attributes
array	$response
array	$statements
int	$maxCount
array	$cmixUsersByIdent
string	$userLanguage
string	$contentType
bool	$isMixedContentType

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilCmiXapiStatementsReport::__construct	(	string	$responseBody,
		int	$objId
	)

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

References $DIC, ilObject\_lookupType(), ilObjCmiXapi\CONT_TYPE_GENERIC, ilObjCmiXapi\getInstance(), ilObjLTIConsumer\getInstance(), and ilCmiXapiUser\getUsersForObject().

    {
        global $DIC;
        $this->userLanguage = $DIC->user()->getLanguage();

        $responseBody = json_decode($responseBody, true);

        if (ilObject::_lookupType($objId) == 'lti') {
            $this->contentType = ilObjCmiXapi::CONT_TYPE_GENERIC;
            $this->isMixedContentType = ilObjLTIConsumer::getInstance($objId, false)->isMixedContentType();
        } else {
            $this->contentType = ilObjCmiXapi::getInstance($objId, false)->getContentType();
            $this->isMixedContentType = ilObjCmiXapi::getInstance($objId, false)->isMixedContentType();
        }

        if (is_array($responseBody) && count($responseBody) > 0) {
            $this->response = current($responseBody);
            $this->statements = $this->response['statements'];
            $this->maxCount = $this->response['maxcount'];
        } else {
            $this->response = array();
            $this->statements = array();
            $this->maxCount = 0;
        }

        foreach (ilCmiXapiUser::getUsersForObject($objId) as $cmixUser) {
            $this->cmixUsersByIdent[$cmixUser->getUsrIdent()] = $cmixUser;
        }
    }

Here is the call graph for this function:

Member Function Documentation

fetchActor()

ilCmiXapiStatementsReport::fetchActor ( array  $statement )

protected

Definition at line 129 of file class.ilCmiXapiStatementsReport.php.

References ilObjCmiXapi\CONT_TYPE_CMI5.

Referenced by getTableData().

                                                   : \ilCmiXapiUser
    {
        if ($this->isMixedContentType) {
            $ident = str_replace('mailto:', '', $statement['actor']['mbox']);
            if (empty($ident)) {
                $ident = $statement['actor']['account']['name'];
            }
        } elseif ($this->contentType == ilObjCmiXapi::CONT_TYPE_CMI5) {
            $ident = $statement['actor']['account']['name'];
        } else {
            $ident = str_replace('mailto:', '', $statement['actor']['mbox']);
        }
        return $this->cmixUsersByIdent[$ident];
    }

Here is the caller graph for this function:

fetchDate()

ilCmiXapiStatementsReport::fetchDate ( array  $statement )

protected

Returns

mixed

Definition at line 124 of file class.ilCmiXapiStatementsReport.php.

Referenced by getTableData().

                                                  : string
    {
        return $statement['timestamp'];
    }

Here is the caller graph for this function:

fetchObjectInfo()

ilCmiXapiStatementsReport::fetchObjectInfo ( array  $statement )

protected

Definition at line 180 of file class.ilCmiXapiStatementsReport.php.

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

Referenced by getTableData().

                                                        : ?string
    {
        try {
            return $statement['object']['definition']['description']['en-US'];
        } catch (Exception $e) {
            ilObjCmiXapi::log()->debug('debug:' . $e->getMessage());
            return "";
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchObjectName()

ilCmiXapiStatementsReport::fetchObjectName ( array  $statement )

protected

Definition at line 158 of file class.ilCmiXapiStatementsReport.php.

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

Referenced by getTableData().

                                                        : string
    {
        try {
            $ret = urldecode($statement['object']['id']);
            if (array_key_exists('definition', $statement['object'])) {
                if (array_key_exists('name', $statement['object']['definition'])) {
                    $lang = self::getLanguageEntry($statement['object']['definition']['name'], $this->userLanguage);
                    if (array_key_exists('languageEntry', $lang)) {
                        $langEntry = $lang['languageEntry'];
                        if ($langEntry != '') {
                            $ret = $langEntry;
                        }
                    }
                }
            }
            return $ret;
        } catch (Exception $e) {
            ilObjCmiXapi::log()->error('error:' . $e->getMessage());
            return "";
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchVerbDisplay()

ilCmiXapiStatementsReport::fetchVerbDisplay ( array  $statement )

protected

Definition at line 149 of file class.ilCmiXapiStatementsReport.php.

References Vendor\Package\$e.

Referenced by getTableData().

                                                         : string
    {
        try {
            return $statement['verb']['display']['en-US'];
        } catch (Exception $e) {
            return $statement['verb']['id'];
        }
    }

Here is the caller graph for this function:

fetchVerbId()

ilCmiXapiStatementsReport::fetchVerbId ( array  $statement )

protected

Definition at line 144 of file class.ilCmiXapiStatementsReport.php.

Referenced by getTableData().

                                                    : string
    {
        return $statement['verb']['id'];
    }

Here is the caller graph for this function:

getLanguageEntry()

static ilCmiXapiStatementsReport::getLanguageEntry ( array  $obj, string  $userLanguage  )

static

with multiple language keys like [de-DE] [en-US]

Returns

array<string, mixed>

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

References $defaultLanguage, Vendor\Package\$e, Vendor\Package\$f, and $userLanguage.

                                                                             : array
    {
        $defaultLanguage = 'en-US';
        $defaultLanguageEntry = '';
        $defaultLanguageExists = false;
        $firstLanguage = '';
        $firstLanguageEntry = '';
        $firstLanguageExists = false;
        $userLanguage = '';
        $userLanguageEntry = '';
        $userLanguageExists = false;
        $language = '';
        $languageEntry = '';
        try {
            foreach ($obj as $k => $v) {
                // save $firstLanguage
                if ($firstLanguage == '') {
                    $f = '/^[a-z]+-?.*/';
                    if (preg_match($f, $k)) {
                        $firstLanguageExists = true;
                        $firstLanguage = $k;
                        $firstLanguageEntry = $v;
                    }
                }
                // check defaultLanguage
                if ($k == $defaultLanguage) {
                    $defaultLanguageExists = true;
                    $defaultLanguageEntry = $v;
                }
                // check userLanguage
                $p = '/^' . $userLanguage . '-?./';
                preg_match($p, $k);
                if (preg_match($p, $k)) {
                    $userLanguageExists = true;
                    $userLanguage = $k;
                    $userLanguageEntry = $v;
                }
            }
        } catch (Exception $e) {
        };

        if ($userLanguageExists) {
            $language = $userLanguage;
            $languageEntry = $userLanguageEntry;
        } elseif ($defaultLanguageExists) {
            $language = $userLanguage;
            $languageEntry = $userLanguageEntry;
        } elseif ($firstLanguageExists) {
            $language = $firstLanguage;
            $languageEntry = $firstLanguageEntry;
        }
        return ['language' => $language, 'languageEntry' => $languageEntry];
    }

getMaxCount()

ilCmiXapiStatementsReport::getMaxCount

(

)

Definition at line 81 of file class.ilCmiXapiStatementsReport.php.

References $maxCount.

                                 : int
    {
        return $this->maxCount;
    }

getStatements()

ilCmiXapiStatementsReport::getStatements

(

)

Returns

mixed[]

Definition at line 89 of file class.ilCmiXapiStatementsReport.php.

References $statements.

Referenced by ilXapiStatementEvaluation\evaluateReport().

                                   : array
    {
        return $this->statements;
    }

Here is the caller graph for this function:

getTableData()

ilCmiXapiStatementsReport::getTableData

(

)

Returns

array<int, array<string, mixed>>

Definition at line 102 of file class.ilCmiXapiStatementsReport.php.

References $data, fetchActor(), fetchDate(), fetchObjectInfo(), fetchObjectName(), fetchVerbDisplay(), and fetchVerbId().

                                  : array
    {
        $data = [];

        foreach ($this->statements as $statement) {
            $data[] = [
                'date' => $this->fetchDate($statement),
                'actor' => $this->fetchActor($statement),
                'verb_id' => $this->fetchVerbId($statement),
                'verb_display' => $this->fetchVerbDisplay($statement),
                'object' => $this->fetchObjectName($statement),
                'object_info' => $this->fetchObjectInfo($statement),
                'statement' => json_encode($statement, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)
            ];
        }

        return $data;
    }

Here is the call graph for this function:

hasStatements()

ilCmiXapiStatementsReport::hasStatements

(

)

Definition at line 94 of file class.ilCmiXapiStatementsReport.php.

                                   : bool
    {
        return (bool) count($this->statements);
    }

Field Documentation

$cmixUsersByIdent

array ilCmiXapiStatementsReport::$cmixUsersByIdent

protected

Definition at line 41 of file class.ilCmiXapiStatementsReport.php.

$contentType

string ilCmiXapiStatementsReport::$contentType

protected

Definition at line 47 of file class.ilCmiXapiStatementsReport.php.

$isMixedContentType

bool ilCmiXapiStatementsReport::$isMixedContentType

protected

Definition at line 49 of file class.ilCmiXapiStatementsReport.php.

$maxCount

int ilCmiXapiStatementsReport::$maxCount

protected

Definition at line 36 of file class.ilCmiXapiStatementsReport.php.

Referenced by getMaxCount().

$response

array ilCmiXapiStatementsReport::$response

protected

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

$statements

array ilCmiXapiStatementsReport::$statements

protected

Definition at line 34 of file class.ilCmiXapiStatementsReport.php.

Referenced by getStatements().

$userLanguage

string ilCmiXapiStatementsReport::$userLanguage

protected

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

Referenced by getLanguageEntry().

---

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

• components/ILIAS/CmiXapi/classes/XapiReport/class.ilCmiXapiStatementsReport.php