class.ilScoringAdjustmentGUI.php

Go to the documentation of this file.

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

require_once 'Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php';

class ilScoringAdjustmentGUI 
{
        protected $lng;
        
        protected $tpl;
        
        protected $ctrl;
        
        protected $ilias;
        
        public $object; // Public due to law of demeter violation in ilTestQuestionsTableGUI.
        
        protected $tree;
        
        protected $ref_id;
        
        protected $service;

        public function __construct(ilObjTest $a_object)
        {
                global $lng, $tpl, $ilCtrl, $ilias, $tree;

                $this->lng              = $lng;
                $this->tpl              = $tpl;
                $this->ctrl     = $ilCtrl;
                $this->ilias    = $ilias;
                $this->object   = $a_object;
                $this->tree     = $tree;
                $this->ref_id   = $a_object->ref_id;

                require_once './Modules/Test/classes/class.ilTestService.php';
                $this->service  = new ilTestService($a_object);
        }

        public function executeCommand()
        {
                $setting = new ilSetting('assessment');
                if( ! (bool)$setting->get('assessment_adjustments_enabled', false) )
                {
                        $this->ctrl->redirectByClass('ilObjTestGUI');
                }
                
                $cmd = $this->ctrl->getCmd();
                $next_class = $this->ctrl->getNextClass($this);

                switch($next_class)
                {
                        default:
                                return $this->dispatchCommand($cmd);
                }
        }

        protected function dispatchCommand($cmd)
        {
                switch (strtolower($cmd))
                {
                        case 'savescoringfortest':
                                $this->saveQuestion();
                                break;
                                
                        case 'adjustscoringfortest':
                                $this->editQuestion();
                                break;
                        
                        case 'showquestionlist':
                        default: 
                                $this->questionsObject();
                }
        }

        protected function questionsObject()
        {
                global $ilAccess;

                if (!$ilAccess->checkAccess("write", "", $this->ref_id))
                {
                        // allow only write access
                        ilUtil::sendInfo($this->lng->txt("cannot_edit_test"), true);
                        $this->ctrl->redirect($this, "infoScreen");
                }

                if ($_GET['browse'])
                {
                        exit('Browse??');
                        return $this->object->questionbrowser();
                }

                if ($_GET["eqid"] && $_GET["eqpl"])
                {
                        $this->ctrl->setParameter($this, 'q_id', $_GET["eqid"]);
                        $this->ctrl->setParameter($this, 'qpl_id', $_GET["eqpl"]);
                        $this->ctrl->redirect($this, 'adjustscoringfortest');
                }


                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.il_as_tst_questions.html", "Modules/Test");

                $this->tpl->setCurrentBlock("adm_content");

                include_once "./Modules/Test/classes/tables/class.ilTestQuestionsTableGUI.php";
                $checked_move = is_array($_SESSION['tst_qst_move_' . $this->object->getTestId()]) 
                        && (count($_SESSION['tst_qst_move_' . $this->object->getTestId()]));

                $table_gui = new ilTestQuestionsTableGUI(
                        $this, 
                        'showquestionlist', 
                        (($ilAccess->checkAccess("write", "", $this->ref_id) ? true : false)), 
                        $checked_move, 0);

                $data = $this->object->getTestQuestions();
                // @TODO Ask object for random test.
                if (!$data)
                {
                        $this->object->getPotentialRandomTestQuestions();
                }

                $filtered_data = array();
                foreach($data as $question)
                {
                        $question_object = assQuestion::instantiateQuestionGUI($question['question_id']);

                        if ( $this->supportsAdjustment( $question_object ) && $this->allowedInAdjustment( $question_object ) )
                        {
                                $filtered_data[] = $question;
                        }
                }
                $table_gui->setData($filtered_data);

                $table_gui->clearActionButtons();
                $table_gui->clearCommandButtons();
                $table_gui->multi = array();
                $table_gui->setRowTemplate('tpl.il_as_tst_adjust_questions_row.html', 'Modules/Test');
                $table_gui->header_commands = array();
                $table_gui->setSelectAllCheckbox(null);

                $this->tpl->setVariable('QUESTIONBROWSER', $table_gui->getHTML());
                $this->tpl->setVariable("ACTION_QUESTION_FORM", $this->ctrl->getFormAction($this, 'showquestionlist'));
                $this->tpl->parseCurrentBlock();
        }

