ilTestScoringGUI Class Reference

Scoring class for tests. More...

Inheritance diagram for ilTestScoringGUI:

Collaboration diagram for ilTestScoringGUI:

Public Member Functions
	__construct (ilObjTest $a_object)
	ilTestScoringGUI constructor More...
	getTestAccess ()
	setTestAccess ($testAccess)
	executeCommand ()
	execute command More...
Public Member Functions inherited from ilTestServiceGUI
	isContextResultPresentation ()
	setContextResultPresentation ($contextResultPresentation)
	__construct (ilObjTest $a_object)
	The constructor takes the test object reference as parameter. More...
	setParticipantData ($participantData)
	getParticipantData ()
	getPassOverviewTableData (ilTestSession $testSession, $passes, $withResults)
	setObjectiveOrientedContainer (ilTestObjectiveOrientedContainer $objectiveOrientedContainer)
	getObjectiveOrientedContainer ()
	executeCommand ()
	execute command More...
	getCommand ($cmd)
	Retrieves the ilCtrl command. More...
	buildPassOverviewTableGUI ($targetGUI)
	getPassListOfAnswers (&$result_array, $active_id, $pass, $show_solutions=false, $only_answered_questions=false, $show_question_only=false, $show_reached_points=false, $anchorNav=false, ilTestQuestionRelatedObjectivesList $objectivesList=null, ilTestResultHeaderLabelBuilder $testResultHeaderLabelBuilder=null)
	Returns the list of answers of a users test pass. More...
	getPassListOfAnswersWithScoring (&$result_array, $active_id, $pass, $show_solutions=false)
	Returns the list of answers of a users test pass and offers a scoring option. More...
	getResultsSignature ()
	Returns HTML code for a signature field. More...
	getAdditionalUsrDataHtmlAndPopulateWindowTitle ($testSession, $active_id, $overwrite_anonymity=false)
	Returns the user data for a test results output. More...
	getCorrectSolutionOutput ($question_id, $active_id, $pass, ilTestQuestionRelatedObjectivesList $objectivesList=null)
	Returns an output of the solution to an answer compared to the correct solution. More...
	getResultsOfUserOutput ($testSession, $active_id, $pass, $targetGUI, $show_pass_details=true, $show_answers=true, $show_question_only=false, $show_reached_points=false)
	Output of the pass overview for a test called by a test participant. More...
	getResultsHeadUserAndPass ($active_id, $pass)
	Returns the user and pass data for a test results output. More...
	getQuestionResultForTestUsers ($question_id, $test_id)
	Creates a HTML representation for the results of a given question in a test. More...
	populatePassFinishDate ($tpl, $passFinishDate)
	populateExamId (ilTemplate $tpl, int $activeId, int $pass)

Data Fields
const	PART_FILTER_ACTIVE_ONLY = 1
const	PART_FILTER_INACTIVE_ONLY = 2
const	PART_FILTER_ALL_USERS = 3
const	PART_FILTER_MANSCORING_DONE = 4
const	PART_FILTER_MANSCORING_NONE = 5
Data Fields inherited from ilTestServiceGUI
	$object = null
	$service = null
	$lng
	$tpl
	$ctrl
	$ilias
	$tree
	$ref_id

Protected Member Functions
	getDefaultCommand ()
	getActiveSubTabId ()
Protected Member Functions inherited from ilTestServiceGUI
	isPdfDeliveryRequest ()
	getPassDetailsOverviewTableGUI ($result_array, $active_id, $pass, $targetGUI, $targetCMD, $questionDetailsCMD, $questionAnchorNav, ilTestQuestionRelatedObjectivesList $objectivesList=null, $multipleObjectivesInvolved=true)
	buildPassDetailsOverviewTableGUI ($targetGUI, $targetCMD)
	isGradingMessageRequired ()
	getGradingMessageBuilder ($activeId)
	buildQuestionRelatedObjectivesList (ilLOTestQuestionAdapter $objectivesAdapter, ilTestQuestionSequence $testSequence)
	getFilteredTestResult ($active_id, $pass, $considerHiddenQuestions, $considerOptionalQuestions)
	populateContent ($content)
	buildUserTestResultsToolbarGUI ()
	outCorrectSolutionCmd ()
	outCorrectSolution ()
	Creates an output of the solution of an answer compared to the correct solution. More...

