ilTestServiceGUI Class Reference

Service GUI class for tests. More...

Inheritance diagram for ilTestServiceGUI:

Collaboration diagram for ilTestServiceGUI:

Public Member Functions
	isContextResultPresentation ()
	setContextResultPresentation (bool $contextResultPresentation)
	setParticipantData (ilTestParticipantData $participantData)
	getParticipantData ()
	getPassOverviewTableData (ilTestSession $test_session, array $passes, bool $with_results)
	setObjectiveOrientedContainer (ilTestObjectiveOrientedContainer $objective_oriented_container)
	getObjectiveOrientedContainer ()
	executeCommand ()
	execute command More...
	buildPassOverviewTableGUI (ilTestEvaluationGUI $target_gui)
	getPassListOfAnswers (&$result_array, $active_id, $pass, $show_solutions=false, $only_answered_questions=false, $show_question_only=false, $show_reached_points=false, $anchorNav=false, ?ilTestQuestionRelatedObjectivesList $objectives_list=null, ?ResultsTitlesBuilder $testResultHeaderLabelBuilder=null)
	Returns the list of answers of a users test pass. 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 $objectives_list=null)
	Returns an output of the solution to an answer compared to the correct solution. More...
	getObject ()

Protected Member Functions
	getPassDetailsOverviewTableGUI (array $result_array, int $active_id, int $pass, ilTestServiceGUI $target_gui, string $target_cmd, ?ilTestQuestionRelatedObjectivesList $objectives_list=null, bool $multiple_objectives_involved=true)
	buildPassDetailsOverviewTableGUI (ilTestServiceGUI $target_gui, string $target_cmd)
	isGradingMessageRequired ()
	getGradingMessageBuilder (int $active_id)
	buildQuestionRelatedObjectivesList (ilLOTestQuestionAdapter $objectives_adapter, ilTestQuestionSequence $test_sequence)
	populateContent (string $content)
	outCorrectSolutionCmd ()
	outCorrectSolution ()
	populatePassFinishDate (ilTemplate $tpl, ?int $pass_finish_date)
	populateExamId (ilTemplate $tpl, int $active_id, int $pass)

Protected Attributes
readonly RequestDataCollector	$testrequest
readonly GeneralQuestionPropertiesRepository	$questionrepository
readonly TestQuestionsRepository	$testquestionsrepository
ilTestService	$service = null
readonly ilDBInterface	$db
readonly ilLanguage	$lng
readonly TestLogger	$logger
readonly ilHelpGUI	$help
readonly ilRbacSystem	$rbac_system
ilGlobalTemplateInterface ilTemplate	$tpl
	sk 2023-08-01: We need this union type, even if it is wrong! To change this More...
readonly ContentStyle	$content_style
readonly ilErrorHandling	$error
ilAccess	$access
readonly HTTPServices	$http
readonly ilCtrlInterface	$ctrl
readonly ilToolbarGUI	$toolbar
readonly ilTabsGUI	$tabs
readonly ilObjectDataCache	$obj_cache
readonly ilComponentRepository	$component_repository
readonly ilObjUser	$user
readonly ArrayBasedRequestWrapper	$post_wrapper
readonly ilNavigationHistory	$navigation_history
readonly Refinery	$refinery
readonly UIFactory	$ui_factory
readonly UIRenderer	$ui_renderer
readonly SkillService	$skills_service
readonly ilTestShuffler	$shuffler
readonly ResultsDataFactory	$results_data_factory
readonly ResultsPresentationFactory	$results_presentation_factory
readonly ILIAS	$ilias
readonly ilSetting	$settings
readonly GlobalScreenServices	$global_screen
readonly ilTree	$tree
int	$ref_id
ilTestSessionFactory	$test_session_factory = null
ilTestSequenceFactory	$test_sequence_factory = null
ilTestParticipantData	$participantData = null
TestResultRepository	$test_pass_result_repository
ilTestParticipantAccessFilterFactory	$participant_access_filter

Private Attributes
ilTestObjectiveOrientedContainer	$objective_oriented_container
bool	$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.

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

Member Function Documentation

buildPassDetailsOverviewTableGUI()

ilTestServiceGUI::buildPassDetailsOverviewTableGUI ( ilTestServiceGUI  $target_gui, string  $target_cmd  )

protected

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

References ILIAS\Repository\ctrl().

