ilTestToplistGUI Class Reference

Collaboration diagram for ilTestToplistGUI:

Public Member Functions
	__construct (protected readonly ilObjTest $test_obj, protected readonly TestTopListRepository $repository, protected readonly ilCtrlInterface $ctrl, protected readonly ilGlobalTemplateInterface $tpl, protected readonly ilLanguage $lng, protected readonly ilObjUser $user, protected readonly UIFactory $ui_factory, protected readonly UIRenderer $ui_renderer, protected readonly DataFactory $data_factory, protected readonly GlobalHttpState $http_state)
	executeCommand ()

Protected Member Functions
	showResultsToplistsCmd ()
	buildMedianMarkPanel ()
	buildResultsToplists (TopListOrder $order_by)
	buildTable (string $title, TopListType $list_type, TopListOrder $order_by)
	isTopTenRankingTableRequired ()
	isOwnRankingTableRequired ()

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilTestToplistGUI::__construct	(	protected readonly ilObjTest	$test_obj,
		protected readonly TestTopListRepository	$repository,
		protected readonly ilCtrlInterface	$ctrl,
		protected readonly ilGlobalTemplateInterface	$tpl,
		protected readonly ilLanguage	$lng,
		protected readonly ilObjUser	$user,
		protected readonly UIFactory	$ui_factory,
		protected readonly UIRenderer	$ui_renderer,
		protected readonly DataFactory	$data_factory,
		protected readonly GlobalHttpState	$http_state
	)

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

      {
    }

Member Function Documentation

buildMedianMarkPanel()

ilTestToplistGUI::buildMedianMarkPanel ( )

protected

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

                                             : Panel
    {
        $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()->median();
        $pct = $data->getParticipant($activeId)->getMaxpoints() ? ($median / $data->getParticipant($activeId)->getMaxpoints()) * 100.0 : 0;
        $mark = $this->test_obj->getMarkSchema()->getMatchingMark($pct);
        $content = $mark->getShortName();
 
        return $this->ui_factory->panel()->standard(
            $title,
            $this->ui_factory->legacy()->content($content)
        );
    }

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

Here is the call graph for this function:

buildResultsToplists()

ilTestToplistGUI::buildResultsToplists ( TopListOrder  $order_by )

protected

Returns

array<Data>

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

                                                                   : array
    {
        $tables = [];
 
        if ($this->isTopTenRankingTableRequired()) {
            $tables[] = $this->buildTable(
                $this->lng->txt('toplist_by_' . $order_by->getLabel()),
                TopListType::GENERAL,
                $order_by
            )->withId('tst_top_list' . $this->test_obj->getRefId());
        }
 
        if ($this->isOwnRankingTableRequired()) {
            $tables[] = $this->buildTable(
                count($tables) == 0 ? $this->lng->txt('toplist_by_' . $order_by->getLabel()) : '',
                TopListType::USER,
                $order_by
            )->withId('tst_own_list' . $this->test_obj->getRefId());
        }
 
        return $tables;
    }

References buildTable(), isOwnRankingTableRequired(), isTopTenRankingTableRequired(), ILIAS\Repository\lng(), and ILIAS\Mail\Folder\USER.

Here is the call graph for this function:

buildTable()

ilTestToplistGUI::buildTable ( string  $title, TopListType  $list_type, TopListOrder  $order_by  )

protected

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

                                                                                                : Data
    {
        $table = new DataRetrieval(
            $this->test_obj,
            $this->repository,
            $this->lng,
            $this->user,
            $this->ui_factory,
            $this->ui_renderer,
            $this->data_factory,
            $list_type,
            $order_by
        );
        return $this->ui_factory->table()
            ->data($table, $title, $table->getColumns())
            ->withRequest($this->http_state->request());
    }

References ILIAS\Repository\lng(), ILIAS\UI\examples\Deck\repository(), and ILIAS\Repository\user().

Referenced by buildResultsToplists().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilTestToplistGUI::executeCommand

(

)

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

                                    : 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();
        }
    }

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

Here is the call graph for this function:

isOwnRankingTableRequired()

ilTestToplistGUI::isOwnRankingTableRequired ( )

protected

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

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

Referenced by buildResultsToplists().

Here is the caller graph for this function:

isTopTenRankingTableRequired()

ilTestToplistGUI::isTopTenRankingTableRequired ( )

protected

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

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

Referenced by buildResultsToplists().

Here is the caller graph for this function:

showResultsToplistsCmd()

ilTestToplistGUI::showResultsToplistsCmd ( )

protected

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

                                               : void
    {
        $this->tpl->setContent($this->ui_renderer->render([
            $this->buildMedianMarkPanel(),
            ...$this->buildResultsToplists(TopListOrder::BY_SCORE),
            ...$this->buildResultsToplists(TopListOrder::BY_TIME),
        ]));
    }

Referenced by executeCommand().

Here is the caller graph for this function:

---

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

• components/ILIAS/Test/classes/class.ilTestToplistGUI.php