class.ilTestScoringGUI.php

Go to the documentation of this file.

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

include_once "./Modules/Test/classes/inc.AssessmentConstants.php";
include_once "./Modules/Test/classes/class.ilTestServiceGUI.php";

class ilTestScoringGUI extends ilTestServiceGUI
{
        const PART_FILTER_ACTIVE_ONLY                   = 1;
        const PART_FILTER_INACTIVE_ONLY                 = 2;
        const PART_FILTER_ALL_USERS                             = 3; // default
        const PART_FILTER_MANSCORING_DONE               = 4;
        const PART_FILTER_MANSCORING_NONE               = 5;
        //const PART_FILTER_MANSCORING_PENDING  = 6;
        
        function ilTestScoringGUI(ilObjTest $a_object)
        {
                parent::ilTestServiceGUI($a_object);
        }

        protected function buildSubTabs($active_sub_tab = 'man_scoring')
        {
                global $ilTabs;
                $ilTabs->addSubTab('man_scoring', $this->lng->txt('tst_man_scoring_by_part'), $this->ctrl->getLinkTargetByClass('ilTestScoringGUI', 'showManScoringParticipantsTable'));
                $ilTabs->addSubTab('man_scoring_by_qst', $this->lng->txt('tst_man_scoring_by_qst'), $this->ctrl->getLinkTargetByClass('ilTestScoringByQuestionsGUI', 'showManScoringByQuestionParticipantsTable'));
                $ilTabs->setSubTabActive($active_sub_tab);
        }
        
        private function fetchActiveIdParameter()
        {
                global $ilCtrl;
                
                // fetch active_id
                
                if( !isset($_GET['active_id']) || !(int)$_GET['active_id'] )
                {
                        // allow only write access
                        ilUtil::sendFailure('no active id given!', true);
                        $ilCtrl->redirectByClass("ilobjtestgui", "infoScreen");
                }
                else
                {
                        $activeId = (int)$_GET['active_id'];
                }
                
                return $activeId;
        }
        
        private function fetchPassParameter($activeId)
        {
                // fetch pass nr
                
                $maxPass = $this->object->_getMaxPass($activeId);
                if( isset($_GET["pass"]) && 0 <= (int)$_GET["pass"] && $maxPass >= (int)$_GET["pass"] )
                {
                        $pass = $_GET["pass"];
                }
                elseif( $this->object->getPassScoring() == SCORE_LAST_PASS )
                {
                        $pass = $maxPass;
                }
                else
                {
                        $pass = $this->object->_getResultPass($activeId);
                }
                
                return $pass;
        }
        
        function &executeCommand()
        {
                global $ilAccess;
                
                if( !$ilAccess->checkAccess("write", "", $this->ref_id) )
                {
                        // allow only write access
                        ilUtil::sendFailure($this->lng->txt("cannot_edit_test"), true);
                        $this->ctrl->redirectByClass("ilobjtestgui", "infoScreen");
                }

                require_once 'Modules/Test/classes/class.ilObjAssessmentFolder.php';
                if( !ilObjAssessmentFolder::_mananuallyScoreableQuestionTypesExists() )
                {
                        // allow only if at least one question type is marked for manual scoring
                        ilUtil::sendFailure($this->lng->txt("manscoring_not_allowed"), true);
                        $this->ctrl->redirectByClass("ilobjtestgui", "infoScreen");
                }
                
                $cmd = $this->ctrl->getCmd();
                $next_class = $this->ctrl->getNextClass($this);

                if (strlen($cmd) == 0)
                {
                        $this->ctrl->redirect($this, "manscoring");
                }
                
                $cmd = $this->getCommand($cmd);
                $this->buildSubTabs();
                switch($next_class)
                {
                        default:
                                $ret =& $this->$cmd();
                                break;
                }
                
                return $ret;
        }
        
        private function showManScoringParticipantsTable()
        {
                global $tpl;

                $table = $this->buildManScoringParticipantsTable(true);
                
                $tpl->setContent( $table->getHTML() );
        }
        
