Service GUI class for tests. More...

Inheritance diagram for ilTestServiceGUI:

Collaboration diagram for ilTestServiceGUI:

Public Member Functions
	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, $targetCmd='')

	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)

Data Fields
	$object = null

	$service = null

	$lng

	$tpl

	$ctrl

	$ilias

	$tree

	$ref_id

Protected Member Functions
	handleTabs ($activeTabId)

	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
	$db

	$tabs

	$objCache

	$testSessionFactory = null

	$testSequenceFactory = null

	$participantData

Private Attributes
	$objectiveOrientedContainer

	$contextResultPresentation = true

Detailed Description

Service GUI class for tests.

This class is the parent class for all service classes which are called from ilObjTestGUI. This is mainly done to reduce the size of ilObjTestGUI to put command service functions into classes that could be called by ilCtrl.

@ilCtrl_IsCalledBy ilTestServiceGUI: ilObjTestGUI

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 21 of file class.ilTestServiceGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTestServiceGUI::__construct ( ilObjTest $a_object )

The constructor takes the test object reference as parameter.

Parameters

object $a_object Associated ilObjTest class @access public

Reimplemented in ilTestEvaluationGUI, ilTestScoringByQuestionsGUI, and ilTestScoringGUI.

Definition at line 108 of file class.ilTestServiceGUI.php.

    {
        global $lng, $tpl, $ilCtrl, $ilias, $tree, $ilDB, $ilPluginAdmin, $ilTabs, $ilObjDataCache;
 
        $this->db = $ilDB;
        $this->lng =&$lng;
        $this->tpl =&$tpl;
        $this->ctrl =&$ilCtrl;
        $this->tabs = $ilTabs;
        $this->objCache = $ilObjDataCache;
        $this->ilias =&$ilias;
        $this->object =&$a_object;
        $this->tree =&$tree;
        $this->ref_id = $a_object->ref_id;
 
        $this->service = new ilTestService($a_object);
        
        require_once 'Modules/Test/classes/class.ilTestSessionFactory.php';
        $this->testSessionFactory = new ilTestSessionFactory($this->object);
 
        require_once 'Modules/Test/classes/class.ilTestSequenceFactory.php';
        $this->testSequenceFactory = new ilTestSequenceFactory($ilDB, $lng, $ilPluginAdmin, $this->object);
 
        $this->objectiveOrientedContainer = null;
    }

References $ilCtrl, $ilDB, $ilias, $lng, $tpl, and $tree.

Member Function Documentation

◆ buildPassDetailsOverviewTableGUI()

ilTestServiceGUI::buildPassDetailsOverviewTableGUI	(	$targetGUI,
		$targetCMD
	)

protected

Returns: ilTestPassDetailsOverviewTableGUI

Definition at line 967 of file class.ilTestServiceGUI.php.

    {
        require_once 'Modules/Test/classes/tables/class.ilTestPassDetailsOverviewTableGUI.php';
        $tableGUI = new ilTestPassDetailsOverviewTableGUI($this->ctrl, $targetGUI, $targetCMD);
        $tableGUI->setIsPdfGenerationRequest($this->isPdfDeliveryRequest());
        return $tableGUI;
    }

References isPdfDeliveryRequest().

Referenced by ilTestEvaluationGUI\getFilteredTestResult(), getFilteredTestResult(), getPassDetailsOverviewTableGUI(), ilTestEvaluationGUI\outParticipantsPassDetailsResetTableFilter(), ilTestEvaluationGUI\outParticipantsPassDetailsSetTableFilter(), ilTestEvaluationGUI\outUserPassDetailsResetTableFilter(), ilTestEvaluationGUI\outUserPassDetailsSetTableFilter(), ilTestEvalObjectiveOrientedGUI\showVirtualPassResetTableFilterCmd(), and ilTestEvalObjectiveOrientedGUI\showVirtualPassSetTableFilterCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildPassOverviewTableGUI()

ilTestServiceGUI::buildPassOverviewTableGUI	(	$targetGUI,
		$targetCmd = `''`
	)

Returns: ilTestPassOverviewTableGUI $tableGUI

Definition at line 337 of file class.ilTestServiceGUI.php.

    {
        require_once 'Modules/Test/classes/tables/class.ilTestPassOverviewTableGUI.php';
 
        $table = new ilTestPassOverviewTableGUI($targetGUI, $targetCmd);
        
        $table->setPdfPresentationEnabled(
            isset($_GET['pdf']) && $_GET['pdf'] == 1
        );
        
        $table->setObjectiveOrientedPresentationEnabled(
            $this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()
        );
        
        return $table;
    }

References $_GET, $table, and getObjectiveOrientedContainer().

Referenced by ilTestEvaluationGUI\outParticipantsResultsOverview(), ilTestEvaluationGUI\outUserListOfAnswerPasses(), and ilTestEvaluationGUI\outUserResultsOverview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildQuestionRelatedObjectivesList()

ilTestServiceGUI::buildQuestionRelatedObjectivesList	(	ilLOTestQuestionAdapter	$objectivesAdapter,
		ilTestQuestionSequence	$testSequence
	)

protected

Definition at line 1010 of file class.ilTestServiceGUI.php.

    {
        require_once 'Modules/Test/classes/class.ilTestQuestionRelatedObjectivesList.php';
        $questionRelatedObjectivesList = new ilTestQuestionRelatedObjectivesList();
            
        $objectivesAdapter->buildQuestionRelatedObjectiveList($testSequence, $questionRelatedObjectivesList);
        
        return $questionRelatedObjectivesList;
    }

References ilLOTestQuestionAdapter\buildQuestionRelatedObjectiveList().

Referenced by ilTestPlayerAbstractGUI\archiveParticipantSubmission(), ilTestSubmissionReviewGUI\buildUserReviewOutput(), getPassOverviewTableData(), getResultsOfUserOutput(), outCorrectSolution(), ilTestEvaluationGUI\outParticipantsPassDetails(), ilTestEvaluationGUI\outUserListOfAnswerPasses(), ilTestEvaluationGUI\outUserPassDetails(), and ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildUserTestResultsToolbarGUI()

ilTestServiceGUI::buildUserTestResultsToolbarGUI ( )

protected

Returns: ilTestResultsToolbarGUI

Definition at line 1091 of file class.ilTestServiceGUI.php.

    {
        require_once 'Modules/Test/classes/toolbars/class.ilTestResultsToolbarGUI.php';
        $toolbar = new ilTestResultsToolbarGUI($this->ctrl, $this->tpl, $this->lng);
 
        $toolbar->setSkillResultButtonEnabled($this->object->isSkillServiceToBeConsidered());
 
        return $toolbar;
    }

Referenced by ilTestEvaluationGUI\outParticipantsPassDetails(), ilTestEvaluationGUI\outParticipantsResultsOverview(), ilTestEvaluationGUI\outUserPassDetails(), ilTestEvaluationGUI\outUserResultsOverview(), and ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd().

Here is the caller graph for this function:

◆ executeCommand()

ilTestServiceGUI::executeCommand ( )

execute command

Reimplemented in ilTestEvalObjectiveOrientedGUI, ilTestEvaluationGUI, ilTestOutputGUI, ilTestPlayerDynamicQuestionSetGUI, ilTestScoringGUI, and ilTestSubmissionReviewGUI.

Definition at line 271 of file class.ilTestServiceGUI.php.

    {
        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass($this);
 
        $cmd = $this->getCommand($cmd);
        switch ($next_class) {
            default:
                $ret =&$this->$cmd();
                break;
        }
        return $ret;
    }

References $ret, and getCommand().

Here is the call graph for this function:

◆ getAdditionalUsrDataHtmlAndPopulateWindowTitle()

ilTestServiceGUI::getAdditionalUsrDataHtmlAndPopulateWindowTitle	(	$testSession,
		$active_id,
		$overwrite_anonymity = `false`
	)

Returns the user data for a test results output.

Parameters

	ilTestSession\|ilTestSessionDynamicQuestionSet
integer	$user_id	The user ID of the user
boolean	$overwrite_anonymity	TRUE if the anonymity status should be overwritten, FALSE otherwise

Returns: string HTML code of the user data for the test results @access public

