ilCmiXapiStatementsReport Class Reference

Collaboration diagram for ilCmiXapiStatementsReport:

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

Static Public Member Functions
static	getLanguageEntry ($obj, $userLanguage)

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

Protected Attributes
	$response
	$statements
	$maxCount
	$cmixUsersByIdent
	$userLanguage
	$contentType
	$isMixedContentType

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilCmiXapiStatementsReport::__construct	(	string	$responseBody,
			$obj
	)

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

References $DIC, and ilCmiXapiUser\getUsersForObject().

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

        $responseBody = json_decode($responseBody, true);

        if ($obj instanceof ilObjCmiXapi) {
            $this->contentType = $obj->getContentType();
//          $this->contentType = ilObjCmiXapi::getInstance($objId,false)->getContentType();
            $this->isMixedContentType = $obj->isMixedContentType();
//          $this->isMixedContentType = ilObjCmiXapi::getInstance($objId,false)->isMixedContentType();
        }
        if (count($responseBody)) {
            $this->response = current($responseBody);
            $this->statements = $this->response['statements'];
            $this->maxCount = $this->response['maxcount'];
        } else {
            $this->response = '';
            $this->statements = array();
            $this->maxCount = 0;
        }
        
        foreach (ilCmiXapiUser::getUsersForObject($obj->getId()) as $cmixUser) {
            $this->cmixUsersByIdent[$cmixUser->getUsrIdent()] = $cmixUser;
        }
    }

Here is the call graph for this function:

Member Function Documentation

fetchActor()

ilCmiXapiStatementsReport::fetchActor (   $statement )

protected

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

References ilObjCmiXapi\CONT_TYPE_CMI5.

Referenced by getTableData().

    {
        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 (   $statement )

protected

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

Referenced by getTableData().

    {
        return $statement['timestamp'];
    }

Here is the caller graph for this function:

fetchObjectInfo()

ilCmiXapiStatementsReport::fetchObjectInfo (   $statement )

protected

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

Referenced by getTableData().

    {
        return $statement['object']['definition']['description']['en-US'];
    }

Here is the caller graph for this function:

fetchObjectName()

ilCmiXapiStatementsReport::fetchObjectName (   $statement )

protected

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

References $lang, and $ret.

Referenced by getTableData().

    {
        $ret = urldecode($statement['object']['id']);
        $lang = self::getLanguageEntry($statement['object']['definition']['name'], $this->userLanguage);
        $langEntry = $lang['languageEntry'];
        if ($langEntry != '') {
            $ret = $langEntry;
        }
        return $ret;
    }

Here is the caller graph for this function:

fetchVerbDisplay()

ilCmiXapiStatementsReport::fetchVerbDisplay (   $statement )

protected

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

References Vendor\Package\$e.

Referenced by getTableData().

    {
        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 (   $statement )

protected

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

Referenced by getTableData().

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

Here is the caller graph for this function:

getLanguageEntry()

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

static

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

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

    {
        $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 79 of file class.ilCmiXapiStatementsReport.php.

References $maxCount.

    {
        return $this->maxCount;
    }

getStatements()

ilCmiXapiStatementsReport::getStatements

(

)

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

References $statements.

Referenced by ilXapiStatementEvaluation\evaluateReport().

    {
        return $this->statements;
    }

Here is the caller graph for this function:

getTableData()

ilCmiXapiStatementsReport::getTableData

(

)

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

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

    {
        $data = [];
        
        foreach ($this->statements as $index => $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 89 of file class.ilCmiXapiStatementsReport.php.

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

Field Documentation

$cmixUsersByIdent

ilCmiXapiStatementsReport::$cmixUsersByIdent

protected

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

$contentType

ilCmiXapiStatementsReport::$contentType

protected

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

$isMixedContentType

ilCmiXapiStatementsReport::$isMixedContentType

protected

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

$maxCount

ilCmiXapiStatementsReport::$maxCount

protected

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

Referenced by getMaxCount().

$response

ilCmiXapiStatementsReport::$response

protected

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

$statements

ilCmiXapiStatementsReport::$statements

protected

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

Referenced by getStatements().

$userLanguage

ilCmiXapiStatementsReport::$userLanguage

protected

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

Referenced by getLanguageEntry().

---

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

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