        private function applyManScoringParticipantsFilter()
        {
                $table = $this->buildManScoringParticipantsTable(false);
                
                $table->resetOffset();
                $table->writeFilterToSession();
                
                $this->showManScoringParticipantsTable();
        }
        
        private function resetManScoringParticipantsFilter()
        {
                $table = $this->buildManScoringParticipantsTable(false);
                
                $table->resetOffset();
                $table->resetFilter();

                $this->showManScoringParticipantsTable();
        }
        
        private function showManScoringParticipantScreen(ilPropertyFormGUI $form = null)
        {
                global $tpl, $lng;
                
                $activeId = $this->fetchActiveIdParameter();
                $pass = $this->fetchPassParameter($activeId);

                $contentHTML = '';
                
                // pass overview table
                require_once 'Modules/Test/classes/tables/class.ilTestPassManualScoringOverviewTableGUI.php';
                $table = new ilTestPassManualScoringOverviewTableGUI($this, 'showManScoringParticipantScreen');

                $userId = $this->object->_getUserIdFromActiveId($activeId);
                $userFullname = $this->object->userLookupFullName($userId, false, true);
                $tableTitle = sprintf($lng->txt('tst_pass_overview_for_participant'), $userFullname);
                $table->setTitle($tableTitle);

                $passOverviewData = $this->service->getPassOverviewData($activeId);
                $table->setData($passOverviewData['passes']);

                $contentHTML .= $table->getHTML().'<br />';

                // pass scoring form
                
                if($form === null)
                {
                        $questionGuiList = $this->service->getManScoringQuestionGuiList($activeId, $pass);
                        $form = $this->buildManScoringParticipantForm($questionGuiList, $activeId, $pass, true);
                }
                
                $contentHTML .= $form->getHTML();
                
                // set content
                
                $tpl->setContent($contentHTML);
        }

