class.ilTestPassOverviewTableGUI.php

Go to the documentation of this file.

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

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

class ilTestPassOverviewTableGUI extends ilTable2GUI
{
        protected $resultPresentationEnabled = false;
        
        protected $pdfPresentationEnabled = false;

        protected $objectiveOrientedPresentationEnabled = false;

        protected $activeId = null;

        protected $passDetailsCommand = '';

        protected $passDeletionCommand = '';

        public function __construct($parent, $cmd)
        {
                $this->setId('tst_pass_overview_' . $parent->object->getId());
                $this->setDefaultOrderField('pass');
                $this->setDefaultOrderDirection('ASC');

                parent::__construct($parent, $cmd);
                
                // Don't set any limit because of print/pdf views. Furthermore, this view is part of different summary views, and no cmd ist passed to he calling method.
                $this->setLimit(PHP_INT_MAX);
                $this->disable('sort');

                $this->setRowTemplate('tpl.il_as_tst_pass_overview_row.html', 'Modules/Test');
        }
        
        public function init()
        {
                global $ilCtrl;

                $ilCtrl->setParameter($this->parent_obj, 'active_id', $this->getActiveId());
                
                $this->initColumns();

                if($this->isPdfPresentationEnabled())
                {
                        $this->disable('linkbar');
                        $this->disable('numinfo');
                        $this->disable('numinfo_header');
                        $this->disable('hits');
                }
        }

        public function numericOrdering($field)
        {
                switch($field)
                {
                        case 'pass':
                        case 'date':
                        case 'percentage':
                                return true;
                }

                return false;
        }

        public function fillRow($row)
        {
                if(array_key_exists('percentage', $row))
                {
                        $row['percentage'] = sprintf('%.2f', $row['percentage']) . '%';
                }

                // fill columns
                
                if( !$this->isObjectiveOrientedPresentationEnabled() )
                {
                        if($this->isResultPresentationEnabled())
                        {
                                $this->tpl->setVariable('VAL_SCORED', $row['scored'] ? '&otimes;' : '');
                        }
                        
                        $this->tpl->setVariable('VAL_PASS', $this->getPassNumberPresentation($row['pass']));
                }
                
                $this->tpl->setVariable('VAL_DATE', $this->formatDate($row['date']));

                if( $this->isObjectiveOrientedPresentationEnabled() )
                {
                        $this->tpl->setVariable('VAL_LO_OBJECTIVES', $row['objectives']);
                        
                        $this->tpl->setVariable('VAL_LO_TRY', sprintf(
                                $this->lng->txt('tst_res_lo_try_n'), $this->getPassNumberPresentation($row['pass'])
                        ));
                }

                if( $this->isResultPresentationEnabled() )
                {
                        $this->tpl->setVariable('VAL_ANSWERED', $this->buildWorkedThroughQuestionsString(
                                $row['num_workedthrough_questions'], $row['num_questions_total']
                        ));

                        if( $this->getParentObject()->object->isOfferingQuestionHintsEnabled() )
                        {
                                $this->tpl->setVariable('VAL_HINTS', $row['hints']);
                        }

                        $this->tpl->setVariable('VAL_REACHED', $this->buildReachedPointsString(
                                $row['reached_points'], $row['max_points']
                        ));

                        $this->tpl->setVariable('VAL_PERCENTAGE', $row['percentage']);
                }

                if(!$this->isPdfPresentationEnabled())
                {
                        $actions = $this->getRequiredActions($row['scored']);
                        $this->tpl->setVariable('VAL_ACTIONS', $this->buildActionsHtml($actions, $row['pass']));
                }
        }

        protected function initColumns()
        {
                if($this->isResultPresentationEnabled() && !$this->isObjectiveOrientedPresentationEnabled())
                {
                        $this->addColumn($this->lng->txt('scored_pass'), '', '150');
                }
                
                if( !$this->isObjectiveOrientedPresentationEnabled() )
                {
                        $this->addColumn($this->lng->txt('pass'), '', '1%');
                }
                
                $this->addColumn($this->lng->txt('date'));
                
                if( $this->isObjectiveOrientedPresentationEnabled() )
                {
                        $this->addColumn($this->lng->txt('tst_res_lo_objectives_header'), '');
                        $this->addColumn($this->lng->txt('tst_res_lo_try_header'), '');
                }
                
                if($this->isResultPresentationEnabled())
                {
                        $this->addColumn($this->lng->txt('tst_answered_questions'));
                        if($this->getParentObject()->object->isOfferingQuestionHintsEnabled())
                        {
                                $this->addColumn($this->lng->txt('tst_question_hints_requested_hint_count_header'));
                        }
                        $this->addColumn($this->lng->txt('tst_reached_points'));
                        $this->addColumn($this->lng->txt('tst_percent_solved'));
                }
                
                // actions
                if(!$this->isPdfPresentationEnabled())
                {
                        $this->addColumn('', '', '10%' );
                }
        }

