ilCmiXapiHighscoreReport Class Reference

Collaboration diagram for ilCmiXapiHighscoreReport:

Public Member Functions
	__construct (string $responseBody, int $objId)
	ilCmiXapiHighscoreReport constructor. More...
	initTableData ()
	getTableData ()
	getUserRank ()
	getResponseDebug ()

Protected Member Functions
	fetchTotalDuration (array $allDurations)

Protected Attributes
array	$response = []
int	$objId
array	$cmixUsersByIdent = []

Private Member Functions
	identUser (int $userIdent)
	formatRawTimestamp (string $rawTimestamp)

Private Attributes
array	$tableData = []
int	$userRank = null

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

ilCmiXapiHighscoreReport constructor.

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

    {
        $this->objId = $objId;
        $responseBody = json_decode($responseBody, true);
 
        if (is_array($responseBody) && count($responseBody)) {
            $this->response = $responseBody;
        } else {
            $this->response = array();
        }
 
        foreach (ilCmiXapiUser::getUsersForObject($objId) as $cmixUser) {
            $this->cmixUsersByIdent[$cmixUser->getUsrIdent()] = $cmixUser;
        }
    }

References $objId, and ilCmiXapiUser\getUsersForObject().

Here is the call graph for this function:

Member Function Documentation

fetchTotalDuration()

ilCmiXapiHighscoreReport::fetchTotalDuration ( array  $allDurations )

protected

Parameters

array

$allDurations

Returns

string

Definition at line 163 of file class.ilCmiXapiHighscoreReport.php.

                                                              : string
    {
        $totalDuration = 0;
 
        foreach ($allDurations as $duration) {
            $totalDuration += ilObjSCORM2004LearningModule::_ISODurationToCentisec($duration) / 100;
        }
 
        $hours = (string) floor($totalDuration / 3600);
        $hours = strlen($hours) < 2 ? "0" . $hours : $hours;
 
        return $hours . ":" . date('i:s', (int) round($totalDuration));
    }

References ilObjSCORM2004LearningModule\_ISODurationToCentisec().

Referenced by initTableData().

Here is the call graph for this function:

Here is the caller graph for this function:

formatRawTimestamp()

ilCmiXapiHighscoreReport::formatRawTimestamp ( string  $rawTimestamp )

private

Definition at line 177 of file class.ilCmiXapiHighscoreReport.php.

                                                             : string
    {
        $dateTime = ilCmiXapiDateTime::fromXapiTimestamp($rawTimestamp);
        return ilDatePresentation::formatDate($dateTime);
    }

References ilDatePresentation\formatDate(), and ilCmiXapiDateTime\fromXapiTimestamp().

Referenced by initTableData().

Here is the call graph for this function:

Here is the caller graph for this function:

getResponseDebug()

ilCmiXapiHighscoreReport::getResponseDebug

(

)

Definition at line 196 of file class.ilCmiXapiHighscoreReport.php.

                                      : string
    {
//        foreach($this->response as $key => $item)
//        {
//            $user = ilCmiXapiUser::getUserFromIdent(
//                ilObjectFactory::getInstanceByRefId($_GET['ref_id']),
//                $tableRowData['mbox']
//            );
//
//            $this->response[$key]['realname'] = $user->getFullname();
//        }
        return '<pre>' . json_encode($this->response, JSON_PRETTY_PRINT) . '</pre>';
    }

getTableData()

ilCmiXapiHighscoreReport::getTableData

(

)

Returns

mixed[]

Definition at line 186 of file class.ilCmiXapiHighscoreReport.php.

                                  : array
    {
        return $this->tableData;
    }

References $tableData.

getUserRank()

ilCmiXapiHighscoreReport::getUserRank

(

)

Definition at line 191 of file class.ilCmiXapiHighscoreReport.php.

                                 : ?int
    {
        return $this->userRank;
    }

References $userRank.

identUser()

ilCmiXapiHighscoreReport::identUser ( int  $userIdent )

private

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

                                              : bool
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
 
        $cmixUser = $this->cmixUsersByIdent[$userIdent];
 
        if ($cmixUser->getUsrId() == $DIC->user()->getId()) {
            return true;
        }
        return false;
    }

References $DIC.

initTableData()

ilCmiXapiHighscoreReport::initTableData

(

)