        protected function supportsAdjustment(\assQuestionGUI $question_object)
        {
                return ($question_object instanceof ilGuiQuestionScoringAdjustable
                        || $question_object instanceof ilGuiAnswerScoringAdjustable)
                        && ($question_object->object instanceof ilObjQuestionScoringAdjustable
                        || $question_object->object instanceof ilObjAnswerScoringAdjustable);
        }

        protected function allowedInAdjustment(\assQuestionGUI $question_object)
        {
                $setting = new ilSetting('assessment');
                $types = explode(',',$setting->get('assessment_scoring_adjustment'));
                require_once './Modules/TestQuestionPool/classes/class.ilObjQuestionPool.php';
                $type_def = array();
                foreach ($types as $type)
                {
                        $type_def[$type] = ilObjQuestionPool::getQuestionTypeByTypeId($type);
                }

                $type = $question_object->getQuestionType();
                if (in_array($type,$type_def))
                {
                        return true; 
                }
                return false;
        }

        protected function editQuestion()
        {
                $form = $this->buildAdjustQuestionForm( (int)$_GET['q_id'], (int)$_GET['qpl_id'] );
                $this->outputAdjustQuestionForm( $form );
        }

        protected function outputAdjustQuestionForm($form)
        {
                $this->tpl->addBlockFile( "ADM_CONTENT", "adm_content", "tpl.il_as_tst_questions.html", "Modules/Test" );
                $this->tpl->setCurrentBlock( "adm_content" );
                $this->tpl->setVariable( 'QUESTIONBROWSER', $form->getHTML() );
                $this->tpl->parseCurrentBlock();
        }

        protected function buildAdjustQuestionForm($question_id, $question_pool_id)
        {
                require_once './Services/Form/classes/class.ilPropertyFormGUI.php';
                require_once './Modules/TestQuestionPool/classes/class.assQuestion.php';

                $form = new ilPropertyFormGUI();
                $form->setFormAction( $this->ctrl->getFormAction( $this ) );
                $form->setMultipart( FALSE );
                $form->setTableWidth( "100%" );
                $form->setId( "adjustment" );

                $question = assQuestion::instantiateQuestionGUI( $question_id );
                $question->setEditContext(assQuestionGUI::EDIT_CONTEXT_ADJUSTMENT);
                $form->setTitle( $question->object->getTitle() . '<br /><small>(' . $question->outQuestionType() . ')</small>' );

                $hidden_question_id = new ilHiddenInputGUI('q_id');
                $hidden_question_id->setValue( $question_id );
                $form->addItem( $hidden_question_id );

                $hidden_qpl_id = new ilHiddenInputGUI('qpl_id');
                $hidden_qpl_id->setValue( $question_pool_id );
                $form->addItem( $hidden_qpl_id );

                $this->populateScoringAdjustments( $question, $form );

                $manscoring_section = new ilFormSectionHeaderGUI();
                $manscoring_section->setTitle($this->lng->txt('manscoring'));
                $form->addItem($manscoring_section);
                
                $manscoring_preservation = new ilCheckboxInputGUI($this->lng->txt('preserve_manscoring'), 'preserve_manscoring');
                $manscoring_preservation->setChecked(true);
                $manscoring_preservation->setInfo($this->lng->txt('preserve_manscoring_info'));
                $form->addItem($manscoring_preservation);

                $form->addCommandButton("savescoringfortest", $this->lng->txt("save"));

                $participants = $this->object->getParticipants();
                $active_ids = array_keys($participants);
                $results = array();
                
                require_once 'Modules/Test/classes/class.ilTestPassesSelector.php';
                $db = isset($GLOBALS['DIC']) ? $GLOBALS['DIC']['ilDB'] : $GLOBALS['ilDB'];
                foreach( $active_ids as $active_id )
                {
                        $passesSelector = new ilTestPassesSelector($db, $this->object);
                        $passesSelector->setActiveId($active_id);
                        $passesSelector->loadLastFinishedPass();
                        
                        foreach( $passesSelector->getClosedPasses() as $pass )
                        {
                                $results[] = $question->object->getSolutionValues($active_id, $pass);
                        }
                }

                $relevant_answers = array();
                foreach ($results as $result)
                {
                        foreach ($result as $answer)
                        {
                                if( $answer['question_fi'] == $question->object->getId() )
                                {
                                        $relevant_answers[] = $answer;
                                }
                        }
                }

                $this->tpl->addCss('Modules/Test/templates/default/ta.css');
                $answers_view = $question->getAggregatedAnswersView($relevant_answers);

                include_once 'Services/jQuery/classes/class.iljQueryUtil.php';
                iljQueryUtil::initjQuery();
                include_once 'Services/YUI/classes/class.ilYuiUtil.php';
                ilYuiUtil::initPanel();
                ilYuiUtil::initOverlay();
                $this->tpl->addJavascript('./Services/UIComponent/Overlay/js/ilOverlay.js');
                $this->tpl->addJavaScript("./Services/JavaScript/js/Basic.js");
                
                $container = new ilTemplate('tpl.il_as_tst_adjust_answer_aggregation_container.html', true, true, 'Modules/Test');
                $container->setVariable('FORM_ELEMENT_NAME', 'aggr_usr_answ');
                $container->setVariable('CLOSE_HTML', json_encode(ilGlyphGUI::get(ilGlyphGUI::CLOSE, $this->lng->txt('close'))));
                $container->setVariable('TXT_SHOW_ANSWER_OVERVIEW', $this->lng->txt('show_answer_overview'));
                $container->setVariable('TXT_CLOSE', $this->lng->txt('close'));
                $container->setVariable('ANSWER_OVERVIEW', $answers_view);

                $custom_input = new ilCustomInputGUI('', 'aggr_usr_answ');
                $custom_input->setHtml($container->get());
                $form->addItem($custom_input);
                return $form;
        }

