ilTestToplistGUI Class Reference

Collaboration diagram for ilTestToplistGUI:

Public Member Functions
	__construct (ilObjTest $testOBJ)
	executeCommand ()

Protected Member Functions
	showResultsToplistsCmd ()
	renderMedianMarkPanel ()
	renderResultsToplistByScore ()
	renderResultsToplistByTime ()
	buildTableGUI ()
	isTopTenRankingTableRequired ()
	isOwnRankingTableRequired ()

Protected Attributes
	$ctrl
	$tabs
	$tpl
	$lng
	$user
	$object
	$toplist

Private Attributes
	$uiFactory
	$uiRenderer

Detailed Description

Author

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Definition at line 12 of file class.ilTestToplistGUI.php.

Constructor & Destructor Documentation

__construct()

ilTestToplistGUI::__construct

(

ilObjTest

$testOBJ

)

Parameters

ilObjTest

$testOBJ

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

References $DIC, and user().

    {
        global $DIC;
        /* @var ILIAS\DI\Container $DIC */

        $this->ctrl = $DIC['ilCtrl'];
        $this->tpl = $DIC['tpl'];
        $this->lng = $DIC['lng'];
        $this->user = $DIC['ilUser'];
        $this->uiFactory = $DIC->ui()->factory();
        $this->uiRenderer = $DIC->ui()->renderer();

        $this->object = $testOBJ;
        $this->toplist = new ilTestTopList($testOBJ);
    }

Here is the call graph for this function:

Member Function Documentation

buildTableGUI()

ilTestToplistGUI::buildTableGUI ( )

protected

Returns

ilTestTopListTableGUI

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

Referenced by renderResultsToplistByScore(), and renderResultsToplistByTime().

                                       : ilTestTopListTableGUI
    {
        $table = new ilTestTopListTableGUI($this, $this->object);

        return $table;
    }

Here is the caller graph for this function:

executeCommand()

ilTestToplistGUI::executeCommand

(

)

Definition at line 55 of file class.ilTestToplistGUI.php.

References ilUtil\sendFailure(), and showResultsToplistsCmd().

                                     : void
    {
        if (!$this->object->getHighscoreEnabled()) {
            ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
            $this->ctrl->redirectByClass(ilObjTestGUI::class);
        }

        $this->ctrl->saveParameter($this, 'active_id');

        $cmd = $this->ctrl->getCmd();

        switch ($cmd) {
            default:
                $this->showResultsToplistsCmd();
        }
    }

Here is the call graph for this function:

isOwnRankingTableRequired()

ilTestToplistGUI::isOwnRankingTableRequired ( )

protected

Returns

bool

Definition at line 212 of file class.ilTestToplistGUI.php.

References ilObjTest\HIGHSCORE_SHOW_ALL_TABLES, and ilObjTest\HIGHSCORE_SHOW_OWN_TABLE.

Referenced by renderResultsToplistByScore(), and renderResultsToplistByTime().

                                                   : bool
    {
        if ($this->object->getHighscoreMode() == ilObjTest::HIGHSCORE_SHOW_OWN_TABLE) {
            return true;
        }

        if ($this->object->getHighscoreMode() == ilObjTest::HIGHSCORE_SHOW_ALL_TABLES) {
            return true;
        }

        return false;
    }

Here is the caller graph for this function:

isTopTenRankingTableRequired()

ilTestToplistGUI::isTopTenRankingTableRequired ( )

protected

Returns

bool

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

References ilObjTest\HIGHSCORE_SHOW_ALL_TABLES, and ilObjTest\HIGHSCORE_SHOW_TOP_TABLE.

Referenced by renderResultsToplistByScore(), and renderResultsToplistByTime().

                                                      : bool
    {
        if ($this->object->getHighscoreMode() == ilObjTest::HIGHSCORE_SHOW_TOP_TABLE) {
            return true;
        }

        if ($this->object->getHighscoreMode() == ilObjTest::HIGHSCORE_SHOW_ALL_TABLES) {
            return true;
        }

        return false;
    }

Here is the caller graph for this function:

renderMedianMarkPanel()

ilTestToplistGUI::renderMedianMarkPanel ( )

protected

Returns

string

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

References $data, and user().