Protected Attributes
	$testAccess
Protected Attributes inherited from ilTestServiceGUI
	$db
	$tabs
	$objCache
	$testSessionFactory = null
	$testSequenceFactory = null
	$participantData

Private Member Functions
	fetchActiveIdParameter ()
	fetchPassParameter ($activeId)
	showManScoringParticipantsTable ()
	applyManScoringParticipantsFilter ()
	resetManScoringParticipantsFilter ()
	showManScoringParticipantScreen (ilPropertyFormGUI $form=null)
	saveManScoringParticipantScreen ($redirect=true)
	saveNextManScoringParticipantScreen ()
	saveReturnManScoringParticipantScreen ()
	sendManScoringParticipantNotification ()
	buildManScoringParticipantsTable ($withData=false)

Detailed Description

Scoring class for tests.

Author

Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

Definition at line 17 of file class.ilTestScoringGUI.php.

Constructor & Destructor Documentation

__construct()

ilTestScoringGUI::__construct

(

ilObjTest

$a_object

)

ilTestScoringGUI constructor

The constructor takes the test object reference as parameter

Parameters

object

$a_object

Associated ilObjTest class public

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

    {
        parent::__construct($a_object);
    }

Member Function Documentation

applyManScoringParticipantsFilter()

ilTestScoringGUI::applyManScoringParticipantsFilter ( )

private

Definition at line 167 of file class.ilTestScoringGUI.php.

References $table, buildManScoringParticipantsTable(), and showManScoringParticipantsTable().

    {
        $table = $this->buildManScoringParticipantsTable(false);
        
        $table->resetOffset();
        $table->writeFilterToSession();
        
        $this->showManScoringParticipantsTable();
    }

Here is the call graph for this function:

buildManScoringParticipantsTable()

ilTestScoringGUI::buildManScoringParticipantsTable (   $withData = false )

private

Returns

ilTestManScoringParticipantsTableGUI

Definition at line 497 of file class.ilTestScoringGUI.php.

References $table, and ilTestParticipantAccessFilter\getScoreParticipantsUserFilter().

Referenced by applyManScoringParticipantsFilter(), resetManScoringParticipantsFilter(), saveNextManScoringParticipantScreen(), and showManScoringParticipantsTable().

    {
        require_once 'Modules/Test/classes/tables/class.ilTestManScoringParticipantsTableGUI.php';
        $table = new ilTestManScoringParticipantsTableGUI($this);
        
        if ($withData) {
            $participantStatusFilterValue = $table->getFilterItemByPostVar('participant_status')->getValue();
            
            require_once 'Modules/Test/classes/class.ilTestParticipantList.php';
            $participantList = new ilTestParticipantList($this->object);
            
            $participantList->initializeFromDbRows(
                $this->object->getTestParticipantsForManualScoring($participantStatusFilterValue)
            );
            
            $participantList = $participantList->getAccessFilteredList(
                ilTestParticipantAccessFilter::getScoreParticipantsUserFilter($this->ref_id)
            );
            
            $table->setData($participantList->getParticipantsTableRows());
        }

        return $table;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilTestScoringGUI::executeCommand

(

)

execute command

Definition at line 113 of file class.ilTestScoringGUI.php.

References $DIC, ilObjAssessmentFolder\_mananuallyScoreableQuestionTypesExists(), ilObjTestGUI\accessViolationRedirect(), getActiveSubTabId(), getDefaultCommand(), getTestAccess(), ilUtil\sendFailure(), and ilTestTabsManager\TAB_ID_MANUAL_SCORING.

    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        
        if (!$this->getTestAccess()->checkScoreParticipantsAccess()) {
            ilObjTestGUI::accessViolationRedirect();
        }

        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");
        }
        
        $DIC->tabs()->activateTab(ilTestTabsManager::TAB_ID_MANUAL_SCORING);
        $this->buildSubTabs($this->getActiveSubTabId());
        
        $nextClass = $this->ctrl->getNextClass($this);
        $command = $this->ctrl->getCmd($this->getDefaultCommand());
        
        switch ($nextClass) {
            default:
                $this->$command();
                break;
        }
    }