        public function isResultPresentationEnabled()
        {
                return $this->resultPresentationEnabled;
        }

        public function setResultPresentationEnabled($resultPresentationEnabled)
        {
                $this->resultPresentationEnabled = $resultPresentationEnabled;
        }

        public function isPdfPresentationEnabled()
        {
                return $this->pdfPresentationEnabled;
        }

        public function setPdfPresentationEnabled($pdfPresentationEnabled)
        {
                $this->pdfPresentationEnabled = $pdfPresentationEnabled;
        }

        public function isObjectiveOrientedPresentationEnabled()
        {
                return $this->objectiveOrientedPresentationEnabled;
        }

        public function setObjectiveOrientedPresentationEnabled($objectiveOrientedPresentationEnabled)
        {
                $this->objectiveOrientedPresentationEnabled = $objectiveOrientedPresentationEnabled;
        }

        public function getActiveId()
        {
                return $this->activeId;
        }

        public function setActiveId($activeId)
        {
                $this->activeId = $activeId;
        }

        public function getPassDetailsCommand()
        {
                return $this->passDetailsCommand;
        }

        public function setPassDetailsCommand($passDetailsCommand)
        {
                $this->passDetailsCommand = $passDetailsCommand;
        }

        public function getPassDeletionCommand()
        {
                return $this->passDeletionCommand;
        }

        public function setPassDeletionCommand($passDeletionCommand)
        {
                $this->passDeletionCommand = $passDeletionCommand;
        }

        private function formatDate($date)
        {
                $oldValue = ilDatePresentation::useRelativeDates();
                ilDatePresentation::setUseRelativeDates(false);
                $date = ilDatePresentation::formatDate(new ilDateTime($date, IL_CAL_UNIX));
                ilDatePresentation::setUseRelativeDates($oldValue);
                return $date;
        }
        
        private function buildWorkedThroughQuestionsString($numQuestionsWorkedThrough, $numQuestionsTotal)
        {
                return "{$numQuestionsWorkedThrough} {$this->lng->txt('of')} {$numQuestionsTotal}";
        }
        
        private function buildReachedPointsString($reachedPoints, $maxPoints)
        {
                return "{$reachedPoints} {$this->lng->txt('of')} {$maxPoints}";
        }

        private function getRequiredActions($isScoredPass)
        {
                $actions = array();
                
                if( $this->getPassDetailsCommand() )
                {
                        $actions[$this->getPassDetailsCommand()] = $this->lng->txt('tst_pass_details');
                }
                
                if( !$isScoredPass && $this->getPassDeletionCommand() )
                {
                        $actions[$this->getPassDeletionCommand()] = $this->lng->txt('delete');
                }
                
                return $actions;
        }
        
        private function buildActionsHtml($actions, $pass)
        {
                global $ilCtrl;
                
                if( !count($actions) )
                {
                        return '';
                }

                $ilCtrl->setParameter($this->parent_obj, 'pass', $pass);
                
                if( count($actions) > 1 )
                {
                        $aslgui = new ilAdvancedSelectionListGUI();
                        $aslgui->setListTitle($this->lng->txt('actions'));
                        $aslgui->setId($pass);
                        
                        foreach($actions as $cmd => $label)
                        {
                                $aslgui->addItem($label, $cmd, $ilCtrl->getLinkTarget($this->parent_obj, $cmd));
                        }

                        $html = $aslgui->getHTML();
                }
                else
                {
                        $cmd = key($actions);
                        $label = current($actions);
                        
                        $href = $ilCtrl->getLinkTarget($this->parent_obj, $cmd);
                        $html = '<a href="'.$href.'">'.$label.'</a>';
                }

                $ilCtrl->setParameter($this->parent_obj, 'pass', '');

                return $html;
        }
        
        protected function getPassNumberPresentation($pass)
        {
                return $pass + 1;
        }
}