Collaboration diagram for ilLTIConsumerScoringGUI:

Public Member Functions
	__construct (ilObjLTIConsumer $object)

	executeCommand ()

	getObject ()

Data Fields
const	PART_FILTER_ACTIVE_ONLY = 1

const	PART_FILTER_INACTIVE_ONLY = 2

const	PART_FILTER_ALL_USERS = 3

const	PART_FILTER_MANSCORING_DONE = 4

const	PART_FILTER_MANSCORING_NONE = 5

Protected Member Functions
	showCmd ()

	initTableData ()

	initHighScoreTable ()

	initUserRankTable ()

	buildTableGUI ($tableId)

Protected Attributes
	$object

	$access

Private Member Functions
	getTableDataRange ($scopeUserRank=false)

Private Attributes
	$tableData

	$tableHtml = ''

	$userRank

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilLTIConsumerScoringGUI::__construct ( ilObjLTIConsumer $object )

Parameters

ilObjLTIConsumer $object

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

    {
        $this->object = $object;
 
        $this->access = ilLTIConsumerAccess::getInstance($this->object);
    }

References $object, and ilLTIConsumerAccess\getInstance().

Here is the call graph for this function:

Member Function Documentation

◆ buildTableGUI()

ilLTIConsumerScoringGUI::buildTableGUI ( $tableId )

protected

Parameters

string $tableId

Returns: ilLTIConsumerScoringTableGUI

Definition at line 179 of file class.ilLTIConsumerScoringGUI.php.

                                               : ilLTIConsumerScoringTableGUI
    {
        $isMultiActorReport = $this->access->hasOutcomesAccess();
        $table = new ilLTIConsumerScoringTableGUI(
            $this,
            'show',
            $isMultiActorReport,
            $tableId,
            $this->access->hasOutcomesAccess()
        );
        return $table;
    }

Referenced by initHighScoreTable(), initUserRankTable(), and showCmd().

Here is the caller graph for this function:

◆ executeCommand()

ilLTIConsumerScoringGUI::executeCommand ( )

Exceptions

ilCmiXapiException

Definition at line 53 of file class.ilLTIConsumerScoringGUI.php.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
    
        if (!$this->access->hasHighscoreAccess()) {
            throw new ilCmiXapiException('access denied!');
        }
 
        switch ($DIC->ctrl()->getNextClass($this)) {
            default:
                $cmd = $DIC->ctrl()->getCmd('show') . 'Cmd';
                $this->{$cmd}();
        }
    }

References $DIC.

◆ getObject()

ilLTIConsumerScoringGUI::getObject ( )

Returns: ilObjLTIConsumer

Definition at line 195 of file class.ilLTIConsumerScoringGUI.php.

    {
        return $this->object;
    }

References $object.

◆ getTableDataRange()

ilLTIConsumerScoringGUI::getTableDataRange ( $scopeUserRank = false )

private

Parameters

bool $scopeUserRank

Returns: array

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

    {
        if (false === $scopeUserRank) {
            return array_slice($this->tableData, 0, (int) $this->object->getHighscoreTopNum());
        } else {
            $offset = $this->userRank - 2 < 0 ? 0 : $this->userRank - 2;
            $length = 5;
            return array_slice($this->tableData, $offset, $length);
        }
        return [];
    }

Referenced by initHighScoreTable(), and initUserRankTable().

Here is the caller graph for this function:

◆ initHighScoreTable()

ilLTIConsumerScoringGUI::initHighScoreTable ( )

protected

Returns: $this

Definition at line 148 of file class.ilLTIConsumerScoringGUI.php.

    {
        if (!$this->object->getHighscoreTopTable() || !$this->object->getHighscoreEnabled()) {
            $this->tableHtml .= '';
            return $this;
        }
        $table = $this->buildTableGUI('highscore');
        $table->setData($this->getTableDataRange());
        $this->tableHtml .= $table->getHTML();
        return $this;
    }

References buildTableGUI(), and getTableDataRange().

Here is the call graph for this function:

◆ initTableData()

ilLTIConsumerScoringGUI::initTableData ( )

protected

Returns: $this

Definition at line 93 of file class.ilLTIConsumerScoringGUI.php.

    {
        $aggregateEndPointUrl = str_replace(
            'data/xAPI',
            'api/statements/aggregate',
            $this->object->getProvider()->getXapiLaunchUrl() // should be named endpoint not launch url
        );
 
        $basicAuth = ilCmiXapiLrsType::buildBasicAuth(
            $this->object->getProvider()->getXapiLaunchKey(),
            $this->object->getProvider()->getXapiLaunchSecret()
        );
 
        $filter = new ilCmiXapiStatementsReportFilter();
        $filter->setActivityId($this->object->getActivityId());
        
        $linkBuilder = new ilCmiXapiHighscoreReportLinkBuilder(
            $this->object,
            $aggregateEndPointUrl,
            $filter
        );
 
        $request = new ilCmiXapiHighscoreReportRequest(
            $basicAuth,
            $linkBuilder
        );
 
        $scoringReport = $request->queryReport($this->object);
 
        if (true === $scoringReport->initTableData()) {
            $this->tableData = $scoringReport->getTableData();
            $this->userRank = $scoringReport->getUserRank();
        }
        return $this;
    }

References ilCmiXapiLrsType\buildBasicAuth().

Referenced by showCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUserRankTable()

ilLTIConsumerScoringGUI::initUserRankTable ( )

protected

Returns: $this

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

    {
        if (!$this->object->getHighscoreOwnTable() || !$this->object->getHighscoreEnabled()) {
            $this->tableHtml .= '';
            return $this;
        }
        $table = $this->buildTableGUI('userRank');
        $table->setData($this->getTableDataRange(true));
        $this->tableHtml .= $table->getHTML();
        return $this;
    }

References buildTableGUI(), and getTableDataRange().

Here is the call graph for this function:

◆ showCmd()

ilLTIConsumerScoringGUI::showCmd ( )

protected

Definition at line 68 of file class.ilLTIConsumerScoringGUI.php.

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
 
        try {
            $this->initTableData()
                ->initHighScoreTable()
                ->initUserRankTable()
            ;
        } catch (Exception $e) {
            ilUtil::sendFailure($e->getMessage());
            //$DIC->ui()->mainTemplate()->
            $table = $this->buildTableGUI('fallback');
            $table->setData(array());
            $table->setMaxCount(0);
            $table->resetOffset();
            $this->tableHtml = $table->getHTML();
        }
 
        $DIC->ui()->mainTemplate()->setContent($this->tableHtml);
    }