class.ilParticipantsTestResultsTableGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */


include_once('./Services/Table/classes/class.ilTable2GUI.php');
require_once 'Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php';

class ilParticipantsTestResultsTableGUI extends ilTable2GUI
{
    protected $accessResultsCommandsEnabled = false;
    protected $manageResultsCommandsEnabled = false;
    
    protected $anonymity;
    
    public function __construct($a_parent_obj, $a_parent_cmd)
    {
        $this->setId('tst_participants_' . $a_parent_obj->getTestObj()->getRefId());
        parent::__construct($a_parent_obj, $a_parent_cmd);
        
        global $DIC;
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        
        $this->setStyle('table', 'fullwidth');
        
        $this->setFormName('partResultsForm');
        $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, $a_parent_cmd));
        
        $this->setRowTemplate("tpl.il_as_tst_scorings_row.html", "Modules/Test");
        
        $this->enable('header');
        $this->enable('sort');
        
        $this->setSelectAllCheckbox('chbUser');
        
        $this->setDefaultOrderField('name');
        $this->setDefaultOrderDirection('asc');
    }
    
    public function isAccessResultsCommandsEnabled()
    {
        return $this->accessResultsCommandsEnabled;
    }
    
    public function setAccessResultsCommandsEnabled($accessResultsCommandsEnabled)
    {
        $this->accessResultsCommandsEnabled = $accessResultsCommandsEnabled;
    }
    
    public function isManageResultsCommandsEnabled()
    {
        return $this->manageResultsCommandsEnabled;
    }
    
    public function setManageResultsCommandsEnabled($manageResultsCommandsEnabled)
    {
        $this->manageResultsCommandsEnabled = $manageResultsCommandsEnabled;
    }
    
    public function getAnonymity()
    {
        return $this->anonymity;
    }
    
    public function setAnonymity($anonymity)
    {
        $this->anonymity = $anonymity;
    }
    
    public function numericOrdering($field)
    {
        return in_array($field, array(
            'scored_pass', 'answered_questions', 'reached_points', 'percent_result'
        ));
    }
    
    public function init()
    {
        if ($this->isMultiRowSelectionRequired()) {
            $this->setShowRowsSelector(true);
        }
        
        $this->initColumns();
        $this->initCommands();
        $this->initFilter();
    }
    
    public function initColumns()
    {
        if ($this->isMultiRowSelectionRequired()) {
            $this->addColumn('', '', '1%');
        }
        
        $this->addColumn($this->lng->txt("name"), 'name');
        $this->addColumn($this->lng->txt("login"), 'login');
        
        $this->addColumn($this->lng->txt("tst_tbl_col_scored_pass"), 'scored_pass');
        $this->addColumn($this->lng->txt("tst_tbl_col_pass_finished"), 'pass_finished');
        
        $this->addColumn($this->lng->txt("tst_tbl_col_answered_questions"), 'answered_questions');
        $this->addColumn($this->lng->txt("tst_tbl_col_reached_points"), 'reached_points');
        $this->addColumn($this->lng->txt("tst_tbl_col_percent_result"), 'percent_result');
        
        $this->addColumn($this->lng->txt("tst_tbl_col_passed_status"), 'passed_status');
        $this->addColumn($this->lng->txt("tst_tbl_col_final_mark"), 'final_mark');
        
        if ($this->isActionsColumnRequired()) {
            $this->addColumn('', '', '');
        }
    }
    
    public function initCommands()
    {
        if ($this->isAccessResultsCommandsEnabled() && !$this->getAnonymity()) {
            $this->addMultiCommand('showPassOverview', $this->lng->txt('show_pass_overview'));
            $this->addMultiCommand('showUserAnswers', $this->lng->txt('show_user_answers'));
            $this->addMultiCommand('showDetailedResults', $this->lng->txt('show_detailed_results'));
        }
        
        if ($this->isManageResultsCommandsEnabled()) {
            $this->addMultiCommand('deleteSingleUserResults', $this->lng->txt('delete_user_data'));
        }
    }
    
    public function initFilter()
    {
        global $DIC;
        
        // no filter at all
    }
    
    public function fillRow($data)
    {
        if ($this->isMultiRowSelectionRequired()) {
            $this->tpl->setCurrentBlock('checkbox_column');
            $this->tpl->setVariable("CHB_ROW_KEY", $data['active_id']);
            $this->tpl->parseCurrentBlock();
        }
        
        if ($this->isActionsColumnRequired()) {
            $this->tpl->setCurrentBlock('actions_column');
            $this->tpl->setVariable('ACTIONS', $this->buildActionsMenu($data)->getHTML());
            $this->tpl->parseCurrentBlock();
        }
        
        $this->tpl->setVariable("ROW_KEY", $data['active_id']);
        $this->tpl->setVariable("LOGIN", $data['login']);
        $this->tpl->setVariable("FULLNAME", $data['name']);
        
        $this->tpl->setVariable("SCORED_PASS", $this->buildScoredPassString($data));
        $this->tpl->setVariable("PASS_FINISHED", $this->buildPassFinishedString($data));

        $this->tpl->setVariable("ANSWERED_QUESTIONS", $this->buildAnsweredQuestionsString($data));
        $this->tpl->setVariable("REACHED_POINTS", $this->buildReachedPointsString($data));
        $this->tpl->setVariable("PERCENT_RESULT", $this->buildPercentResultString($data));
        
        $this->tpl->setVariable("PASSED_STATUS", $this->buildPassedStatusString($data));
        $this->tpl->setVariable("FINAL_MARK", $data['final_mark']);
    }
    
    protected function buildActionsMenu($data)
    {
        $asl = new ilAdvancedSelectionListGUI();
        
        $this->ctrl->setParameterByClass('iltestevaluationgui', 'active_id', $data['active_id']);
        
        if ($this->isAccessResultsCommandsEnabled()) {
            $resultsHref = $this->ctrl->getLinkTargetByClass('ilTestEvaluationGUI', 'outParticipantsResultsOverview');
            $asl->addItem($this->lng->txt('tst_show_results'), $resultsHref, $resultsHref);
        }
        
        return $asl;
    }
    
    protected function isActionsColumnRequired()
    {
        if ($this->isAccessResultsCommandsEnabled()) {
            return true;
        }
        
        return false;
    }
    
    protected function isMultiRowSelectionRequired()
    {
        if ($this->isAccessResultsCommandsEnabled() && !$this->getAnonymity()) {
            return true;
        }
        
        if ($this->isManageResultsCommandsEnabled()) {
            return true;
        }
        
        return false;
    }
    
    protected function buildPassedStatusString($data)
    {
        if ($data['passed_status']) {
            return $this->buildPassedIcon() . ' ' . $this->lng->txt('tst_passed');
        }
        
        return $this->buildFailedIcon() . ' ' . $this->lng->txt('tst_failed');
    }
    
    protected function buildPassedIcon()
    {
        return $this->buildImageIcon(ilUtil::getImagePath("icon_ok.svg"), $this->lng->txt("passed"));
    }
    
    protected function buildFailedIcon()
    {
        return $this->buildImageIcon(ilUtil::getImagePath("icon_not_ok.svg"), $this->lng->txt("failed"));
    }
    
    protected function buildImageIcon($src, $alt)
    {
        return "<img border=\"0\" align=\"middle\" src=\"" . $src . "\" alt=\"" . $alt . "\" />";
    }
    
    protected function buildFormattedAccessDate($data)
    {
        return ilDatePresentation::formatDate(new ilDateTime($data['access'], IL_CAL_DATETIME));
    }
    
    protected function buildScoredPassString($data)
    {
        return $this->lng->txt('pass') . ' ' . ($data['scored_pass'] + 1);
    }

    protected function buildPassFinishedString($data)
    {
        return ilDatePresentation::formatDate(new ilDateTime($data['pass_finished'], IL_CAL_UNIX));
    }

    protected function buildAnsweredQuestionsString($data)
    {
        return sprintf(
            $this->lng->txt('tst_answered_questions_of_total'),
            $data['answered_questions'],
            $data['total_questions']
        );
    }
    
    protected function buildReachedPointsString($data)
    {
        return sprintf(
            $this->lng->txt('tst_reached_points_of_max'),
            $data['reached_points'],
            $data['max_points']
        );
    }
    
    protected function buildPercentResultString($data)
    {
        return sprintf('%0.2f %%', $data['percent_result'] * 100);
    }
}