        private function saveManScoringParticipantScreen($redirect = true)
        {
                global $tpl, $ilCtrl, $lng;
                        
                $activeId = $this->fetchActiveIdParameter();
                $pass = $this->fetchPassParameter($activeId);
                
                $questionGuiList = $this->service->getManScoringQuestionGuiList($activeId, $pass);
                $form = $this->buildManScoringParticipantForm($questionGuiList, $activeId, $pass, false);
                
                $form->setValuesByPost();
                
                if( !$form->checkInput() )
                {
                        ilUtil::sendFailure(sprintf($lng->txt('tst_save_manscoring_failed'), $pass + 1));
                        $this->showManScoringParticipantScreen($form);
                        return false;
                }

                include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
                
                $maxPointsByQuestionId = array();
                $maxPointsExceeded = false;
                foreach($questionGuiList as $questionId => $questionGui)
                {
                        $reachedPoints = $form->getItemByPostVar("question__{$questionId}__points")->getValue();
                        $maxPoints = assQuestion::_getMaximumPoints($questionId);
                        
                        if( $reachedPoints > $maxPoints )
                        {
                                $maxPointsExceeded = true;
                                
                                $form->getItemByPostVar("question__{$questionId}__points")->setAlert( sprintf(
                                                $lng->txt('tst_manscoring_maxpoints_exceeded_input_alert'), $maxPoints
                                ));
                        }
                        
                        $maxPointsByQuestionId[$questionId] = $maxPoints;
                }
                
                if( $maxPointsExceeded )
                {
                        ilUtil::sendFailure(sprintf($lng->txt('tst_save_manscoring_failed'), $pass + 1));
                        $this->showManScoringParticipantScreen($form);
                        return false;
                }
                
                include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
                
                foreach($questionGuiList as $questionId => $questionGui)
                {
                        $reachedPoints = $form->getItemByPostVar("question__{$questionId}__points")->getValue();

                        assQuestion::_setReachedPoints(
                                        $activeId, $questionId, $reachedPoints, $maxPointsByQuestionId[$questionId],
                                        $pass, 1, $this->object->areObligationsEnabled()
                        );

                        $feedback = ilUtil::stripSlashes(
                                        $form->getItemByPostVar("question__{$questionId}__feedback")->getValue(),
                                        false, ilObjAdvancedEditing::_getUsedHTMLTagsAsString("assessment")
                        );
                                        
                        $this->object->saveManualFeedback($activeId, $questionId, $pass, $feedback);

                        $notificationData[$questionId] = array(
                                'points' => $reachedPoints, 'feedback' => $feedback
                        );
                }

                include_once "./Modules/Test/classes/class.ilObjTestAccess.php";
                include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                ilLPStatusWrapper::_updateStatus(
                                $this->object->getId(), ilObjTestAccess::_getParticipantId($activeId)
                );

                $manScoringDone = $form->getItemByPostVar("manscoring_done")->getChecked();
                ilTestService::setManScoringDone($activeId, $manScoringDone);

                $manScoringNotify = $form->getItemByPostVar("manscoring_notify")->getChecked();
                if($manScoringNotify)
                {
                        require_once 'Modules/Test/classes/notifications/class.ilTestManScoringParticipantNotification.php';

                        $notification = new ilTestManScoringParticipantNotification(
                                $this->object->_getUserIdFromActiveId($activeId), $this->object->getRefId()
                        );

                        $notification->setAdditionalInformation(array(
                                'test_title' => $this->object->getTitle(),
                                'test_pass' => $pass + 1,
                                'questions_gui_list' => $questionGuiList,
                                'questions_scoring_data' => $notificationData
                        ));

                        $notification->send();
                }

                require_once './Modules/Test/classes/class.ilTestScoring.php';
                $scorer = new ilTestScoring($this->object);
                $scorer->setPreserveManualScores(true);
                $scorer->recalculateSolutions();
                
                if($this->object->getAnonymity() == 0)
                {
                        $user_name                              = ilObjUser::_lookupName( ilObjTestAccess::_getParticipantId($activeId));
                        $name_real_or_anon              = $user_name['firstname'].' '. $user_name['lastname'];
                }
                else
                {
                        $name_real_or_anon              = $lng->txt('anonymous');
                }
                ilUtil::sendSuccess(sprintf($lng->txt('tst_saved_manscoring_successfully'), $pass + 1, $name_real_or_anon ), true);
                if($redirect == true)
                {
                        $ilCtrl->redirect($this, 'showManScoringParticipantScreen');
                }
                else
                {
                        return true;
                }
        }

        private function saveNextManScoringParticipantScreen()
        {
                global $ilCtrl;
                
                $table = $this->buildManScoringParticipantsTable(true);

                if($this->saveManScoringParticipantScreen(false))
                {
                        $participantData = $table->getInternalyOrderedDataValues();

                        $nextIndex = null;
                        foreach($participantData as $index => $participant)
                        {
                                if($participant['active_id'] == $_GET['active_id'])
                                {
                                        $nextIndex = $index + 1;
                                        break;
                                }
                        }

                        if($nextIndex && isset($participantData[$nextIndex]))
                        {
                                $ilCtrl->setParameter($this, 'active_id', $participantData[$nextIndex]['active_id']);
                                $ilCtrl->redirect($this, 'showManScoringParticipantScreen');
                        }

                        $ilCtrl->redirectByClass("iltestscoringgui", "showManScoringParticipantsTable");
                }
        }
        
        private function saveReturnManScoringParticipantScreen()
        {
                global $ilCtrl;

                if($this->saveManScoringParticipantScreen(false))
                {
                        $ilCtrl->redirectByClass("iltestscoringgui", "showManScoringParticipantsTable");
                }
        }