Definition at line 623 of file class.ilTestServiceGUI.php.

    {
        if (!is_object($testSession)) {
            throw new TestException();
        }
        $template = new ilTemplate("tpl.il_as_tst_results_userdata.html", true, true, "Modules/Test");
        include_once './Services/User/classes/class.ilObjUser.php';
        $user_id = $this->object->_getUserIdFromActiveId($active_id);
        if (strlen(ilObjUser::_lookupLogin($user_id)) > 0) {
            $user = new ilObjUser($user_id);
        } else {
            $user = new ilObjUser();
            $user->setLastname($this->lng->txt("deleted_user"));
        }
        $t = $testSession->getSubmittedTimestamp();
        if (!$t) {
            $t = $this->object->_getLastAccess($testSession->getActiveId());
        }
        
        if ($this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()) {
            $uname = $this->object->userLookupFullName($user_id, $overwrite_anonymity);
            $template->setCurrentBlock("name");
            $template->setVariable('TXT_USR_NAME', $this->lng->txt("name"));
            $template->setVariable('VALUE_USR_NAME', $uname);
            $template->parseCurrentBlock();
        }
 
        $title_matric = "";
        if (strlen($user->getMatriculation()) && (($this->object->getAnonymity() == false) || ($overwrite_anonymity))) {
            $template->setCurrentBlock("matriculation");
            $template->setVariable("TXT_USR_MATRIC", $this->lng->txt("matriculation"));
            $template->setVariable("VALUE_USR_MATRIC", $user->getMatriculation());
            $template->parseCurrentBlock();
            $title_matric = " - " . $this->lng->txt("matriculation") . ": " . $user->getMatriculation();
        }
 
        $invited_user = array_pop($this->object->getInvitedUsers($user_id));
        if (strlen($invited_user["clientip"])) {
            $template->setCurrentBlock("client_ip");
            $template->setVariable("TXT_CLIENT_IP", $this->lng->txt("client_ip"));
            $template->setVariable("VALUE_CLIENT_IP", $invited_user["clientip"]);
            $template->parseCurrentBlock();
            $title_client = " - " . $this->lng->txt("clientip") . ": " . $invited_user["clientip"];
        }
 
        $template->setVariable("TXT_TEST_TITLE", $this->lng->txt("title"));
        $template->setVariable("VALUE_TEST_TITLE", $this->object->getTitle());
        
        // change the pagetitle (tab title or title in title bar of window)
        $pagetitle = $this->object->getTitle() . $title_matric . $title_client;
        $this->tpl->setHeaderPageTitle($pagetitle);
        
        return $template->get();
    }

References $t, $template, ilObjUser\_lookupLogin(), and getObjectiveOrientedContainer().

Referenced by getResultsOfUserOutput(), ilTestEvaluationGUI\outParticipantsPassDetails(), ilTestEvaluationGUI\outParticipantsResultsOverview(), ilTestEvaluationGUI\outUserListOfAnswerPasses(), ilTestEvaluationGUI\outUserPassDetails(), ilTestEvaluationGUI\outUserResultsOverview(), and ilTestPlayerAbstractGUI\showListOfAnswers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCommand()

ilTestServiceGUI::getCommand ( $cmd )

Retrieves the ilCtrl command.

@access public

Definition at line 290 of file class.ilTestServiceGUI.php.

    {
        return $cmd;
    }

Referenced by ilTestEvaluationGUI\executeCommand(), ilTestOutputGUI\executeCommand(), ilTestScoringGUI\executeCommand(), and executeCommand().

Here is the caller graph for this function:

◆ getCorrectSolutionOutput()

ilTestServiceGUI::getCorrectSolutionOutput	(		$question_id,
			$active_id,
			$pass,
		ilTestQuestionRelatedObjectivesList	$objectivesList = `null`
	)

Returns an output of the solution to an answer compared to the correct solution.

Parameters

integer	$question_id	Database ID of the question
integer	$active_id	Active ID of the active user
integer	$pass	Test pass

Returns: string HTML code of the correct solution comparison @access public

Definition at line 687 of file class.ilTestServiceGUI.php.

    {
        global $ilUser;
 
        $test_id = $this->object->getTestId();
        $question_gui = $this->object->createQuestionGUI("", $question_id);
 
        if ($this->isPdfDeliveryRequest()) {
            $question_gui->setRenderPurpose(assQuestionGUI::RENDER_PURPOSE_PRINT_PDF);
        }
 
        $template = new ilTemplate("tpl.il_as_tst_correct_solution_output.html", true, true, "Modules/Test");
        $show_question_only = ($this->object->getShowSolutionAnswersOnly()) ? true : false;
        $result_output = $question_gui->getSolutionOutput($active_id, $pass, true, false, $show_question_only, $this->object->getShowSolutionFeedback(), false, false, true);
        $best_output = $question_gui->getSolutionOutput($active_id, $pass, false, false, $show_question_only, false, true, false, false);
        if ($this->object->getShowSolutionFeedback() && $_GET['cmd'] != 'outCorrectSolution') {
            $specificAnswerFeedback = $question_gui->getSpecificFeedbackOutput($active_id, $pass);
            if (strlen($specificAnswerFeedback)) {
                $template->setCurrentBlock("outline_specific_feedback");
                $template->setVariable("OUTLINE_SPECIFIC_FEEDBACK", $specificAnswerFeedback);
                $template->parseCurrentBlock();
            }
        }
        if ($this->object->isBestSolutionPrintedWithResult() && strlen($best_output)) {
            $template->setCurrentBlock("best_solution");
            $template->setVariable("TEXT_BEST_SOLUTION", $this->lng->txt("tst_best_solution_is"));
            $template->setVariable("BEST_OUTPUT", $best_output);
            $template->parseCurrentBlock();
        }
        $template->setVariable("TEXT_YOUR_SOLUTION", $this->lng->txt("tst_your_answer_was"));
        $maxpoints = $question_gui->object->getMaximumPoints();
        if ($maxpoints == 1) {
            $template->setVariable("QUESTION_TITLE", $this->object->getQuestionTitle($question_gui->object->getTitle()) . " (" . $maxpoints . " " . $this->lng->txt("point") . ")");
        } else {
            $template->setVariable("QUESTION_TITLE", $this->object->getQuestionTitle($question_gui->object->getTitle()) . " (" . $maxpoints . " " . $this->lng->txt("points") . ")");
        }
        if ($objectivesList !== null) {
            $objectives = $this->lng->txt('tst_res_lo_objectives_header') . ': ';
            $objectives .= $objectivesList->getQuestionRelatedObjectiveTitles($question_gui->object->getId());
            $template->setVariable('OBJECTIVES', $objectives);
        }
        $template->setVariable("SOLUTION_OUTPUT", $result_output);
        $template->setVariable("RECEIVED_POINTS", sprintf($this->lng->txt("you_received_a_of_b_points"), $question_gui->object->getReachedPoints($active_id, $pass), $maxpoints));
        $template->setVariable("FORMACTION", $this->ctrl->getFormAction($this));
        $template->setVariable("BACKLINK_TEXT", "&lt;&lt; " . $this->lng->txt("back"));
        return $template->get();
    }

References $_GET, $ilUser, $pass, $template, isPdfDeliveryRequest(), assQuestionGUI\RENDER_PURPOSE_PRINT_PDF, and sprintf.

Referenced by ilTestPlayerAbstractGUI\outCorrectSolution(), and outCorrectSolution().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilteredTestResult()

ilTestServiceGUI::getFilteredTestResult	(	$active_id,
		$pass,
		$considerHiddenQuestions,
		$considerOptionalQuestions
	)

protected

Reimplemented in ilTestEvaluationGUI.

Definition at line 1020 of file class.ilTestServiceGUI.php.

    {
        global $ilDB, $ilPluginAdmin;
 
        $table_gui = $this->buildPassDetailsOverviewTableGUI($this, 'outUserPassDetails');
        $table_gui->initFilter();
 
        require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionList.php';
        $questionList = new ilAssQuestionList($ilDB, $this->lng, $ilPluginAdmin);
 
        $questionList->setParentObjIdsFilter(array($this->object->getId()));
        $questionList->setQuestionInstanceTypeFilter(ilAssQuestionList::QUESTION_INSTANCE_TYPE_DUPLICATES);
 
        foreach ($table_gui->getFilterItems() as $item) {
            if (substr($item->getPostVar(), 0, strlen('tax_')) == 'tax_') {
                $v = $item->getValue();
 
                if (is_array($v) && count($v) && !(int) $v[0]) {
                    continue;
                }
 
                $taxId = substr($item->getPostVar(), strlen('tax_'));
                $questionList->addTaxonomyFilter($taxId, $item->getValue(), $this->object->getId(), 'tst');
            } elseif ($item->getValue() !== false) {
                $questionList->addFieldFilter($item->getPostVar(), $item->getValue());
            }
        }
 
        $questionList->load();
 
        $filteredTestResult = array();
 
        $resultData = $this->object->getTestResult($active_id, $pass, false, $considerHiddenQuestions, $considerOptionalQuestions);
 
        foreach ($resultData as $resultItemKey => $resultItemValue) {
            if ($resultItemKey === 'test' || $resultItemKey === 'pass') {
                continue;
            }
 
            if (!$questionList->isInList($resultItemValue['qid'])) {
                continue;
            }
 
            $filteredTestResult[] = $resultItemValue;
        }
 
        return $filteredTestResult;
    }

