ilTestToplistGUI Class Reference

Collaboration diagram for ilTestToplistGUI:

Public Member Functions
	__construct (private ilObjTest $test_obj, private ilTestTopList $toplist, private ilCtrl $ctrl, private ilGlobalTemplateInterface $tpl, private ilLanguage $lng, private ilObjUser $user, private UIFactory $ui_factory, private UIRenderer $ui_renderer)
	executeCommand ()

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

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilTestToplistGUI::__construct	(	private ilObjTest	$test_obj,
		private ilTestTopList	$toplist,
		private ilCtrl	$ctrl,
		private ilGlobalTemplateInterface	$tpl,
		private ilLanguage	$lng,
		private ilObjUser	$user,
		private UIFactory	$ui_factory,
		private UIRenderer	$ui_renderer
	)

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

      {
    }

Member Function Documentation

buildTableGUI()

ilTestToplistGUI::buildTableGUI ( )

protected

Returns

ilTestTopListTableGUI

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

Referenced by renderResultsToplistByScore(), and renderResultsToplistByTime().

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

        return $table;
    }

Here is the caller graph for this function:

executeCommand()

ilTestToplistGUI::executeCommand

(

)

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and showResultsToplistsCmd().

                                    : void
    {
        if (!$this->test_obj->getHighscoreEnabled()) {
            $this->tpl->setOnScreenMessage('failure', $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 194 of file class.ilTestToplistGUI.php.

Referenced by renderResultsToplistByScore(), and renderResultsToplistByTime().

                                                  : bool
    {
        return $this->test_obj->getHighscoreOwnTable();
    }

Here is the caller graph for this function:

isTopTenRankingTableRequired()

ilTestToplistGUI::isTopTenRankingTableRequired ( )

protected

Returns

bool

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

Referenced by renderResultsToplistByScore(), and renderResultsToplistByTime().

                                                     : bool
    {
        return $this->test_obj->getHighscoreTopTable();
    }

Here is the caller graph for this function:

renderMedianMarkPanel()

ilTestToplistGUI::renderMedianMarkPanel ( )

protected

Returns

string

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

References $data, ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by showResultsToplistsCmd().

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

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

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

        return $this->ui_renderer->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 97 of file class.ilTestToplistGUI.php.

References buildTableGUI(), ILIAS\Repository\int(), isOwnRankingTableRequired(), isTopTenRankingTableRequired(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by showResultsToplistsCmd().

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

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

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

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

        if ($this->isOwnRankingTableRequired()) {
            $ownData = $this->toplist->getUserToplistByPercentage(
                $this->test_obj->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 136 of file class.ilTestToplistGUI.php.

References buildTableGUI(), ILIAS\Repository\int(), isOwnRankingTableRequired(), isTopTenRankingTableRequired(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by showResultsToplistsCmd().

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

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

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

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

        if ($this->isOwnRankingTableRequired()) {
            $ownData = $this->toplist->getUserToplistByWorkingtime(
                $this->test_obj->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 62 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:

---

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

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