Here is the call graph for this function:

fetchActiveIdParameter()

ilTestScoringGUI::fetchActiveIdParameter ( )

private

Definition at line 76 of file class.ilTestScoringGUI.php.

References $_GET, $DIC, $ilCtrl, and ilUtil\sendFailure().

Referenced by saveManScoringParticipantScreen(), and showManScoringParticipantScreen().

    {
        global $DIC;
        $ilCtrl = $DIC['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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchPassParameter()

ilTestScoringGUI::fetchPassParameter (   $activeId )

private

Definition at line 94 of file class.ilTestScoringGUI.php.

References $_GET, $pass, and SCORE_LAST_PASS.

Referenced by saveManScoringParticipantScreen(), and showManScoringParticipantScreen().

    {
        // 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;
    }

Here is the caller graph for this function:

getActiveSubTabId()

ilTestScoringGUI::getActiveSubTabId ( )

protected

Returns

string

Definition at line 152 of file class.ilTestScoringGUI.php.

Referenced by executeCommand().

    {
        return 'man_scoring';
    }

Here is the caller graph for this function:

getDefaultCommand()

ilTestScoringGUI::getDefaultCommand ( )

protected

Returns

string

Definition at line 144 of file class.ilTestScoringGUI.php.

Referenced by executeCommand().

    {
        return 'manscoring';
    }

Here is the caller graph for this function:

getTestAccess()

ilTestScoringGUI::getTestAccess

(

)

Returns

ilTestAccess

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

References $testAccess.

Referenced by executeCommand(), ilTestScoringByQuestionsGUI\getAnswerDetail(), saveManScoringParticipantScreen(), and showManScoringParticipantScreen().

    {
        return $this->testAccess;
    }

Here is the caller graph for this function:

resetManScoringParticipantsFilter()

ilTestScoringGUI::resetManScoringParticipantsFilter ( )

private

Definition at line 177 of file class.ilTestScoringGUI.php.

References $table, buildManScoringParticipantsTable(), and showManScoringParticipantsTable().

    {
        $table = $this->buildManScoringParticipantsTable(false);
        
        $table->resetOffset();
        $table->resetFilter();

        $this->showManScoringParticipantsTable();
    }

Here is the call graph for this function:

saveManScoringParticipantScreen()

ilTestScoringGUI::saveManScoringParticipantScreen (   $redirect = true )

private

Parameters

bool

$redirect

Returns

bool Returns a boolean flag, whether or not everything worked fine

Definition at line 235 of file class.ilTestScoringGUI.php.

References $DIC, $form, $ilCtrl, ilTestServiceGUI\$lng, $pass, assQuestion\_getMaximumPoints(), ilObjTestAccess\_getParticipantId(), ilObjAdvancedEditing\_getUsedHTMLTagsAsString(), ilObjUser\_lookupName(), assQuestion\_setReachedPoints(), ilLPStatusWrapper\_updateStatus(), ilObjTestGUI\accessViolationRedirect(), fetchActiveIdParameter(), fetchPassParameter(), getTestAccess(), ilUtil\sendFailure(), ilMailNotification\setAdditionalInformation(), ilTestService\setManScoringDone(), showManScoringParticipantScreen(), and ilUtil\stripSlashes().

Referenced by saveNextManScoringParticipantScreen(), and saveReturnManScoringParticipantScreen().

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
            
        $activeId = $this->fetchActiveIdParameter();
        
        if (!$this->getTestAccess()->checkScoreParticipantsAccessForActiveId($activeId)) {
            ilObjTestGUI::accessViolationRedirect();
        }
        
        $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;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveNextManScoringParticipantScreen()

ilTestScoringGUI::saveNextManScoringParticipantScreen ( )

private

Definition at line 362 of file class.ilTestScoringGUI.php.

References $_GET, $DIC, $ilCtrl, $index, ilTestServiceGUI\$participantData, $table, buildManScoringParticipantsTable(), and saveManScoringParticipantScreen().

    {
        global $DIC;
        $ilCtrl = $DIC['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");
        }
    }

Here is the call graph for this function:

saveReturnManScoringParticipantScreen()

ilTestScoringGUI::saveReturnManScoringParticipantScreen ( )

private

Definition at line 389 of file class.ilTestScoringGUI.php.

References $DIC, $form, $ilCtrl, ilTestServiceGUI\$lng, $pass, $text, assQuestion\_getMaximumPoints(), assQuestion\_getReachedPoints(), ilTestService\isManScoringDone(), saveManScoringParticipantScreen(), ilCheckboxInputGUI\setChecked(), ilCustomInputGUI\setHtml(), ilNonEditableValueGUI\setValue(), and ilTextAreaInputGUI\setValue().

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];

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

Here is the call graph for this function:

sendManScoringParticipantNotification()

ilTestScoringGUI::sendManScoringParticipantNotification ( )

private

Definition at line 490 of file class.ilTestScoringGUI.php.

    {
    }

setTestAccess()

ilTestScoringGUI::setTestAccess

(

$testAccess

)

Parameters

ilTestAccess

$testAccess

Definition at line 55 of file class.ilTestScoringGUI.php.

References $DIC, and $testAccess.

    {
        $this->testAccess = $testAccess;
    }

showManScoringParticipantScreen()

ilTestScoringGUI::showManScoringParticipantScreen ( ilPropertyFormGUI  $form = null )

private

Definition at line 187 of file class.ilTestScoringGUI.php.

References $DIC, $form, ilTestServiceGUI\$lng, $pass, $table, ilTestServiceGUI\$tpl, ilObjTestGUI\accessViolationRedirect(), fetchActiveIdParameter(), fetchPassParameter(), and getTestAccess().

Referenced by saveManScoringParticipantScreen().

    {
        global $DIC;
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
        
        $activeId = $this->fetchActiveIdParameter();
        
        if (!$this->getTestAccess()->checkScoreParticipantsAccessForActiveId($activeId)) {
            ilObjTestGUI::accessViolationRedirect();
        }
        
        $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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showManScoringParticipantsTable()

ilTestScoringGUI::showManScoringParticipantsTable ( )

private

Definition at line 157 of file class.ilTestScoringGUI.php.

References $DIC, $table, ilTestServiceGUI\$tpl, and buildManScoringParticipantsTable().

Referenced by applyManScoringParticipantsFilter(), and resetManScoringParticipantsFilter().

    {
        global $DIC;
        $tpl = $DIC['tpl'];

        $table = $this->buildManScoringParticipantsTable(true);
        
        $tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$testAccess

ilTestScoringGUI::$testAccess

protected

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

Referenced by getTestAccess(), and setTestAccess().

PART_FILTER_ACTIVE_ONLY

const ilTestScoringGUI::PART_FILTER_ACTIVE_ONLY = 1

Definition at line 19 of file class.ilTestScoringGUI.php.

Referenced by ilTestManScoringParticipantsTableGUI\initFilter().

PART_FILTER_ALL_USERS

const ilTestScoringGUI::PART_FILTER_ALL_USERS = 3

Definition at line 21 of file class.ilTestScoringGUI.php.

Referenced by ilTestManScoringParticipantsTableGUI\initFilter().

PART_FILTER_INACTIVE_ONLY

const ilTestScoringGUI::PART_FILTER_INACTIVE_ONLY = 2

Definition at line 20 of file class.ilTestScoringGUI.php.

Referenced by ilTestManScoringParticipantsTableGUI\initFilter().

PART_FILTER_MANSCORING_DONE

const ilTestScoringGUI::PART_FILTER_MANSCORING_DONE = 4

Definition at line 22 of file class.ilTestScoringGUI.php.

Referenced by ilTestManScoringParticipantsTableGUI\initFilter().

PART_FILTER_MANSCORING_NONE

const ilTestScoringGUI::PART_FILTER_MANSCORING_NONE = 5

Definition at line 23 of file class.ilTestScoringGUI.php.

Referenced by ilTestManScoringParticipantsTableGUI\initFilter().

---

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

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