References $ilDB, $pass, buildPassDetailsOverviewTableGUI(), and ilAssQuestionList\QUESTION_INSTANCE_TYPE_DUPLICATES.

Here is the call graph for this function:

◆ getGradingMessageBuilder()

ilTestServiceGUI::getGradingMessageBuilder ( $activeId )

protected

Parameters

integer $activeId

Returns: ilTestGradingMessageBuilder

Definition at line 1000 of file class.ilTestServiceGUI.php.

    {
        require_once 'Modules/Test/classes/class.ilTestGradingMessageBuilder.php';
        $gradingMessageBuilder = new ilTestGradingMessageBuilder($this->lng, $this->object);
        
        $gradingMessageBuilder->setActiveId($activeId);
        
        return $gradingMessageBuilder;
    }

Referenced by getResultsOfUserOutput(), ilTestEvaluationGUI\outParticipantsPassDetails(), ilTestEvaluationGUI\outParticipantsResultsOverview(), ilTestEvaluationGUI\outUserPassDetails(), and ilTestEvaluationGUI\outUserResultsOverview().

Here is the caller graph for this function:

◆ getObjectiveOrientedContainer()

ilTestServiceGUI::getObjectiveOrientedContainer ( )

Returns: ilTestObjectiveOrientedContainer

Definition at line 263 of file class.ilTestServiceGUI.php.

    {
        return $this->objectiveOrientedContainer;
    }

References $objectiveOrientedContainer.

Referenced by ilTestPlayerAbstractGUI\archiveParticipantSubmission(), buildPassOverviewTableGUI(), ilTestSubmissionReviewGUI\buildUserReviewOutput(), ilTestOutputGUI\executeCommand(), getAdditionalUsrDataHtmlAndPopulateWindowTitle(), getPassOverviewTableData(), getResultsOfUserOutput(), handleTabs(), isGradingMessageRequired(), outCorrectSolution(), ilTestEvaluationGUI\outParticipantsPassDetails(), ilTestEvaluationGUI\outParticipantsResultsOverview(), ilTestEvaluationGUI\outUserListOfAnswerPasses(), ilTestEvaluationGUI\outUserPassDetails(), ilTestEvaluationGUI\outUserResultsOverview(), ilTestPlayerAbstractGUI\showListOfAnswers(), ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd(), and ilTestOutputGUI\startTestCmd().

Here is the caller graph for this function:

◆ getParticipantData()

ilTestServiceGUI::getParticipantData ( )

Returns: \ilTestParticipantData

Definition at line 145 of file class.ilTestServiceGUI.php.

    {
        return $this->participantData;
    }

References $participantData.

◆ getPassDetailsOverviewTableGUI()

ilTestServiceGUI::getPassDetailsOverviewTableGUI	(		$result_array,
			$active_id,
			$pass,
			$targetGUI,
			$targetCMD,
			$questionDetailsCMD,
			$questionAnchorNav,
		ilTestQuestionRelatedObjectivesList	$objectivesList = `null`,
			$multipleObjectivesInvolved = `true`
	)

protected

Definition at line 539 of file class.ilTestServiceGUI.php.

    {
        $this->ctrl->setParameter($targetGUI, 'active_id', $active_id);
        $this->ctrl->setParameter($targetGUI, 'pass', $pass);
 
        $tableGUI = $this->buildPassDetailsOverviewTableGUI($targetGUI, $targetCMD);
 
        if (!$this->isPdfDeliveryRequest()) {
            $tableGUI->setAnswerListAnchorEnabled($questionAnchorNav);
        }
 
        $tableGUI->setSingleAnswerScreenCmd($questionDetailsCMD);
        $tableGUI->setShowHintCount($this->object->isOfferingQuestionHintsEnabled());
 
        if ($objectivesList !== null) {
            $tableGUI->setQuestionRelatedObjectivesList($objectivesList);
            $tableGUI->setObjectiveOrientedPresentationEnabled(true);
        }
        
        $tableGUI->setMultipleObjectivesInvolved($multipleObjectivesInvolved);
 
        $tableGUI->setActiveId($active_id);
        $tableGUI->setShowSuggestedSolution(false);
 
        $usersQuestionSolutions = array();
 
        foreach ($result_array as $key => $val) {
            if ($key === 'test' || $key === 'pass') {
                continue;
            }
 
            if ($this->object->getShowSolutionSuggested() && strlen($val['solution'])) {
                $tableGUI->setShowSuggestedSolution(true);
            }
 
            if (isset($val['pass'])) {
                $tableGUI->setPassColumnEnabled(true);
            }
 
            $usersQuestionSolutions[$key] = $val;
        }
 
        $tableGUI->initColumns()->initFilter();
 
        $tableGUI->setFilterCommand($targetCMD . 'SetTableFilter');
        $tableGUI->setResetCommand($targetCMD . 'ResetTableFilter');
 
        $tableGUI->setData($usersQuestionSolutions);
 
        return $tableGUI;
    }

References $key, $pass, buildPassDetailsOverviewTableGUI(), and isPdfDeliveryRequest().

Referenced by getResultsOfUserOutput(), ilTestEvaluationGUI\outParticipantsPassDetails(), ilTestEvaluationGUI\outUserPassDetails(), and ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPassListOfAnswers()

ilTestServiceGUI::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.

Parameters

array	$result_array	An array containing the results of the users test pass (generated by ilObjTest::getTestResult)
integer	$active_id	Active ID of the active user
integer	$pass	Test pass
boolean	$show_solutions	TRUE, if the solution output should be shown in the answers, FALSE otherwise

Returns: string HTML code of the list of answers @access public