Referenced by showResultsToplistsCmd().

                                               : string
    {
        $title = $this->lng->txt('tst_median_mark_panel');

        // BH: this really is the "mark of median" ??!
        $activeId = $this->object->getActiveIdOfUser($this->user->getId());
        $data = $this->object->getCompleteEvaluationData();
        $median = $data->getStatistics()->getStatistics()->median();
        $pct = $data->getParticipant($activeId)->getMaxpoints() ? ($median / $data->getParticipant($activeId)->getMaxpoints()) * 100.0 : 0;
        $mark = $this->object->mark_schema->getMatchingMark($pct);
        $content = $mark->getShortName();

        $panel = $this->uiFactory->panel()->standard(
            $title,
            $this->uiFactory->legacy($content)
        );

        return $this->uiRenderer->render($panel);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderResultsToplistByScore()

ilTestToplistGUI::renderResultsToplistByScore ( )

protected

Returns

string

Definition at line 107 of file class.ilTestToplistGUI.php.

References buildTableGUI(), isOwnRankingTableRequired(), isTopTenRankingTableRequired(), and user().

Referenced by showResultsToplistsCmd().

                                                     : string
    {
        $title = $this->lng->txt('toplist_by_score');
        $html = '';

        if ($this->isTopTenRankingTableRequired()) {
            $topData = $this->toplist->getGeneralToplistByPercentage(
                (int) $this->object->getRefId(),
                (int) $this->user->getId()
            );

            $table = $this->buildTableGUI();
            $table->setData($topData);
            $table->setTitle($title);

            $html .= $table->getHTML();
        }

        if ($this->isOwnRankingTableRequired()) {
            $ownData = $this->toplist->getUserToplistByPercentage(
                (int) $this->object->getRefId(),
                (int) $this->user->getId()
            );

            $table = $this->buildTableGUI();
            $table->setData($ownData);
            if (!$this->isTopTenRankingTableRequired()) {
                $table->setTitle($title);
            }

            $html .= $table->getHTML();
        }

        return $html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderResultsToplistByTime()

ilTestToplistGUI::renderResultsToplistByTime ( )

protected

Returns

string

Definition at line 146 of file class.ilTestToplistGUI.php.

References buildTableGUI(), isOwnRankingTableRequired(), isTopTenRankingTableRequired(), and user().

Referenced by showResultsToplistsCmd().

                                                    : string
    {
        $title = $this->lng->txt('toplist_by_time');
        $html = '';

        if ($this->isTopTenRankingTableRequired()) {
            $topData = $this->toplist->getGeneralToplistByWorkingtime(
                $this->object->getRefId(),
                $this->user->getId()
            );

            $table = $this->buildTableGUI();
            $table->setData($topData);
            $table->setTitle($title);

            $html .= $table->getHTML();
        }

        if ($this->isOwnRankingTableRequired()) {
            $ownData = $this->toplist->getUserToplistByWorkingtime(
                (int) $this->object->getRefId(),
                (int) $this->user->getId()
            );

            $table = $this->buildTableGUI();
            $table->setData($ownData);

            if (!$this->isTopTenRankingTableRequired()) {
                $table->setTitle($title);
            }

            $html .= $table->getHTML();
        }

        return $html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showResultsToplistsCmd()

ilTestToplistGUI::showResultsToplistsCmd ( )

protected

Definition at line 72 of file class.ilTestToplistGUI.php.

References renderMedianMarkPanel(), renderResultsToplistByScore(), and renderResultsToplistByTime().

Referenced by executeCommand().

                                                : void
    {
        $this->tpl->setContent(implode('', [
            $this->renderMedianMarkPanel(),
            $this->renderResultsToplistByScore(),
            $this->renderResultsToplistByTime(),
        ]));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilTestToplistGUI::$ctrl

protected

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

$lng

ilTestToplistGUI::$lng

protected

Definition at line 21 of file class.ilTestToplistGUI.php.

$object

ilTestToplistGUI::$object

protected

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

$tabs

ilTestToplistGUI::$tabs

protected

Definition at line 17 of file class.ilTestToplistGUI.php.

$toplist

ilTestToplistGUI::$toplist

protected

Definition at line 27 of file class.ilTestToplistGUI.php.

$tpl

ilTestToplistGUI::$tpl

protected

Definition at line 19 of file class.ilTestToplistGUI.php.

$uiFactory

ilTestToplistGUI::$uiFactory

private

Definition at line 29 of file class.ilTestToplistGUI.php.

$uiRenderer

ilTestToplistGUI::$uiRenderer

private

Definition at line 31 of file class.ilTestToplistGUI.php.

$user

ilTestToplistGUI::$user

protected

Definition at line 23 of file class.ilTestToplistGUI.php.

---

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

• Modules/Test/classes/class.ilTestToplistGUI.php