        protected function suppressPostParticipationFormElements(\ilPropertyFormGUI $form, $postvars_to_suppress)
        {
                foreach ($postvars_to_suppress as $postvar)
                {
                        $item = $form->getItemByPostVar($postvar);
                        $item->setDisabled(true);
                }
                return $form;
        }

        protected function saveQuestion()
        {
                $question_id = $_POST['q_id'];
                $question_pool_id = $_POST['qpl_id'];
                $form = $this->buildAdjustQuestionForm($question_id, $question_pool_id);

                $form->setValuesByPost($_POST);

                if (!$form->checkInput())
                {
                        ilUtil::sendFailure($this->lng->txt('adjust_question_form_error'));
                        $this->outputAdjustQuestionForm($form);
                        return;
                }

                require_once './Modules/TestQuestionPool/classes/class.assQuestion.php';
                $question = assQuestion::instantiateQuestionGUI( $question_id );
                $question->setEditContext(assQuestionGUI::EDIT_CONTEXT_ADJUSTMENT);

                if ($question instanceof ilGuiQuestionScoringAdjustable)
                {
                        $question->writeQuestionSpecificPostData($form);

                }
                
                if ($question->object instanceof ilObjQuestionScoringAdjustable)
                {
                        $question->object->saveAdditionalQuestionDataToDb();
                }
                
                if ($question instanceof ilGuiAnswerScoringAdjustable)
                {
                        $question->writeAnswerSpecificPostData($form);
                }
                
                if($question->object instanceof ilObjAnswerScoringAdjustable)
                {
                        $question->object->saveAnswerSpecificDataToDb();
                }

                $question->object->setPoints($question->object->getMaximumPoints());
                $question->object->saveQuestionDataToDb();

                require_once './Modules/Test/classes/class.ilTestScoring.php';
                $scoring = new ilTestScoring($this->object);
                $scoring->setPreserveManualScores($_POST['preserve_manscoring'] == 1 ? true : false);
                $scoring->recalculateSolutions();

                ilUtil::sendSuccess($this->lng->txt('saved_adjustment'));
                $this->questionsObject();
                
        }

        protected function populateScoringAdjustments( $question, $form )
        {
                $question->setAdjustmentEditContext();
                
                if ( $question instanceof ilGuiQuestionScoringAdjustable )
                {
                        $question->populateQuestionSpecificFormPart($form);
                        
                        $this->suppressPostParticipationFormElements(
                                $form, $question->getAfterParticipationSuppressionQuestionPostVars()
                        );
                }

                if ( $question instanceof ilGuiAnswerScoringAdjustable )
                {
                        $question->populateAnswerSpecificFormPart($form);
                        
                        $this->suppressPostParticipationFormElements(
                                $form, $question->getAfterParticipationSuppressionAnswerPostVars()
                        );
                }
        }
}