Definition at line 364 of file class.ilTestServiceGUI.php.

    {
        $maintemplate = new ilTemplate("tpl.il_as_tst_list_of_answers.html", true, true, "Modules/Test");
 
        $counter = 1;
        // output of questions with solutions
        foreach ($result_array as $question_data) {
            if (($question_data["workedthrough"] == 1) || ($only_answered_questions == false)) {
                $template = new ilTemplate("tpl.il_as_qpl_question_printview.html", true, true, "Modules/TestQuestionPool");
                $question = $question_data["qid"];
                if (is_numeric($question)) {
                    $maintemplate->setCurrentBlock("printview_question");
                    $question_gui = $this->object->createQuestionGUI("", $question);
                    if (is_object($question_gui)) {
                        if ($this->isPdfDeliveryRequest()) {
                            $question_gui->setRenderPurpose(assQuestionGUI::RENDER_PURPOSE_PRINT_PDF);
                        }
                        
                        if ($anchorNav) {
                            $template->setCurrentBlock('block_id');
                            $template->setVariable('BLOCK_ID', "detailed_answer_block_act_{$active_id}_qst_{$question}");
                            $template->parseCurrentBlock();
 
                            $template->setCurrentBlock('back_anchor');
                            $template->setVariable('HREF_BACK_ANCHOR', "#pass_details_tbl_row_act_{$active_id}_qst_{$question}");
                            $template->setVariable('TXT_BACK_ANCHOR', $this->lng->txt('tst_back_to_question_list'));
                            $template->parseCurrentBlock();
                        }
 
                        if ($show_reached_points) {
                            $template->setCurrentBlock("result_points");
                            $template->setVariable("RESULT_POINTS", $this->lng->txt("tst_reached_points") . ": " . $question_gui->object->getReachedPoints($active_id, $pass) . " " . $this->lng->txt("of") . " " . $question_gui->object->getMaximumPoints());
                            $template->parseCurrentBlock();
                        }
                        $template->setVariable("COUNTER_QUESTION", $counter . ". ");
                        $template->setVariable("TXT_QUESTION_ID", $this->lng->txt('question_id_short'));
                        $template->setVariable("QUESTION_ID", $question_gui->object->getId());
                        $template->setVariable("QUESTION_TITLE", $this->object->getQuestionTitle($question_gui->object->getTitle()));
                        
                        if ($objectivesList !== null) {
                            $objectives = $this->lng->txt('tst_res_lo_objectives_header') . ': ';
                            $objectives .= $objectivesList->getQuestionRelatedObjectiveTitles($question_gui->object->getId());
                            $template->setVariable("OBJECTIVES", $objectives);
                        }
 
                        $show_question_only = ($this->object->getShowSolutionAnswersOnly()) ? true : false;
 
                        $showFeedback = $this->isContextResultPresentation() && $this->object->getShowSolutionFeedback();
                        $show_solutions = $this->isContextResultPresentation() && $show_solutions;
                        
                        if ($show_solutions) {
                            $compare_template = new ilTemplate('tpl.il_as_tst_answers_compare.html', true, true, 'Modules/Test');
                            $compare_template->setVariable("HEADER_PARTICIPANT", $this->lng->txt('tst_header_participant'));
                            $compare_template->setVariable("HEADER_SOLUTION", $this->lng->txt('tst_header_solution'));
                            $result_output = $question_gui->getSolutionOutput($active_id, $pass, $show_solutions, false, $show_question_only, $showFeedback);
                            $best_output   = $question_gui->getSolutionOutput($active_id, $pass, false, false, $show_question_only, false, true);
 
                            $compare_template->setVariable('PARTICIPANT', $result_output);
                            $compare_template->setVariable('SOLUTION', $best_output);
                            $template->setVariable('SOLUTION_OUTPUT', $compare_template->get());
                        } else {
                            $result_output = $question_gui->getSolutionOutput($active_id, $pass, $show_solutions, false, $show_question_only, $showFeedback);
                            $template->setVariable('SOLUTION_OUTPUT', $result_output);
                        }
 
                        $maintemplate->setCurrentBlock("printview_question");
                        $maintemplate->setVariable("QUESTION_PRINTVIEW", $template->get());
                        $maintemplate->parseCurrentBlock();
                        $counter++;
                    }
                }
            }
        }
 
        if ($testResultHeaderLabelBuilder !== null) {
            if ($pass !== null) {
                $headerText = $testResultHeaderLabelBuilder->getListOfAnswersHeaderLabel($pass + 1);
            } else {
                $headerText = $testResultHeaderLabelBuilder->getVirtualListOfAnswersHeaderLabel();
            }
        } else {
            $headerText = '';
        }
 
        $maintemplate->setVariable("RESULTS_OVERVIEW", $headerText);
        return $maintemplate->get();
    }

References $counter, $pass, $template, isContextResultPresentation(), isPdfDeliveryRequest(), and assQuestionGUI\RENDER_PURPOSE_PRINT_PDF.

Referenced by getResultsOfUserOutput(), ilTestEvaluationGUI\outParticipantsPassDetails(), ilTestEvaluationGUI\outUserListOfAnswerPasses(), ilTestEvaluationGUI\outUserPassDetails(), and ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPassListOfAnswersWithScoring()

ilTestServiceGUI::getPassListOfAnswersWithScoring	(	&	$result_array,
			$active_id,
			$pass,
			$show_solutions = `false`
	)

Returns the list of answers of a users test pass and offers a scoring option.

Parameters

array	$result_array	An array containing the results of the users test pass (generated by ilObjTest::getTestResult)
integer	$active_id	Active ID of the active user
integer	$pass	Test pass
boolean	$show_solutions	TRUE, if the solution output should be shown in the answers, FALSE otherwise

Returns: string HTML code of the list of answers @access public

Deprecated:

Definition at line 464 of file class.ilTestServiceGUI.php.

    {
        include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
        
        $maintemplate = new ilTemplate("tpl.il_as_tst_list_of_answers.html", true, true, "Modules/Test");
 
        include_once "./Modules/Test/classes/class.ilObjAssessmentFolder.php";
        $scoring = ilObjAssessmentFolder::_getManualScoring();
        
        $counter = 1;
        // output of questions with solutions
        foreach ($result_array as $question_data) {
            $question = $question_data["qid"];
            if (is_numeric($question)) {
                $question_gui = $this->object->createQuestionGUI("", $question);
                if (in_array($question_gui->object->getQuestionTypeID(), $scoring)) {
                    $template = new ilTemplate("tpl.il_as_qpl_question_printview.html", true, true, "Modules/TestQuestionPool");
                    $scoretemplate = new ilTemplate("tpl.il_as_tst_manual_scoring_points.html", true, true, "Modules/Test");
                    #mbecker: No such block. $this->tpl->setCurrentBlock("printview_question");
                    $template->setVariable("COUNTER_QUESTION", $counter . ". ");
                    $template->setVariable("QUESTION_TITLE", $this->object->getQuestionTitle($question_gui->object->getTitle()));
                    $points = $question_gui->object->getMaximumPoints();
                    if ($points == 1) {
                        $template->setVariable("QUESTION_POINTS", $points . " " . $this->lng->txt("point"));
                    } else {
                        $template->setVariable("QUESTION_POINTS", $points . " " . $this->lng->txt("points"));
                    }
                    
                    $show_question_only = ($this->object->getShowSolutionAnswersOnly()) ? true : false;
                    $result_output = $question_gui->getSolutionOutput($active_id, $pass, $show_solutions, false, $show_question_only, $this->object->getShowSolutionFeedback(), false, true);
 
                    $solout = $question_gui->object->getSuggestedSolutionOutput();
                    if (strlen($solout)) {
                        $scoretemplate->setCurrentBlock("suggested_solution");
                        $scoretemplate->setVariable("TEXT_SUGGESTED_SOLUTION", $this->lng->txt("solution_hint"));
                        $scoretemplate->setVariable("VALUE_SUGGESTED_SOLUTION", $solout);
                        $scoretemplate->parseCurrentBlock();
                    }
                    
                    $scoretemplate->setCurrentBlock("feedback");
                    $scoretemplate->setVariable("FEEDBACK_NAME_INPUT", $question);
                    $feedback = $this->object->getManualFeedback($active_id, $question, $pass);
                    $scoretemplate->setVariable("VALUE_FEEDBACK", ilUtil::prepareFormOutput($this->object->prepareTextareaOutput($feedback, true)));
                    $scoretemplate->setVariable("TEXT_MANUAL_FEEDBACK", $this->lng->txt("set_manual_feedback"));
                    $scoretemplate->parseCurrentBlock();
 
                    $scoretemplate->setVariable("NAME_INPUT", $question);
                    $this->ctrl->setParameter($this, "active_id", $active_id);
                    $this->ctrl->setParameter($this, "pass", $pass);
                    $scoretemplate->setVariable("FORMACTION", $this->ctrl->getFormAction($this, "manscoring"));
                    $scoretemplate->setVariable("LABEL_INPUT", $this->lng->txt("tst_change_points_for_question"));
                    $scoretemplate->setVariable("VALUE_INPUT", " value=\"" . assQuestion::_getReachedPoints($active_id, $question_data["qid"], $pass) . "\"");
                    $scoretemplate->setVariable("VALUE_SAVE", $this->lng->txt("save"));
                    
                    $template->setVariable("SOLUTION_OUTPUT", $result_output);
                    $maintemplate->setCurrentBlock("printview_question");
                    $maintemplate->setVariable("QUESTION_PRINTVIEW", $template->get());
                    $maintemplate->setVariable("QUESTION_SCORING", $scoretemplate->get());
                    $maintemplate->parseCurrentBlock();
                }
                $counter++;
            }
        }
        if ($counter == 1) {
            // no scorable questions found
            $maintemplate->setVariable("NO_QUESTIONS_FOUND", $this->lng->txt("manscoring_questions_not_found"));
        }
        $maintemplate->setVariable("RESULTS_OVERVIEW", sprintf($this->lng->txt("manscoring_results_pass"), $pass+1));
 
        include_once "./Services/YUI/classes/class.ilYuiUtil.php";
        ilYuiUtil::initDomEvent();
 
        return $maintemplate->get();
    }

References $counter, $pass, $template, ilObjAssessmentFolder\_getManualScoring(), assQuestion\_getReachedPoints(), ilYuiUtil\initDomEvent(), ilUtil\prepareFormOutput(), and sprintf.

Here is the call graph for this function:

◆ getPassOverviewTableData()

ilTestServiceGUI::getPassOverviewTableData	(	ilTestSession	$testSession,
			$passes,
			$withResults
	)

Parameters

ilTestSession	$testSession
	$short

Returns: array

Definition at line 155 of file class.ilTestServiceGUI.php.

    {
        $data = array();
 
        if ($this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()) {
            $considerHiddenQuestions = false;
 
            require_once 'Modules/Course/classes/Objectives/class.ilLOTestQuestionAdapter.php';
            $objectivesAdapter = ilLOTestQuestionAdapter::getInstance($testSession);
        } else {
            $considerHiddenQuestions = true;
        }
 
        $scoredPass = $this->object->_getResultPass($testSession->getActiveId());
        
        require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionHintTracking.php';
        $questionHintRequestRegister = ilAssQuestionHintTracking::getRequestRequestStatisticDataRegisterByActiveId(
            $testSession->getActiveId()
        );
 
        foreach ($passes as $pass) {
            $row = array();
 
            $considerOptionalQuestions = true;
 
            if ($this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()) {
                $testSequence = $this->testSequenceFactory->getSequenceByActiveIdAndPass($testSession->getActiveId(), $pass);
 
                $testSequence->loadFromDb();
                $testSequence->loadQuestions();
 
                if ($this->object->isRandomTest() && !$testSequence->isAnsweringOptionalQuestionsConfirmed()) {
                    $considerOptionalQuestions = false;
                }
 
                $testSequence->setConsiderHiddenQuestionsEnabled($considerHiddenQuestions);
                $testSequence->setConsiderOptionalQuestionsEnabled($considerOptionalQuestions);
 
                $objectivesList = $this->buildQuestionRelatedObjectivesList($objectivesAdapter, $testSequence);
                $objectivesList->loadObjectivesTitles();
 
                $row['objectives'] = $objectivesList->getUniqueObjectivesStringForQuestions($testSequence->getUserSequenceQuestions());
            }
 
            if ($withResults) {
                $result_array = $this->object->getTestResult($testSession->getActiveId(), $pass, false, $considerHiddenQuestions, $considerOptionalQuestions);
                
                foreach ($result_array as $resultStructKEY => $question) {
                    if ($resultStructKEY === 'test' || $resultStructKEY === 'pass') {
                        continue;
                    }
                    
                    $requestData = $questionHintRequestRegister->getRequestByTestPassIndexAndQuestionId($pass, $question['qid']);
                    
                    if ($requestData instanceof ilAssQuestionHintRequestStatisticData && $result_array[$resultStructKEY]['requested_hints'] === null) {
                        $result_array['pass']['total_requested_hints'] += $requestData->getRequestsCount();
                        
                        $result_array[$resultStructKEY]['requested_hints'] = $requestData->getRequestsCount();
                        $result_array[$resultStructKEY]['hint_points'] = $requestData->getRequestsPoints();
                    }
                }
                
                if (!$result_array['pass']['total_max_points']) {
                    $percentage = 0;
                } else {
                    $percentage = ($result_array['pass']['total_reached_points'] / $result_array['pass']['total_max_points']) * 100;
                }
                $total_max = $result_array['pass']['total_max_points'];
                $total_reached = $result_array['pass']['total_reached_points'];
                $total_requested_hints = $result_array['pass']['total_requested_hints'];
            }
 
            if ($withResults) {
                $row['scored'] = ($pass == $scoredPass);
            }
 
            $row['pass'] = $pass;
            $row['date'] = ilObjTest::lookupLastTestPassAccess($testSession->getActiveId(), $pass);
            if ($withResults) {
                $row['num_workedthrough_questions'] = $result_array['pass']['num_workedthrough'];
                $row['num_questions_total'] = $result_array['pass']['num_questions_total'];
 
                if ($this->object->isOfferingQuestionHintsEnabled()) {
                    $row['hints'] = $total_requested_hints;
                }
 
                $row['reached_points'] = $total_reached;
                $row['max_points'] = $total_max;
                $row['percentage'] = $percentage;
            }
 
            $data[] = $row;
        }
 
        return $data;
    }

References $data, $pass, $row, buildQuestionRelatedObjectivesList(), ilTestSession\getActiveId(), ilLOTestQuestionAdapter\getInstance(), getObjectiveOrientedContainer(), ilAssQuestionHintTracking\getRequestRequestStatisticDataRegisterByActiveId(), and ilObjTest\lookupLastTestPassAccess().

Referenced by ilTestEvaluationGUI\outParticipantsResultsOverview(), ilTestEvaluationGUI\outUserListOfAnswerPasses(), and ilTestEvaluationGUI\outUserResultsOverview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionResultForTestUsers()

ilTestServiceGUI::getQuestionResultForTestUsers	(	$question_id,
		$test_id
	)

Creates a HTML representation for the results of a given question in a test.

Parameters

integer	$question_id	The original id of the question
integer	$test_id	The test id

Returns: string HTML code of the question results

Definition at line 925 of file class.ilTestServiceGUI.php.

    {
        // prepare generation before contents are processed (for mathjax)
        require_once 'Services/PDFGeneration/classes/class.ilPDFGeneration.php';
        ilPDFGeneration::prepareGeneration();
 
        // REQUIRED, since we call this object regardless of the loop
        $question_gui = $this->object->createQuestionGUI("", $question_id);
 
        $foundusers = $this->object->getParticipantsForTestAndQuestion($test_id, $question_id);
        $output     = '';
        foreach ($foundusers as $active_id => $passes) {
            $resultpass = $this->object->_getResultPass($active_id);
            for ($i = 0; $i < count($passes); $i++) {
                if (($resultpass !== null) && ($resultpass == $passes[$i]["pass"])) {
                    if ($output) {
                        $output .= "<br /><br /><br />";
                    }
 
                    // check if re-instantiation is really neccessary
                    $question_gui = $this->object->createQuestionGUI("", $passes[$i]["qid"]);
                    $output .= $this->getResultsHeadUserAndPass($active_id, $resultpass + 1);
                    $question_gui->setRenderPurpose(assQuestionGUI::RENDER_PURPOSE_PRINT_PDF);
                    $output .= $question_gui->getSolutionOutput(
                        $active_id,
                        $resultpass,
                        $graphicalOutput = false,
                        $result_output = false,
                        $show_question_only = false,
                        $show_feedback = false
                    );
                }
            }
        }
 
        require_once './Modules/Test/classes/class.ilTestPDFGenerator.php';
        ilTestPDFGenerator::generatePDF($output, ilTestPDFGenerator::PDF_OUTPUT_DOWNLOAD, $question_gui->object->getTitleFilenameCompliant(), PDF_USER_RESULT);
    }

References $i, $output, ilTestPDFGenerator\generatePDF(), getResultsHeadUserAndPass(), ilTestPDFGenerator\PDF_OUTPUT_DOWNLOAD, PDF_USER_RESULT, ilPDFGeneration\prepareGeneration(), and assQuestionGUI\RENDER_PURPOSE_PRINT_PDF.

Referenced by ilTestEvaluationGUI\exportQuestionForAllParticipants().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getResultsHeadUserAndPass()

ilTestServiceGUI::getResultsHeadUserAndPass	(	$active_id,
		$pass
	)

Returns the user and pass data for a test results output.

Parameters

integer $active_id The active ID of the user

Returns: string HTML code of the user data for the test results @access public