Referenced by getPassDetailsOverviewTableGUI(), ilTestEvalObjectiveOrientedGUI\showVirtualPassResetTableFilterCmd(), and ilTestEvalObjectiveOrientedGUI\showVirtualPassSetTableFilterCmd().

     : ilTestPassDetailsOverviewTableGUI {
        return new ilTestPassDetailsOverviewTableGUI($this->ctrl, $target_gui, $target_cmd);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildPassOverviewTableGUI()

ilTestServiceGUI::buildPassOverviewTableGUI

(

ilTestEvaluationGUI

$target_gui

)

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

References getObjectiveOrientedContainer().

Referenced by ilTestEvaluationGUI\outUserResultsOverview().

                                                                              : ilTestPassOverviewTableGUI
    {
        $table = new ilTestPassOverviewTableGUI($target_gui, '');

        $table->setPdfPresentationEnabled(
            $this->testrequest->isset('pdf') && $this->testrequest->raw('pdf') == 1
        );

        $table->setObjectiveOrientedPresentationEnabled(
            $this->getObjectiveOrientedContainer()?->isObjectiveOrientedPresentationRequired() ?? false
        );

        return $table;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildQuestionRelatedObjectivesList()

ilTestServiceGUI::buildQuestionRelatedObjectivesList ( ilLOTestQuestionAdapter  $objectives_adapter, ilTestQuestionSequence  $test_sequence  )

protected

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

References ilLOTestQuestionAdapter\buildQuestionRelatedObjectiveList().

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

     : ilTestQuestionRelatedObjectivesList {
        $questionRelatedObjectivesList = new ilTestQuestionRelatedObjectivesList();

        $objectives_adapter->buildQuestionRelatedObjectiveList($test_sequence, $questionRelatedObjectivesList);

        return $questionRelatedObjectivesList;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilTestServiceGUI::executeCommand

(

)

execute command

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

References ILIAS\Repository\ctrl().

    {
        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass($this);

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

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
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 public

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

References $user_id, ilObjUser\_lookupLogin(), getObjectiveOrientedContainer(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

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

                                                                                                                          : string
    {
        if (!is_object($testSession)) {
            throw new InvalidArgumentException('Not an object, expected ilTestSession');
        }
        $template = new ilTemplate("tpl.il_as_tst_results_userdata.html", true, true, "components/ILIAS/Test");
        $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));
        $title_client = '';
        $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();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCorrectSolutionOutput()

ilTestServiceGUI::getCorrectSolutionOutput	(		$question_id,
			$active_id,
			$pass,
		?ilTestQuestionRelatedObjectivesList	$objectives_list = 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 public

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

References $objectives, $user, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), null, and ILIAS\Repository\object().

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

                                                                                                                                           : string
    {
        $ilUser = $this->user;

        $test_id = $this->object->getTestId();
        $question_gui = $this->object->createQuestionGUI("", $question_id);

        $template = new ilTemplate("tpl.il_as_tst_correct_solution_output.html", true, true, "components/ILIAS/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() && $this->testrequest->raw('cmd') != 'outCorrectSolution') {
            $specificAnswerFeedback = $question_gui->getSpecificFeedbackOutput(
                $question_gui->getObject()->fetchIndexedValuesFromValuePairs(
                    $question_gui->getObject()->getSolutionValues($active_id, $pass)
                )
            );
            if (strlen($specificAnswerFeedback)) {
                $template->setCurrentBlock("outline_specific_feedback");
                $template->setVariable("OUTLINE_SPECIFIC_FEEDBACK", $specificAnswerFeedback);
                $template->parseCurrentBlock();
            }
        }
        $template->setVariable("TEXT_YOUR_SOLUTION", $this->lng->txt("tst_your_answer_was"));
        $template->setVariable("TEXT_SOLUTION_OUTPUT", $this->lng->txt("tst_your_answer_was")); // Mantis 28646. I don't really know why Ingmar renamed the placeholder, so
        // I set both old and new since the old one is set as well in several places.
        $maxpoints = $question_gui->getObject()->getMaximumPoints();
        if ($maxpoints == 1) {
            $template->setVariable("QUESTION_TITLE", $this->object->getQuestionTitle($question_gui->getObject()->getTitleForHTMLOutput()) . " (" . $maxpoints . " " . $this->lng->txt("point") . ")");
        } else {
            $template->setVariable("QUESTION_TITLE", $this->object->getQuestionTitle($question_gui->getObject()->getTitleForHTMLOutput()) . " (" . $maxpoints . " " . $this->lng->txt("points") . ")");
        }
        if ($objectives_list !== null) {
            $objectives = $this->lng->txt('tst_res_lo_objectives_header') . ': ';
            $objectives .= $objectives_list->getQuestionRelatedObjectiveTitles($question_gui->getObject()->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->getObject()->getReachedPoints($active_id, $pass), $maxpoints));
        $template->setVariable("FORMACTION", $this->ctrl->getFormAction($this));
        $template->setVariable("BACKLINK_TEXT", "<< " . $this->lng->txt("back"));
        return $template->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getGradingMessageBuilder()

ilTestServiceGUI::getGradingMessageBuilder ( int  $active_id )

protected

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

References ILIAS\Repository\lng().

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

                                                               : ilTestGradingMessageBuilder
    {
        $gradingMessageBuilder = new ilTestGradingMessageBuilder($this->lng, $this->tpl, $this->object);

        $gradingMessageBuilder->setActiveId($active_id);

        return $gradingMessageBuilder;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObject()

ilTestServiceGUI::getObject

(

)

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

Referenced by ilTestPassOverviewTableGUI\__construct(), ilTestPlayerAbstractGUI\discardSolutionCmd(), ilTestPlayerAbstractGUI\finishTestCmd(), ilTestPlayerAbstractGUI\nextQuestionCmd(), ilTestPlayerAbstractGUI\outQuestionSummaryCmd(), ilTestPlayerAbstractGUI\save(), ILIAS\Test\Scoring\Manual\TestScoringByQuestionGUI\saveManScoringByQuestion(), ILIAS\Test\Scoring\Manual\TestScoringByParticipantGUI\saveManScoringParticipantScreen(), ilTestPlayerAbstractGUI\showQuestionCmd(), ilTestPlayerAbstractGUI\skipQuestionCmd(), and ilTestPlayerAbstractGUI\startTestCmd().

                               : ilObjTest
    {
        return $this->object;
    }

Here is the caller graph for this function:

getObjectiveOrientedContainer()

ilTestServiceGUI::getObjectiveOrientedContainer

(

)

Returns

ilTestObjectiveOrientedContainer

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

References $objective_oriented_container.

Referenced by buildPassOverviewTableGUI(), ilTestSubmissionReviewGUI\buildUserReviewOutput(), ilTestPlayerAbstractGUI\executeCommand(), getAdditionalUsrDataHtmlAndPopulateWindowTitle(), getPassOverviewTableData(), isGradingMessageRequired(), outCorrectSolution(), ilTestEvaluationGUI\outUserListOfAnswerPasses(), ilTestEvaluationGUI\outUserPassDetails(), ilTestEvaluationGUI\outUserResultsOverview(), ilTestPlayerAbstractGUI\redirectBackCmd(), ilTestPlayerAbstractGUI\showListOfAnswers(), ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd(), and ilTestPlayerAbstractGUI\startTestCmd().

                                                   : ?ilTestObjectiveOrientedContainer
    {
        return $this->objective_oriented_container;
    }

Here is the caller graph for this function:

getParticipantData()

ilTestServiceGUI::getParticipantData

(

)

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

References $participantData.

                                        : ilTestParticipantData
    {
        return $this->participantData;
    }

getPassDetailsOverviewTableGUI()

ilTestServiceGUI::getPassDetailsOverviewTableGUI ( array  $result_array, int  $active_id, int  $pass, ilTestServiceGUI  $target_gui, string  $target_cmd, ?ilTestQuestionRelatedObjectivesList  $objectives_list = null, bool  $multiple_objectives_involved = true  )

protected

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

References buildPassDetailsOverviewTableGUI(), ILIAS\Repository\ctrl(), null, and ILIAS\Repository\object().

Referenced by ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd().

     : ilTestPassDetailsOverviewTableGUI {
        $this->ctrl->setParameter($target_gui, 'active_id', $active_id);
        $this->ctrl->setParameter($target_gui, 'pass', $pass);

        $table_gui = $this->buildPassDetailsOverviewTableGUI($target_gui, $target_cmd);
        $table_gui->setShowHintCount($this->object->isOfferingQuestionHintsEnabled());

        if ($objectives_list !== null) {
            $table_gui->setQuestionRelatedObjectivesList($objectives_list);
            $table_gui->setObjectiveOrientedPresentationEnabled(true);
        }

        $table_gui->setMultipleObjectivesInvolved($multiple_objectives_involved);

        $table_gui->setActiveId($active_id);
        $table_gui->setShowSuggestedSolution(false);

        $users_question_solutions = [];

        foreach ($result_array as $key => $val) {
            if ($key === 'test' || $key === 'pass') {
                continue;
            }

            if ($this->object->getShowSolutionSuggested() && strlen($val['solution'])) {
                $table_gui->setShowSuggestedSolution(true);
            }

            if (isset($val['pass'])) {
                $table_gui->setPassColumnEnabled(true);
            }

            $users_question_solutions[$key] = $val;
        }

        $table_gui->initColumns();

        $table_gui->setFilterCommand($target_cmd . 'SetTableFilter');
        $table_gui->setResetCommand($target_cmd . 'ResetTableFilter');

        $table_gui->setData($users_question_solutions);

        return $table_gui;
    }

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	$objectives_list = null,
		?ResultsTitlesBuilder	$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 public

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

References $objectives, isContextResultPresentation(), ILIAS\Repository\lng(), null, and ILIAS\Repository\object().

Referenced by ilTestEvaluationGUI\outUserListOfAnswerPasses().

     : string {
        $maintemplate = new ilTemplate('tpl.il_as_tst_list_of_answers.html', true, true, 'components/ILIAS/Test');

        $counter = 1;
        // output of questions with solutions
        foreach ($result_array as $question_data) {
            if (!array_key_exists('workedthrough', $question_data)) {
                $question_data['workedthrough'] = 0;
            }
            if (!array_key_exists('qid', $question_data)) {
                $question_data['qid'] = -1;
            }

            if (($question_data['workedthrough'] == 1) || ($only_answered_questions == false)) {
                $template = new ilTemplate('tpl.il_as_qpl_question_printview.html', true, true, 'components/ILIAS/TestQuestionPool');
                $question_id = $question_data["qid"] ?? null;
                if ($question_id !== null
                    && $question_id !== -1
                    && is_numeric($question_id)) {
                    $maintemplate->setCurrentBlock('printview_question');
                    $question_gui = $this->object->createQuestionGUI("", $question_id);

                    $question_gui->getObject()->setShuffler($this->shuffler->getAnswerShuffleFor(
                        (int) $question_id,
                        (int) $active_id,
                        (int) $pass
                    ));
                    if (is_object($question_gui)) {
                        if ($anchorNav) {
                            $template->setCurrentBlock('block_id');
                            $template->setVariable('BLOCK_ID', "detailed_answer_block_act_{$active_id}_qst_{$question_id}");
                            $template->parseCurrentBlock();

                            $template->setCurrentBlock('back_anchor');
                            $template->setVariable('HREF_BACK_ANCHOR', "#pass_details_tbl_row_act_{$active_id}_qst_{$question_id}");
                            $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->getObject()->getReachedPoints($active_id, $pass) . " " . $this->lng->txt("of") . " " . $question_gui->getObject()->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->getObject()->getId());
                        $template->setVariable("QUESTION_TITLE", $this->object->getQuestionTitle($question_gui->getObject()->getTitleForHTMLOutput()));

                        if ($objectives_list !== null) {
                            $objectives = $this->lng->txt('tst_res_lo_objectives_header') . ': ';
                            $objectives .= $objectives_list->getQuestionRelatedObjectiveTitles($question_gui->getObject()->getId());
                            $template->setVariable("OBJECTIVES", $objectives);
                        }

                        $show_question_only = ($this->object->getShowSolutionAnswersOnly()) ? true : false;

                        $show_feedback = $this->isContextResultPresentation() && $this->object->getShowSolutionFeedback();
                        $show_best_solution = $this->isContextResultPresentation() && $show_solutions;
                        $show_graphical_output = $this->isContextResultPresentation();

                        if ($show_best_solution) {
                            $compare_template = new ilTemplate('tpl.il_as_tst_answers_compare.html', true, true, 'components/ILIAS/Test');
                            $test_session = $this->test_session_factory->getSession($active_id);
                            if ($pass <= $test_session->getLastFinishedPass()) {
                                $compare_template->setVariable("HEADER_PARTICIPANT", $this->lng->txt('tst_header_participant'));
                            } else {
                                $compare_template->setVariable("HEADER_PARTICIPANT", $this->lng->txt('tst_header_participant_no_answer'));
                            }

                            $compare_template->setVariable("HEADER_SOLUTION", $this->lng->txt('tst_header_solution'));
                            $result_output = $question_gui->getSolutionOutput($active_id, $pass, $show_graphical_output, false, $show_question_only, $show_feedback);
                            $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_graphical_output, false, $show_question_only, $show_feedback);
                            $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();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPassOverviewTableData()

ilTestServiceGUI::getPassOverviewTableData	(	ilTestSession	$test_session,
		array	$passes,
		bool	$with_results
	)

Parameters

array<int>

$passes An integer array of test runs

Returns

array<mixed>

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

References $data, ilObjTest\_getResultPass(), buildQuestionRelatedObjectivesList(), ilTestSession\getActiveId(), ilLOTestQuestionAdapter\getInstance(), getObjectiveOrientedContainer(), ilAssQuestionHintTracking\getRequestRequestStatisticDataRegisterByActiveId(), null, and ILIAS\Repository\object().

Referenced by ilTestEvaluationGUI\outUserResultsOverview().

     : array {
        $data = [];

        $objective_oriented_presentation = $this->getObjectiveOrientedContainer()
            ?->isObjectiveOrientedPresentationRequired() ?? false;

        if ($objective_oriented_presentation) {
            $consider_hidden_questions = false;

            $objectives_adapter = ilLOTestQuestionAdapter::getInstance($test_session);
        } else {
            $consider_hidden_questions = true;
        }

        $scored_pass = \ilObjTest::_getResultPass($test_session->getActiveId());

        $question_hint_request_register = ilAssQuestionHintTracking::getRequestRequestStatisticDataRegisterByActiveId(
            $test_session->getActiveId()
        );

        foreach ($passes as $pass) {
            $row = [
                'scored' => false,
                'pass' => $pass,
                'date' => ilObjTest::lookupLastTestPassAccess($test_session->getActiveId(), $pass)
            ];
            $considerOptionalQuestions = true;

            if ($objective_oriented_presentation) {
                $test_sequence = $this->test_sequence_factory->getSequenceByActiveIdAndPass($test_session->getActiveId(), $pass);
                $test_sequence->loadFromDb();
                $test_sequence->loadQuestions();

                if ($this->object->isRandomTest() && !$test_sequence->isAnsweringOptionalQuestionsConfirmed()) {
                    $considerOptionalQuestions = false;
                }

                $test_sequence->setConsiderHiddenQuestionsEnabled($consider_hidden_questions);
                $test_sequence->setConsiderOptionalQuestionsEnabled($considerOptionalQuestions);

                $objectives_list = $this->buildQuestionRelatedObjectivesList($objectives_adapter, $test_sequence);
                $objectives_list->loadObjectivesTitles();

                $row['objectives'] = $objectives_list->getUniqueObjectivesStringForQuestions($test_sequence->getUserSequenceQuestions());
            }

            if (!$with_results) {
                $data[] = $row;
                continue;
            }

            $result_array = $this->object->getTestResult(
                $test_session->getActiveId(),
                $pass,
                false,
                $consider_hidden_questions,
                $considerOptionalQuestions
            );

            foreach ($result_array as $result_struct_key => $question) {
                if ($result_struct_key === 'test'
                    || $result_struct_key === 'pass'
                    || $result_array[$result_struct_key]['requested_hints'] !== null) {
                    continue;
                }

                $request_data = $question_hint_request_register->getRequestByTestPassIndexAndQuestionId($pass, $question['qid']);

                if ($request_data === null) {
                    continue;
                }

                $result_array['pass']['total_requested_hints'] += $request_data->getRequestsCount();
                $result_array[$result_struct_key]['requested_hints'] = $request_data->getRequestsCount();
                $result_array[$result_struct_key]['hint_points'] = $request_data->getRequestsPoints();
            }

            if (!$result_array['pass']['total_max_points']) {
                $row['percentage'] = 0;
            } else {
                $row['percentage'] = ($result_array['pass']['total_reached_points'] / $result_array['pass']['total_max_points']) * 100;
            }

            $row['max_points'] = $result_array['pass']['total_max_points'];
            $row['reached_points'] = $result_array['pass']['total_reached_points'];
            $row['scored'] = ($pass == $scored_pass);
            $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'] = $result_array['pass']['total_requested_hints'];
            }

            $data[] = $row;
        }

        return $data;
    }

Here is the call graph for this function:

Here is the caller 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 public

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

References ilDatePresentation\formatDate(), ilUtil\getImagePath(), IL_CAL_UNIX, ILIAS\Repository\lng(), ILIAS\Repository\object(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

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

                                         : string
    {
        if ($this->object->getShowSolutionSignature() && !$this->object->getAnonymity()) {
            $template = new ilTemplate("tpl.il_as_tst_results_userdata_signature.html", true, true, "components/ILIAS/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("media/spacer.png"));
            return $template->get();
        } else {
            return "";
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isContextResultPresentation()

ilTestServiceGUI::isContextResultPresentation

(

)

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

References $contextResultPresentation.

Referenced by getPassListOfAnswers().

                                                 : bool
    {
        return $this->contextResultPresentation;
    }

Here is the caller graph for this function:

isGradingMessageRequired()

ilTestServiceGUI::isGradingMessageRequired ( )

protected

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

References getObjectiveOrientedContainer(), ILIAS\Repository\object(), and ilObjTest\SCORE_LAST_PASS.

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

                                                 : bool
    {
        $session = $this->test_session_factory->getSession();
        if ($this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()
            || $this->object->getScoreSettings()->getScoringSettings()->getPassScoring() === ilObjTest::SCORE_LAST_PASS
                && $session->getLastFinishedPass() < $session->getLastStartedPass()) {
            return false;
        }

        if ($this->object->isShowGradingStatusEnabled()
            || $this->object->isShowGradingMarkEnabled()) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

outCorrectSolution()

ilTestServiceGUI::outCorrectSolution ( )

protected

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

References $tabs, buildQuestionRelatedObjectivesList(), ILIAS\Repository\ctrl(), ilObjStyleSheet\getContentStylePath(), getCorrectSolutionOutput(), ilLOTestQuestionAdapter\getInstance(), getObjectiveOrientedContainer(), ilUtil\getStyleSheetLocation(), ilObjStyleSheet\getSyntaxStylePath(), ILIAS\Repository\int(), ILIAS\Repository\lng(), null, ILIAS\Repository\object(), and ilTabsGUI\setBackTarget().

Referenced by outCorrectSolutionCmd().

                                           : void
    {
        if (!$this->object->getShowSolutionDetails()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_permission"), true);
            $this->ctrl->redirectByClass([ilRepositoryGUI::class, ilObjTestGUI::class, ilInfoScreenGUI::class]);
        }

        $testSession = $this->test_session_factory->getSession();
        $active_id = $testSession->getActiveId();

        if (!($active_id > 0)) {
            $this->ctrl->redirectByClass([ilRepositoryGUI::class, ilObjTestGUI::class, ilInfoScreenGUI::class]);
        }

        $this->ctrl->saveParameter($this, "pass");
        $pass = (int) $this->testrequest->raw("pass");

        $active_id = (int) $this->testrequest->raw('evaluation');

        $test_sequence = $this->test_sequence_factory->getSequenceByActiveIdAndPass($active_id, $pass);
        $test_sequence->loadFromDb();
        $test_sequence->loadQuestions();

        if (!$test_sequence->questionExists($active_id)) {
            ilObjTestGUI::accessViolationRedirect();
        }

        if ($this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()) {
            $test_sequence = $this->test_sequence_factory->getSequenceByActiveIdAndPass($active_id, $pass);
            $test_sequence->loadFromDb();
            $test_sequence->loadQuestions();

            $objectives_adapter = ilLOTestQuestionAdapter::getInstance($testSession);
            $objectives_list = $this->buildQuestionRelatedObjectivesList($objectives_adapter, $test_sequence);
            $objectives_list->loadObjectivesTitles();
        } else {
            $objectives_list = null;
        }

        $ilTabs = $this->tabs;

        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')
            );
        }
        $ilTabs->clearSubTabs();

        $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"), "print");
        if ($this->object->getShowSolutionAnswersOnly()) {
            $this->tpl->addCss(ilUtil::getStyleSheetLocation("output", "test_print_hide_content.css"), "print");
        }

        $solution = $this->getCorrectSolutionOutput($active_id, $active_id, $pass, $objectives_list);

        $this->tpl->setContent($solution);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

outCorrectSolutionCmd()

ilTestServiceGUI::outCorrectSolutionCmd ( )

protected

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

References outCorrectSolution().

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

Here is the call graph for this function:

populateContent()

ilTestServiceGUI::populateContent ( string  $content )

protected

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

Referenced by ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd().

                                                       : void
    {
        $this->tpl->setContent($content);
    }

Here is the caller graph for this function:

populateExamId()

ilTestServiceGUI::populateExamId ( ilTemplate  $tpl, int  $active_id, int  $pass  )

protected

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

References ILIAS\Repository\lng(), ilObjTest\lookupExamId(), ILIAS\Repository\object(), and HTML_Template_IT\setVariable().

Referenced by ilTestEvaluationGUI\outUserPassDetails().

                                                                                 : void
    {
        if ($this->object->isShowExamIdInTestResultsEnabled()) {
            $tpl->setVariable('EXAM_ID_TXT', $this->lng->txt('exam_id'));
            $tpl->setVariable('EXAM_ID', ilObjTest::lookupExamId(
                $active_id,
                $pass
            ));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

populatePassFinishDate()

ilTestServiceGUI::populatePassFinishDate ( ilTemplate  $tpl, ?int  $pass_finish_date  )

protected

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

References ilDatePresentation\formatDate(), IL_CAL_UNIX, ILIAS\Repository\lng(), null, ilDatePresentation\setUseRelativeDates(), HTML_Template_IT\setVariable(), and ilDatePresentation\useRelativeDates().

Referenced by ilTestEvaluationGUI\outUserPassDetails().

                                                                                      : void
    {
        if ($pass_finish_date === null) {
            return;
        }
        $old_value = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);
        $pass_finish_date_string = ilDatePresentation::formatDate(new ilDateTime($pass_finish_date, IL_CAL_UNIX));
        ilDatePresentation::setUseRelativeDates($old_value);
        $tpl->setVariable("PASS_FINISH_DATE_LABEL", $this->lng->txt('tst_pass_finished_on'));
        $tpl->setVariable("PASS_FINISH_DATE_VALUE", $pass_finish_date_string);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setContextResultPresentation()

ilTestServiceGUI::setContextResultPresentation

(

bool

$contextResultPresentation

)

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

References $contextResultPresentation, $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilObjTest\getLocalDIC(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), null, ILIAS\Repository\refinery(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Referenced by ilTestEvaluationGUI\outUserListOfAnswerPasses().

    {
        $this->contextResultPresentation = $contextResultPresentation;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setObjectiveOrientedContainer()

ilTestServiceGUI::setObjectiveOrientedContainer

(

ilTestObjectiveOrientedContainer

$objective_oriented_container

)

Parameters

ilTestObjectiveOrientedContainer

$objective_oriented_container

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

References $objective_oriented_container.

    {
        $this->objective_oriented_container = $objective_oriented_container;
    }

setParticipantData()

ilTestServiceGUI::setParticipantData

(

ilTestParticipantData

$participantData

)

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

References $participantData.

                                                                              : void
    {
        $this->participantData = $participantData;
    }

Field Documentation

$access

ilAccess ilTestServiceGUI::$access

protected

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

$component_repository

readonly ilComponentRepository ilTestServiceGUI::$component_repository

protected

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

$content_style

readonly ContentStyle ilTestServiceGUI::$content_style

protected

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

$contextResultPresentation

bool ilTestServiceGUI::$contextResultPresentation = true

private

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

Referenced by isContextResultPresentation(), and setContextResultPresentation().

$ctrl

readonly ilCtrlInterface ilTestServiceGUI::$ctrl

protected

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

$db

readonly ilDBInterface ilTestServiceGUI::$db

protected

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

Referenced by ilTestPlayerAbstractGUI\initProcessLocker(), and ilTestEvaluationGUI\performDeletePass().

$error

readonly ilErrorHandling ilTestServiceGUI::$error

protected

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

$global_screen

readonly GlobalScreenServices ilTestServiceGUI::$global_screen

protected

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

$help

readonly ilHelpGUI ilTestServiceGUI::$help

protected

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

$http

readonly HTTPServices ilTestServiceGUI::$http

protected

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

$ilias

readonly ILIAS ilTestServiceGUI::$ilias

protected

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

$lng

readonly ilLanguage ilTestServiceGUI::$lng

protected

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

$logger

readonly TestLogger ilTestServiceGUI::$logger

protected

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

$navigation_history

readonly ilNavigationHistory ilTestServiceGUI::$navigation_history

protected

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

$obj_cache

readonly ilObjectDataCache ilTestServiceGUI::$obj_cache

protected

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

$objective_oriented_container

ilTestObjectiveOrientedContainer ilTestServiceGUI::$objective_oriented_container

private

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

Referenced by getObjectiveOrientedContainer(), and setObjectiveOrientedContainer().

$participant_access_filter

ilTestParticipantAccessFilterFactory ilTestServiceGUI::$participant_access_filter

protected

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

$participantData

ilTestParticipantData ilTestServiceGUI::$participantData = null

protected

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

Referenced by getParticipantData(), ILIAS\Test\Scoring\Manual\TestScoringByParticipantGUI\saveNextManScoringParticipantScreen(), and setParticipantData().

$post_wrapper

readonly ArrayBasedRequestWrapper ilTestServiceGUI::$post_wrapper

protected

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

$questionrepository

readonly GeneralQuestionPropertiesRepository ilTestServiceGUI::$questionrepository

protected

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

$rbac_system

readonly ilRbacSystem ilTestServiceGUI::$rbac_system

protected

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

$ref_id

int ilTestServiceGUI::$ref_id

protected

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

$refinery

readonly Refinery ilTestServiceGUI::$refinery

protected

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

$results_data_factory

readonly ResultsDataFactory ilTestServiceGUI::$results_data_factory

protected

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

$results_presentation_factory

readonly ResultsPresentationFactory ilTestServiceGUI::$results_presentation_factory

protected

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

$service

ilTestService ilTestServiceGUI::$service = null

protected

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

$settings

readonly ilSetting ilTestServiceGUI::$settings

protected

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

Referenced by ilTestEvaluationGUI\buildAttemptComponents(), and ilTestEvaluationGUI\outUserPassDetails().

$shuffler

readonly ilTestShuffler ilTestServiceGUI::$shuffler

protected

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

$skills_service

readonly SkillService ilTestServiceGUI::$skills_service

protected

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

$tabs

readonly ilTabsGUI ilTestServiceGUI::$tabs

protected

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

Referenced by outCorrectSolution().

$test_pass_result_repository

TestResultRepository ilTestServiceGUI::$test_pass_result_repository

protected

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

$test_sequence_factory

ilTestSequenceFactory ilTestServiceGUI::$test_sequence_factory = null

protected

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

Referenced by ilTestPlayerAbstractGUI\executeCommand().

$test_session_factory

ilTestSessionFactory ilTestServiceGUI::$test_session_factory = null

protected

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

$testquestionsrepository

readonly TestQuestionsRepository ilTestServiceGUI::$testquestionsrepository

protected

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

$testrequest

readonly RequestDataCollector ilTestServiceGUI::$testrequest

protected

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

$toolbar

readonly ilToolbarGUI ilTestServiceGUI::$toolbar

protected

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

Referenced by ilTestSubmissionReviewGUI\buildToolbar().

$tpl

ilGlobalTemplateInterface ilTemplate ilTestServiceGUI::$tpl

protected

sk 2023-08-01: We need this union type, even if it is wrong! To change this

Todo:

we have to fix the rendering of the feedback modal in ilTestPlayerAbstractGUI::populateIntantResponseModal().

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

Referenced by ilTestPlayerAbstractGUI\getQuestionGuiInstance(), ilTestEvaluationGUI\outUserPassDetails(), ilTestPlayerAbstractGUI\populateInstantResponseModal(), and ilTestEvalObjectiveOrientedGUI\showVirtualPassCmd().

$tree

readonly ilTree ilTestServiceGUI::$tree

protected

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

$ui_factory

readonly UIFactory ilTestServiceGUI::$ui_factory

protected

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

$ui_renderer

readonly UIRenderer ilTestServiceGUI::$ui_renderer

protected

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

$user

readonly ilObjUser ilTestServiceGUI::$user

protected

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

Referenced by getCorrectSolutionOutput().

---

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

• components/ILIAS/Test/classes/class.ilTestServiceGUI.php