Definition at line 60 of file class.ilCmiXapiHighscoreReport.php.

                                   : bool
    {
        global $DIC;
 
        $rows = [];
        if (ilObject::_lookupType($this->objId) == 'cmix') {
            $obj = ilObjCmiXapi::getInstance($this->objId, false);
        } else {
            $obj = ilObjLTIConsumer::getInstance($this->objId, false);
        }
 
        if ($obj->isMixedContentType()) {
            foreach ($this->response as $item) {
                $userIdent = str_replace('mailto:', '', $item['mbox']);
                if (empty($userIdent)) {
                    $userIdent = $item['account'];
                }
                $cmixUser = $this->cmixUsersByIdent[$userIdent];
                $rows[] = [
                    'user_ident' => $userIdent,
                    'user' => '',
                    'date' => $this->formatRawTimestamp($item['timestamp']),
                    'duration' => $this->fetchTotalDuration($item['duration']),
                    'score' => $item['score']['scaled'],
                    'ilias_user_id' => $cmixUser->getUsrId()
                ];
            }
        } elseif ($obj->getContentType() == ilObjCmiXapi::CONT_TYPE_CMI5) {
            foreach ($this->response as $item) {
                $userIdent = $item['account'];
                $cmixUser = $this->cmixUsersByIdent[$userIdent];
                $rows[] = [
                    'user_ident' => $userIdent,
                    'user' => '',
                    'date' => $this->formatRawTimestamp($item['timestamp']),
                    'duration' => $this->fetchTotalDuration($item['duration']),
                    'score' => $item['score']['scaled'],
                    'ilias_user_id' => $cmixUser->getUsrId()
                ];
            }
        } else {
            foreach ($this->response as $item) {
                $userIdent = str_replace('mailto:', '', $item['mbox']);
                $cmixUser = $this->cmixUsersByIdent[$userIdent];
                $rows[] = [
                    'user_ident' => $userIdent,
                    'user' => '',
                    'date' => $this->formatRawTimestamp($item['timestamp']),
                    'duration' => $this->fetchTotalDuration($item['duration']),
                    'score' => $item['score']['scaled'],
                    'ilias_user_id' => $cmixUser->getUsrId()
                ];
            }
        }
        usort($rows, fn ($a, $b): int => $a['score'] != $b['score'] ? $a['score'] > $b['score'] ? -1 : 1 : 0);
 
        $i = 0;
        $prevScore = null;
        //$userRank = null;
        $retArr = [];
        foreach ($rows as $key => $item) {
            if ($prevScore !== $item['score']) {
                $i++;
            }
            $rows[$key]['rank'] = $i;
            $prevScore = $rows[$key]['score'];
            /* instantiate userObj until loginUserRank is unknown */
            if (null === $this->userRank) {
                /* just boolean */
                $userIdent = str_replace('mailto:', '', $rows[$key]['user_ident']);
                $cmixUser = $this->cmixUsersByIdent[$userIdent];
                if ($cmixUser->getUsrId() == $DIC->user()->getId()) {
                    $this->userRank = $key; //$rows[$key]['rank'];
                    $userObj = ilObjectFactory::getInstanceByObjId($cmixUser->getUsrId());
                    $rows[$key]['user'] = $userObj->getFullname();
                }
                $retArr[$key] = $rows[$key];
            } else {
                /* same same */
                $rows[$key]['user_ident'] = false;
                $retArr[$key] = $rows[$key];
            } // EOF if( null === $this->userRank )
        } // EOF foreach ($rows as $key => $item)
        $this->tableData = $retArr;
        return true;
    }

References Vendor\Package\$a, Vendor\Package\$b, $DIC, $i, ILIAS\LTI\ToolProvider\$key, $rows, ilObject\_lookupType(), ilObjCmiXapi\CONT_TYPE_CMI5, fetchTotalDuration(), formatRawTimestamp(), ilObjCmiXapi\getInstance(), ilObjLTIConsumer\getInstance(), and ilObjectFactory\getInstanceByObjId().

Here is the call graph for this function:

Field Documentation

$cmixUsersByIdent

array ilCmiXapiHighscoreReport::$cmixUsersByIdent = []

protected

Definition at line 39 of file class.ilCmiXapiHighscoreReport.php.

$objId

int ilCmiXapiHighscoreReport::$objId

protected

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

Referenced by __construct().

$response

array ilCmiXapiHighscoreReport::$response = []

protected

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

$tableData

array ilCmiXapiHighscoreReport::$tableData = []

private

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

Referenced by getTableData().

$userRank

int ilCmiXapiHighscoreReport::$userRank = null

private

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

Referenced by getUserRank().

---

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

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