Definition at line 875 of file class.ilTestServiceGUI.php.

    {
        $template = new ilTemplate("tpl.il_as_tst_results_head_user_pass.html", true, true, "Modules/Test");
        include_once './Services/User/classes/class.ilObjUser.php';
        $user_id = $this->object->_getUserIdFromActiveId($active_id);
        if (strlen(ilObjUser::_lookupLogin($user_id)) > 0) {
            $user = new ilObjUser($user_id);
        } else {
            $user = new ilObjUser();
            $user->setLastname($this->lng->txt("deleted_user"));
        }
        $title_matric = "";
        if (strlen($user->getMatriculation()) && (($this->object->getAnonymity() == false))) {
            $template->setCurrentBlock("user_matric");
            $template->setVariable("TXT_USR_MATRIC", $this->lng->txt("matriculation"));
            $template->parseCurrentBlock();
            $template->setCurrentBlock("user_matric_value");
            $template->setVariable("VALUE_USR_MATRIC", $user->getMatriculation());
            $template->parseCurrentBlock();
            $template->touchBlock("user_matric_separator");
            $title_matric = " - " . $this->lng->txt("matriculation") . ": " . $user->getMatriculation();
        }
 
        $invited_user = array_pop($this->object->getInvitedUsers($user_id));
        if (strlen($invited_user["clientip"])) {
            $template->setCurrentBlock("user_clientip");
            $template->setVariable("TXT_CLIENT_IP", $this->lng->txt("client_ip"));
            $template->parseCurrentBlock();
            $template->setCurrentBlock("user_clientip_value");
            $template->setVariable("VALUE_CLIENT_IP", $invited_user["clientip"]);
            $template->parseCurrentBlock();
            $template->touchBlock("user_clientip_separator");
            $title_client = " - " . $this->lng->txt("clientip") . ": " . $invited_user["clientip"];
        }
 
        $template->setVariable("TXT_USR_NAME", $this->lng->txt("name"));
        $uname = $this->object->userLookupFullName($user_id, false);
        $template->setVariable("VALUE_USR_NAME", $uname);
        $template->setVariable("TXT_PASS", $this->lng->txt("scored_pass"));
        $template->setVariable("VALUE_PASS", $pass);
        return $template->get();
    }

References $pass, $template, and ilObjUser\_lookupLogin().

Referenced by getQuestionResultForTestUsers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getResultsOfUserOutput()

ilTestServiceGUI::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.

Parameters

ilTestSession \| ilTestSessionDynamicQuestionSet	$testSession
integer	$active_id
integer	$pass
boolean	$show_pass_details
boolean	$show_answers
boolean	$show_question_only
boolean	$show_reached_points	@access public

Definition at line 747 of file class.ilTestServiceGUI.php.

    {
        global $ilObjDataCache;
 
        include_once("./Services/UICore/classes/class.ilTemplate.php");
        $template = new ilTemplate("tpl.il_as_tst_results_participant.html", true, true, "Modules/Test");
 
        if ($this->participantData instanceof ilTestParticipantData) {
            $user_id = $this->participantData->getUserIdByActiveId($active_id);
            $uname = $this->participantData->getConcatedFullnameByActiveId($active_id, false);
        } else {
            $user_id = $this->object->_getUserIdFromActiveId($active_id);
            $uname = $this->object->userLookupFullName($user_id, true);
        }
        
        if (((array_key_exists("pass", $_GET)) && (strlen($_GET["pass"]) > 0)) || (!is_null($pass))) {
            if (is_null($pass)) {
                $pass = $_GET["pass"];
            }
        }
 
        if (!is_null($pass)) {
            require_once 'Modules/Test/classes/class.ilTestResultHeaderLabelBuilder.php';
            $testResultHeaderLabelBuilder = new ilTestResultHeaderLabelBuilder($this->lng, $ilObjDataCache);
 
            $objectivesList = null;
 
            if ($this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()) {
                $testSequence = $this->testSequenceFactory->getSequenceByActiveIdAndPass($active_id, $pass);
                $testSequence->loadFromDb();
                $testSequence->loadQuestions();
 
                require_once 'Modules/Course/classes/Objectives/class.ilLOTestQuestionAdapter.php';
                $objectivesAdapter = ilLOTestQuestionAdapter::getInstance($testSession);
 
                $objectivesList = $this->buildQuestionRelatedObjectivesList($objectivesAdapter, $testSequence);
                $objectivesList->loadObjectivesTitles();
 
                $testResultHeaderLabelBuilder->setObjectiveOrientedContainerId($testSession->getObjectiveOrientedContainerId());
                $testResultHeaderLabelBuilder->setUserId($testSession->getUserId());
                $testResultHeaderLabelBuilder->setTestObjId($this->object->getId());
                $testResultHeaderLabelBuilder->setTestRefId($this->object->getRefId());
                $testResultHeaderLabelBuilder->initObjectiveOrientedMode();
            }
 
            $result_array = $this->object->getTestResult(
                $active_id,
                $pass,
                false,
                !$this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()
            );
 
            $user_id = $this->object->_getUserIdFromActiveId($active_id);
            $showAllAnswers = true;
            if ($this->object->isExecutable($testSession, $user_id)) {
                $showAllAnswers = false;
            }
            if ($show_answers) {
                $list_of_answers = $this->getPassListOfAnswers(
                    $result_array,
                    $active_id,
                    $pass,
                    $_SESSION['tst_results_show_best_solutions'],
                    $showAllAnswers,
                    $show_question_only,
                    $show_reached_points,
                    $show_pass_details,
                    $objectivesList,
                    $testResultHeaderLabelBuilder
                );
                $template->setVariable("LIST_OF_ANSWERS", $list_of_answers);
            }
 
            if ($show_pass_details) {
                $overviewTableGUI = $this->getPassDetailsOverviewTableGUI($result_array, $active_id, $pass, $targetGUI, "getResultsOfUserOutput", '', $show_answers, $objectivesList);
                $overviewTableGUI->setTitle($testResultHeaderLabelBuilder->getPassDetailsHeaderLabel($pass + 1));
                $template->setVariable("PASS_DETAILS", $overviewTableGUI->getHTML());
            }
 
            $signature = $this->getResultsSignature();
            $template->setVariable("SIGNATURE", $signature);
            
            if ($this->object->isShowExamIdInTestResultsEnabled()) {
                $template->setCurrentBlock('exam_id_footer');
                $template->setVariable('EXAM_ID_VAL', ilObjTest::lookupExamId(
                    $testSession->getActiveId(),
                    $pass
                ));
                $template->setVariable('EXAM_ID_TXT', $this->lng->txt('exam_id'));
                $template->parseCurrentBlock();
            }
        }
 
        $template->setCurrentBlock('participant_back_anchor');
        $template->setVariable("HREF_PARTICIPANT_BACK_ANCHOR", "#tst_results_toolbar");
        $template->setVariable("TXT_PARTICIPANT_BACK_ANCHOR", $this->lng->txt('tst_back_to_top'));
        $template->parseCurrentBlock();
 
        $template->setCurrentBlock('participant_block_id');
        $template->setVariable("PARTICIPANT_BLOCK_ID", "participant_active_{$active_id}");
        $template->parseCurrentBlock();
 
        if ($this->isGradingMessageRequired()) {
            $gradingMessageBuilder = $this->getGradingMessageBuilder($active_id);
            $gradingMessageBuilder->buildList();
 
            $template->setCurrentBlock('grading_message');
            $template->setVariable('GRADING_MESSAGE', $gradingMessageBuilder->getList());
            $template->parseCurrentBlock();
        }
 
 
        $user_data = $this->getAdditionalUsrDataHtmlAndPopulateWindowTitle($testSession, $active_id, true);
        $template->setVariable("TEXT_HEADING", sprintf($this->lng->txt("tst_result_user_name"), $uname));
        $template->setVariable("USER_DATA", $user_data);
 
        $this->populatePassFinishDate($template, ilObjTest::lookupLastTestPassAccess($active_id, $pass));
 
        return $template->get();
    }

References $_GET, $_SESSION, $pass, $template, buildQuestionRelatedObjectivesList(), getAdditionalUsrDataHtmlAndPopulateWindowTitle(), getGradingMessageBuilder(), ilLOTestQuestionAdapter\getInstance(), getObjectiveOrientedContainer(), getPassDetailsOverviewTableGUI(), getPassListOfAnswers(), getResultsSignature(), isGradingMessageRequired(), ilObjTest\lookupExamId(), ilObjTest\lookupLastTestPassAccess(), populatePassFinishDate(), and sprintf.

Here is the call graph for this function:

◆ getResultsSignature()

ilTestServiceGUI::getResultsSignature ( )

Returns HTML code for a signature field.

Returns: string HTML code of the date and signature field for the test results @access public

Definition at line 597 of file class.ilTestServiceGUI.php.

    {
        if ($this->object->getShowSolutionSignature() && !$this->object->getAnonymity()) {
            $template = new ilTemplate("tpl.il_as_tst_results_userdata_signature.html", true, true, "Modules/Test");
            $template->setVariable("TXT_DATE", $this->lng->txt("date"));
            $old_value = ilDatePresentation::useRelativeDates();
            ilDatePresentation::setUseRelativeDates(false);
            $template->setVariable("VALUE_DATE", ilDatePresentation::formatDate(new ilDate(time(), IL_CAL_UNIX)));
            ilDatePresentation::setUseRelativeDates($old_value);
            $template->setVariable("TXT_SIGNATURE", $this->lng->txt("tst_signature"));
            $template->setVariable("IMG_SPACER", ilUtil::getImagePath("spacer.png"));
            return $template->get();
        } else {
            return "";
        }
    }

