ilTestToplistGUI Class Reference

Scoring class for tests. More...

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 Member Functions
	prepareTable (ilTable2GUI $table_gui)

Detailed Description

Scoring class for tests.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilTestToplistGUI::__construct

(

ilObjTest

$testOBJ

)

Parameters

ilObjTest

$testOBJ

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

    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        $this->ctrl = $DIC['ilCtrl'];
        $this->tpl = $DIC['tpl'];
        $this->lng = $DIC['lng'];
        $this->user = $DIC['ilUser'];
        
        $this->object = $testOBJ;
        $this->toplist = new ilTestTopList($testOBJ);
    }

References $DIC, and user().

Here is the call graph for this function:

Member Function Documentation

buildTableGUI()

ilTestToplistGUI::buildTableGUI ( )

protected

Returns

ilTable2GUI

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

    {
        $table_gui = new ilTable2GUI($this);
        $this->prepareTable($table_gui);
        $table_gui->setRowTemplate('tpl.toplist_tbl_rows.html', 'Modules/Test');
        return $table_gui;
    }

References prepareTable().

Referenced by renderResultsToplistByScore(), and renderResultsToplistByTime().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilTestToplistGUI::executeCommand

(

)

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

    {
        if (!$this->object->getHighscoreEnabled()) {
            ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
            $this->ctrl->redirectByClass('ilObjTestGUI');
        }
        
        $this->ctrl->saveParameter($this, 'active_id');
        
        $cmd = $this->ctrl->getCmd();
        
        switch ($cmd) {
            default:
                $this->showResultsToplistsCmd();
        }
    }

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

Here is the call graph for this function:

isOwnRankingTableRequired()

ilTestToplistGUI::isOwnRankingTableRequired ( )

protected

Returns

bool

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

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

References ilObjTest\HIGHSCORE_SHOW_ALL_TABLES, and ilObjTest\HIGHSCORE_SHOW_OWN_TABLE.

Referenced by renderResultsToplistByScore(), and renderResultsToplistByTime().

Here is the caller graph for this function:

isTopTenRankingTableRequired()

ilTestToplistGUI::isTopTenRankingTableRequired ( )

protected

Returns

bool

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

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

References ilObjTest\HIGHSCORE_SHOW_ALL_TABLES, and ilObjTest\HIGHSCORE_SHOW_TOP_TABLE.

Referenced by renderResultsToplistByScore(), and renderResultsToplistByTime().

Here is the caller graph for this function:

prepareTable()

ilTestToplistGUI::prepareTable ( ilTable2GUI  $table_gui )

private

Parameters

ilTable2GUI

$table_gui

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

    {
        $table_gui->addColumn($this->lng->txt('toplist_col_rank'));
        $table_gui->addColumn($this->lng->txt('toplist_col_participant'));
        if ($this->object->getHighscoreAchievedTS()) {
            $table_gui->addColumn($this->lng->txt('toplist_col_achieved'));
        }
 
        if ($this->object->getHighscoreScore()) {
            $table_gui->addColumn($this->lng->txt('toplist_col_score'));
        }
 
        if ($this->object->getHighscorePercentage()) {
            $table_gui->addColumn($this->lng->txt('toplist_col_percentage'));
        }
 
        if ($this->object->getHighscoreHints()) {
            $table_gui->addColumn($this->lng->txt('toplist_col_hints'));
        }
 
        if ($this->object->getHighscoreWTime()) {
            $table_gui->addColumn($this->lng->txt('toplist_col_wtime'));
        }
        $table_gui->setEnableNumInfo(false);
        $table_gui->setLimit(10);
    }

References ilTable2GUI\addColumn(), ilTable2GUI\setEnableNumInfo(), and ilTable2GUI\setLimit().

Referenced by buildTableGUI().

Here is the call graph for this function:

Here is the caller graph for this function:

renderMedianMarkPanel()

ilTestToplistGUI::renderMedianMarkPanel ( )

protected

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

    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        
        $title = $DIC->language()->txt('tst_median_mark_panel');
        
        // BH: this really is the "mark of median" ??!
        $activeId = $this->object->getActiveIdOfUser($DIC->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 = $DIC->ui()->factory()->panel()->standard(
            $title,
            $DIC->ui()->factory()->legacy($content)
        );
        
        return $DIC->ui()->renderer()->render($panel);
    }

References $data, $DIC, and $title.

Referenced by showResultsToplistsCmd().

Here is the caller graph for this function:

renderResultsToplistByScore()

ilTestToplistGUI::renderResultsToplistByScore ( )

protected

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

    {
        $title = $this->lng->txt('toplist_by_score');
        $html = '';
        
        if ($this->isTopTenRankingTableRequired()) {
            $data = $this->toplist->getGeneralToplistByPercentage($_GET['ref_id'], $this->user->getId());
            
            $table_gui = $this->buildTableGUI();
            
            $table_gui->setData($data);
            $table_gui->setTitle($title);
 
            $html .= $table_gui->getHTML();
        }
 
        if ($this->isOwnRankingTableRequired()) {
            $table_gui = $this->buildTableGUI();
            
            $table_gui->setData(
                $this->toplist->getUserToplistByPercentage($_GET['ref_id'], $this->user->getID())
            );
            
            if (!$this->isTopTenRankingTableRequired()) {
                $table_gui->setTitle($title);
            }
 
            $html .= $table_gui->getHTML();
        }
 
        return $html;
    }

References $_GET, $data, $html, $title, buildTableGUI(), isOwnRankingTableRequired(), isTopTenRankingTableRequired(), and user().

Referenced by showResultsToplistsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

renderResultsToplistByTime()

ilTestToplistGUI::renderResultsToplistByTime ( )

protected

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

    {
        $title = $this->lng->txt('toplist_by_time');
        $html = '';
 
        if ($this->isTopTenRankingTableRequired()) {
            $topData = $this->toplist->getGeneralToplistByWorkingtime($_GET['ref_id'], $this->user->getId());
            
            $table_gui = $this->buildTableGUI();
            $table_gui->setData($topData);
            $table_gui->setTitle($title);
 
            $html .= $table_gui->getHTML();
        }
 
        if ($this->isOwnRankingTableRequired()) {
            $ownData = $this->toplist->getUserToplistByWorkingtime($_GET['ref_id'], $this->user->getID());
            
            $table_gui = $this->buildTableGUI();
            
            $table_gui->setData($ownData);
            
            if (!$this->isTopTenRankingTableRequired()) {
                $table_gui->setTitle($title);
            }
            
            $html .= $table_gui->getHTML();
        }
 
        return $html;
    }

References $_GET, $html, $title, buildTableGUI(), isOwnRankingTableRequired(), isTopTenRankingTableRequired(), and user().

Referenced by showResultsToplistsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

showResultsToplistsCmd()

ilTestToplistGUI::showResultsToplistsCmd ( )

protected

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

    {
        $html = $this->renderMedianMarkPanel();
        $html .= $this->renderResultsToplistByScore();
        $html .= $this->renderResultsToplistByTime();
        
        $this->tpl->setVariable("ADM_CONTENT", $html);
    }

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

Referenced by executeCommand().

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 19 of file class.ilTestToplistGUI.php.

$lng

ilTestToplistGUI::$lng

protected

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

$object

ilTestToplistGUI::$object

protected

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

$tabs

ilTestToplistGUI::$tabs

protected

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

$toplist

ilTestToplistGUI::$toplist

protected

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

$tpl

ilTestToplistGUI::$tpl

protected

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

$user

ilTestToplistGUI::$user

protected

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

---

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

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