        private function buildManScoringParticipantForm($questionGuiList, $activeId, $pass, $initValues = false)
        {
                global $ilCtrl, $lng;
                
                require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
                require_once 'Services/Form/classes/class.ilFormSectionHeaderGUI.php';
                require_once 'Services/Form/classes/class.ilCustomInputGUI.php';
                require_once 'Services/Form/classes/class.ilCheckboxInputGUI.php';
                require_once 'Services/Form/classes/class.ilTextInputGUI.php';
                require_once 'Services/Form/classes/class.ilTextAreaInputGUI.php';
                
                $ilCtrl->setParameter($this, 'active_id', $activeId);
                $ilCtrl->setParameter($this, 'pass', $pass);
                
                $form = new ilPropertyFormGUI();
                $form->setFormAction($ilCtrl->getFormAction($this));
                
                $form->setTitle( sprintf($lng->txt('manscoring_results_pass'), $pass + 1) );
                $form->setTableWidth('100%');
                
                foreach($questionGuiList as $questionId => $questionGUI)
                {
                        $questionHeader = sprintf($lng->txt('tst_manscoring_question_section_header'), $questionGUI->object->getTitle());
                        $questionSolution = $questionGUI->getSolutionOutput($activeId, $pass, false, false, true, false, false, true);
                        $bestSolution = $questionGUI->object->getSuggestedSolutionOutput();
                
                                $sect = new ilFormSectionHeaderGUI();
                                $sect->setTitle( $questionHeader . ' ['. $this->lng->txt('question_id_short') . ': ' . $questionGUI->object->getId()  . ']');
                        $form->addItem($sect);

                                $cust = new ilCustomInputGUI($lng->txt('tst_manscoring_input_question_and_user_solution'));
                                $cust->setHtml($questionSolution);
                        $form->addItem($cust);

                                $text = new ilTextInputGUI($lng->txt('tst_change_points_for_question'), "question__{$questionId}__points");
                                if( $initValues ) $text->setValue( assQuestion::_getReachedPoints($activeId, $questionId, $pass) );
                        $form->addItem($text);
                        
                                $nonedit = new ilNonEditableValueGUI($lng->txt('tst_manscoring_input_max_points_for_question'), "question__{$questionId}__maxpoints");
                                if( $initValues ) $nonedit->setValue( assQuestion::_getMaximumPoints($questionId) );
                        $form->addItem($nonedit);
                        
                                $area = new ilTextAreaInputGUI($lng->txt('set_manual_feedback'), "question__{$questionId}__feedback");
                                $area->setUseRTE(true);
                                if( $initValues ) $area->setValue( $this->object->getManualFeedback($activeId, $questionId, $pass) );
                        $form->addItem($area);

                        if(strlen(trim($bestSolution)))
                        {
                                $cust = new ilCustomInputGUI($lng->txt('tst_show_solution_suggested'));
                                $cust->setHtml($bestSolution);
                                $form->addItem($cust);
                        }
                }
                
                $sect = new ilFormSectionHeaderGUI();
                $sect->setTitle($lng->txt('tst_participant'));
                $form->addItem($sect);
                
                $check = new ilCheckboxInputGUI($lng->txt('set_manscoring_done'), 'manscoring_done');
                if( $initValues && ilTestService::isManScoringDone($activeId) ) $check->setChecked(true);
                $form->addItem($check);
                
                $check = new ilCheckboxInputGUI($lng->txt('tst_manscoring_user_notification'), 'manscoring_notify');
                $form->addItem($check);
                
                $form->addCommandButton('saveManScoringParticipantScreen', $lng->txt('save'));
                $form->addCommandButton('saveReturnManScoringParticipantScreen', $lng->txt('save_return'));
                $form->addCommandButton('saveNextManScoringParticipantScreen', $lng->txt('save_and_next'));
                
                return $form;
        }

        private function sendManScoringParticipantNotification()
        {
        }

        private function buildManScoringParticipantsTable($withData = false)
        {
                require_once 'Modules/Test/classes/tables/class.ilTestManScoringParticipantsTableGUI.php';
                $table = new ilTestManScoringParticipantsTableGUI($this);
                
                if($withData)
                {
                        $participantStatusFilterValue = $table->getFilterItemByPostVar('participant_status')->getValue();
                        $table->setData($this->object->getTestParticipantsForManualScoring($participantStatusFilterValue));
                }

                return $table;
        }
}