References $template, ilDatePresentation\formatDate(), ilUtil\getImagePath(), IL_CAL_UNIX, ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

Referenced by getResultsOfUserOutput(), ilTestEvaluationGUI\outUserListOfAnswerPasses(), ilTestEvaluationGUI\outUserPassDetails(), and ilTestPlayerAbstractGUI\showListOfAnswers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleTabs()

ilTestServiceGUI::handleTabs ( $activeTabId )

protected

Definition at line 295 of file class.ilTestServiceGUI.php.

    {
        if ($this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()) {
            require_once 'Services/Link/classes/class.ilLink.php';
            $courseLink = ilLink::_getLink($this->getObjectiveOrientedContainer()->getRefId());
            $this->tabs->setBack2Target($this->lng->txt('back_to_objective_container'), $courseLink);
            
            $this->tabs->addTab(
                'results_pass_oriented',
                $this->lng->txt('tst_tab_results_pass_oriented'),
                $this->ctrl->getLinkTargetByClass('ilTestEvaluationGUI', 'outUserResultsOverview')
            );
            
            $this->tabs->addTab(
                'results_objective_oriented',
                $this->lng->txt('tst_tab_results_objective_oriented'),
                $this->ctrl->getLinkTargetByClass('ilTestEvalObjectiveOrientedGUI', 'showVirtualPass')
            );
            
            $this->tabs->setTabActive($activeTabId);
        }
    }

References ilLink\_getLink(), and getObjectiveOrientedContainer().

Referenced by ilTestEvalObjectiveOrientedGUI\executeCommand(), ilTestEvaluationGUI\outUserPassDetails(), and ilTestEvaluationGUI\outUserResultsOverview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isContextResultPresentation()

ilTestServiceGUI::isContextResultPresentation ( )

Returns: boolean

Definition at line 89 of file class.ilTestServiceGUI.php.

    {
        return $this->contextResultPresentation;
    }

References $contextResultPresentation.

Referenced by getPassListOfAnswers().

Here is the caller graph for this function:

◆ isGradingMessageRequired()

ilTestServiceGUI::isGradingMessageRequired ( )

protected

Definition at line 975 of file class.ilTestServiceGUI.php.

    {
        if ($this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()) {
            return false;
        }
 
        if ($this->object->isShowGradingStatusEnabled()) {
            return true;
        }
 
        if ($this->object->isShowGradingMarkEnabled()) {
            return true;
        }
 
        if ($this->object->areObligationsEnabled()) {
            return true;
        }
        
        return false;
    }

References getObjectiveOrientedContainer().

Referenced by getResultsOfUserOutput(), ilTestEvaluationGUI\outParticipantsPassDetails(), ilTestEvaluationGUI\outParticipantsResultsOverview(), ilTestEvaluationGUI\outUserPassDetails(), and ilTestEvaluationGUI\outUserResultsOverview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isPdfDeliveryRequest()

ilTestServiceGUI::isPdfDeliveryRequest ( )

protected

Returns: bool

Definition at line 321 of file class.ilTestServiceGUI.php.

    {
        if (!isset($_GET['pdf'])) {
            return false;
        }
 
        if (!(bool) $_GET['pdf']) {
            return false;
        }
 
        return true;
    }

References $_GET.

Referenced by buildPassDetailsOverviewTableGUI(), ilTestEvaluationGUI\executeCommand(), getCorrectSolutionOutput(), getPassDetailsOverviewTableGUI(), getPassListOfAnswers(), ilTestEvaluationGUI\outParticipantsPassDetails(), ilTestEvaluationGUI\outParticipantsResultsOverview(), ilTestEvaluationGUI\outUserPassDetails(), ilTestEvaluationGUI\outUserResultsOverview(), populateContent(), and ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd().

Here is the caller graph for this function:

◆ outCorrectSolution()

ilTestServiceGUI::outCorrectSolution ( )

protected

Creates an output of the solution of an answer compared to the correct solution.

@access public

Reimplemented in ilTestPlayerAbstractGUI.

Definition at line 1111 of file class.ilTestServiceGUI.php.

    {
        if (!$this->object->getShowSolutionDetails()) {
            ilUtil::sendInfo($this->lng->txt("no_permission"), true);
            $this->ctrl->redirectByClass("ilobjtestgui", "infoScreen");
        }
 
        $testSession = $this->testSessionFactory->getSession();
        $activeId = $testSession->getActiveId();
 
        if (!($activeId > 0)) {
            $this->ctrl->redirectByClass("ilobjtestgui", "infoScreen");
        }
 
        $this->ctrl->saveParameter($this, "pass");
        $pass = (int) $_GET['pass'];
 
        $questionId = (int) $_GET['evaluation'];
        
        $testSequence = $this->testSequenceFactory->getSequenceByActiveIdAndPass($activeId, $pass);
        $testSequence->loadFromDb();
        $testSequence->loadQuestions();
        
        if (!$testSequence->questionExists($questionId)) {
            ilObjTestGUI::accessViolationRedirect();
        }
 
        if ($this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()) {
            $testSequence = $this->testSequenceFactory->getSequenceByActiveIdAndPass($activeId, $pass);
            $testSequence->loadFromDb();
            $testSequence->loadQuestions();
 
            require_once 'Modules/Course/classes/Objectives/class.ilLOTestQuestionAdapter.php';
            $objectivesAdapter = ilLOTestQuestionAdapter::getInstance($testSession);
            $objectivesList = $this->buildQuestionRelatedObjectivesList($objectivesAdapter, $testSequence);
            $objectivesList->loadObjectivesTitles();
        } else {
            $objectivesList = null;
        }
 
        global $ilTabs;
 
        if ($this instanceof ilTestEvalObjectiveOrientedGUI) {
            $ilTabs->setBackTarget(
                $this->lng->txt("tst_back_to_virtual_pass"),
                $this->ctrl->getLinkTarget($this, 'showVirtualPass')
            );
        } else {
            $ilTabs->setBackTarget(
                $this->lng->txt("tst_back_to_pass_details"),
                $this->ctrl->getLinkTarget($this, 'outUserPassDetails')
            );
        }
 
        include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
        $this->tpl->setCurrentBlock("ContentStyle");
        $this->tpl->setVariable("LOCATION_CONTENT_STYLESHEET", ilObjStyleSheet::getContentStylePath(0));
        $this->tpl->parseCurrentBlock();
 
        $this->tpl->setCurrentBlock("SyntaxStyle");
        $this->tpl->setVariable("LOCATION_SYNTAX_STYLESHEET", ilObjStyleSheet::getSyntaxStylePath());
        $this->tpl->parseCurrentBlock();
 
        $this->tpl->addCss(ilUtil::getStyleSheetLocation("output", "test_print.css", "Modules/Test"), "print");
        if ($this->object->getShowSolutionAnswersOnly()) {
            $this->tpl->addCss(ilUtil::getStyleSheetLocation("output", "test_print_hide_content.css", "Modules/Test"), "print");
        }
 
        $solution = $this->getCorrectSolutionOutput($questionId, $activeId, $pass, $objectivesList);
 
        $this->tpl->setContent($solution);
    }

References $_GET, $pass, ilObjTestGUI\accessViolationRedirect(), buildQuestionRelatedObjectivesList(), ilObjStyleSheet\getContentStylePath(), getCorrectSolutionOutput(), ilLOTestQuestionAdapter\getInstance(), getObjectiveOrientedContainer(), ilUtil\getStyleSheetLocation(), ilObjStyleSheet\getSyntaxStylePath(), and ilUtil\sendInfo().

Referenced by outCorrectSolutionCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ outCorrectSolutionCmd()

ilTestServiceGUI::outCorrectSolutionCmd ( )

protected

Definition at line 1101 of file class.ilTestServiceGUI.php.

    {
        $this->outCorrectSolution(); // cannot be named xxxCmd, because it's also called from context without Cmd in names
    }

References outCorrectSolution().

Here is the call graph for this function:

◆ populateContent()

ilTestServiceGUI::populateContent ( $content )

protected

Parameters

string $content

Definition at line 1072 of file class.ilTestServiceGUI.php.

    {
        if ($this->isPdfDeliveryRequest()) {
            require_once 'Modules/Test/classes/class.ilTestPDFGenerator.php';
 
            ilTestPDFGenerator::generatePDF(
                $content,
                ilTestPDFGenerator::PDF_OUTPUT_DOWNLOAD,
                $this->object->getTitleFilenameCompliant(),
                PDF_USER_RESULT
            );
        } else {
            $this->tpl->setContent($content);
        }
    }

References ilTestPDFGenerator\generatePDF(), isPdfDeliveryRequest(), ilTestPDFGenerator\PDF_OUTPUT_DOWNLOAD, and PDF_USER_RESULT.

Referenced by ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populatePassFinishDate()

ilTestServiceGUI::populatePassFinishDate	(	$tpl,
		$passFinishDate
	)

Parameters

ilTemplate	$tpl
int	$passFinishDate

Definition at line 1188 of file class.ilTestServiceGUI.php.

    {
        $oldValue = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);
        $passFinishDate = ilDatePresentation::formatDate(new ilDateTime($passFinishDate, IL_CAL_UNIX));
        ilDatePresentation::setUseRelativeDates($oldValue);
        $tpl->setVariable("PASS_FINISH_DATE_LABEL", $this->lng->txt('tst_pass_finished_on'));
        $tpl->setVariable("PASS_FINISH_DATE_VALUE", $passFinishDate);
    }

References $tpl, ilDatePresentation\formatDate(), IL_CAL_UNIX, ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

Referenced by getResultsOfUserOutput(), ilTestEvaluationGUI\outParticipantsPassDetails(), and ilTestEvaluationGUI\outUserPassDetails().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setContextResultPresentation()

ilTestServiceGUI::setContextResultPresentation ( $contextResultPresentation )

Parameters

boolean $contextResultPresentation

Definition at line 97 of file class.ilTestServiceGUI.php.

    {
        $this->contextResultPresentation = $contextResultPresentation;
    }

References $contextResultPresentation.

Referenced by ilTestEvaluationGUI\outUserListOfAnswerPasses().

Here is the caller graph for this function:

◆ setObjectiveOrientedContainer()

ilTestServiceGUI::setObjectiveOrientedContainer ( ilTestObjectiveOrientedContainer $objectiveOrientedContainer )

Parameters

ilTestObjectiveOrientedContainer $objectiveOrientedContainer

Definition at line 255 of file class.ilTestServiceGUI.php.

    {
        $this->objectiveOrientedContainer = $objectiveOrientedContainer;
    }

References $objectiveOrientedContainer.

◆ setParticipantData()

ilTestServiceGUI::setParticipantData ( $participantData )

Parameters

\ilTestParticipantData $participantData

Definition at line 137 of file class.ilTestServiceGUI.php.

    {
        $this->participantData = $participantData;
    }

References $participantData.

Field Documentation

◆ $contextResultPresentation

ilTestServiceGUI::$contextResultPresentation = true

private

Definition at line 84 of file class.ilTestServiceGUI.php.

Referenced by isContextResultPresentation(), and setContextResultPresentation().

◆ $ctrl

ilTestServiceGUI::$ctrl

Definition at line 44 of file class.ilTestServiceGUI.php.

◆ $db

ilTestServiceGUI::$db

protected

Definition at line 36 of file class.ilTestServiceGUI.php.

◆ $ilias

ilTestServiceGUI::$ilias

Definition at line 56 of file class.ilTestServiceGUI.php.

Referenced by __construct(), and ilTestPlayerAbstractGUI\archiveParticipantSubmission().

◆ $lng

ilTestServiceGUI::$lng

Definition at line 38 of file class.ilTestServiceGUI.php.

Referenced by ilTestPlayerAbstractGUI\__construct(), __construct(), ilTestScoringGUI\buildManScoringParticipantForm(), ilTestOutputGUI\executeCommand(), ilTestPlayerDynamicQuestionSetGUI\executeCommand(), ilTestScoringGUI\saveManScoringParticipantScreen(), and ilTestScoringGUI\showManScoringParticipantScreen().

◆ $objCache

ilTestServiceGUI::$objCache

protected

Definition at line 54 of file class.ilTestServiceGUI.php.

◆ $object

ilTestServiceGUI::$object = null

Definition at line 26 of file class.ilTestServiceGUI.php.

◆ $objectiveOrientedContainer

ilTestServiceGUI::$objectiveOrientedContainer

private

Definition at line 82 of file class.ilTestServiceGUI.php.

Referenced by getObjectiveOrientedContainer(), and setObjectiveOrientedContainer().

◆ $participantData

ilTestServiceGUI::$participantData

protected

Definition at line 77 of file class.ilTestServiceGUI.php.

Referenced by getParticipantData(), ilTestScoringGUI\saveNextManScoringParticipantScreen(), and setParticipantData().

◆ $ref_id

ilTestServiceGUI::$ref_id

Definition at line 58 of file class.ilTestServiceGUI.php.

◆ $service

ilTestServiceGUI::$service = null

Definition at line 31 of file class.ilTestServiceGUI.php.

◆ $tabs

ilTestServiceGUI::$tabs

protected

Definition at line 49 of file class.ilTestServiceGUI.php.

◆ $testSequenceFactory

ilTestServiceGUI::$testSequenceFactory = null

protected

Definition at line 72 of file class.ilTestServiceGUI.php.

Referenced by ilTestOutputGUI\executeCommand(), and ilTestPlayerDynamicQuestionSetGUI\executeCommand().

◆ $testSessionFactory

ilTestServiceGUI::$testSessionFactory = null

protected

Definition at line 65 of file class.ilTestServiceGUI.php.

Referenced by ilTestOutputGUI\executeCommand(), and ilTestPlayerDynamicQuestionSetGUI\executeCommand().

◆ $tpl

ilTestServiceGUI::$tpl

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

Referenced by __construct(), ilTestEvaluationGUI\confirmDeletePass(), ilTestPlayerAbstractGUI\getQuestionGuiInstance(), ilTestPlayerDynamicQuestionSetGUI\outCurrentlyFinishedPage(), ilTestEvaluationGUI\outUserPassDetails(), ilTestPlayerAbstractGUI\populateDiscardSolutionModal(), ilTestPlayerAbstractGUI\populateInstantResponseModal(), ilTestPlayerAbstractGUI\populateNavWhenChangedModal(), populatePassFinishDate(), ilTestScoringGUI\saveManScoringParticipantScreen(), ilTestScoringGUI\showManScoringParticipantScreen(), ilTestScoringGUI\showManScoringParticipantsTable(), and ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd().

◆ $tree

ilTestServiceGUI::$tree

Definition at line 57 of file class.ilTestServiceGUI.php.

Referenced by __construct(), ilTestPlayerDynamicQuestionSetGUI\executeCommand(), and ilTestOutputGUI\generateRandomTestPassForActiveUser().

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

Modules/Test/classes/class.ilTestServiceGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildPassDetailsOverviewTableGUI()

◆ buildPassOverviewTableGUI()

◆ buildQuestionRelatedObjectivesList()

◆ buildUserTestResultsToolbarGUI()

◆ executeCommand()

◆ getAdditionalUsrDataHtmlAndPopulateWindowTitle()

◆ getCommand()

◆ getCorrectSolutionOutput()

◆ getFilteredTestResult()

◆ getGradingMessageBuilder()

◆ getObjectiveOrientedContainer()

◆ getParticipantData()

◆ getPassDetailsOverviewTableGUI()

◆ getPassListOfAnswers()

◆ getPassListOfAnswersWithScoring()

◆ getPassOverviewTableData()

◆ getQuestionResultForTestUsers()

◆ getResultsHeadUserAndPass()

◆ getResultsOfUserOutput()

◆ getResultsSignature()

◆ handleTabs()

◆ isContextResultPresentation()

◆ isGradingMessageRequired()

◆ isPdfDeliveryRequest()

◆ outCorrectSolution()

◆ outCorrectSolutionCmd()

◆ populateContent()

◆ populatePassFinishDate()

◆ setContextResultPresentation()

◆ setObjectiveOrientedContainer()

◆ setParticipantData()

Field Documentation

◆ $contextResultPresentation

◆ $ctrl

◆ $db

◆ $ilias

◆ $lng

◆ $objCache

◆ $object

◆ $objectiveOrientedContainer

◆ $participantData

◆ $ref_id

◆ $service

◆ $tabs

◆ $testSequenceFactory

◆ $testSessionFactory

◆ $tpl

◆ $tree