ilTestSubmissionReviewGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilTestSubmissionReviewGUI:

Collaboration diagram for ilTestSubmissionReviewGUI:

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

Protected Member Functions
	dispatchCommand ()
	buildToolbar ($toolbarId)
	buildUserReviewOutput ()
	show ()
	pdfDownload ()
	buildPdfFilename ()
	not in use, but we keep the code (no archive for every user at end of test !!) More...
Protected Member Functions inherited from ilTestServiceGUI
	isPdfDeliveryRequest ()
	buildQuestionAnswerShuffler (int $question_id, int $active_id, int $pass_id)
	buildFixedShufflerSeed (int $question_id, int $pass_id, int $active_id)
	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
	$testOutputGUI = null
	$testSession
Protected Attributes inherited from ilTestServiceGUI
ILIAS Test InternalRequestService	$testrequest
	$db
Refinery	$refinery
	$tabs
	$objCache
	$testSessionFactory = null
	$testSequenceFactory = null
	$participantData

Private Member Functions
	getContentBlockName ()
	Returns the name of the current content block (depends on the kiosk mode setting) More...

Additional Inherited Members
Data Fields inherited from ilTestServiceGUI
	$object = null
	$service = null
	$lng
	$tpl
	$ctrl
	$ilias
	$tree
	$ref_id

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilTestSubmissionReviewGUI

Author

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

ilTestSubmissionReviewGUI: ilAssQuestionPageGUI

Definition at line 27 of file class.ilTestSubmissionReviewGUI.php.

Constructor & Destructor Documentation

__construct()

ilTestSubmissionReviewGUI::__construct	(	ilTestOutputGUI	$testOutputGUI,
		ilObjTest	$testOBJ,
		ilTestSession	$testSession
	)

Definition at line 35 of file class.ilTestSubmissionReviewGUI.php.

References $testOutputGUI, $testSession, and ILIAS\GlobalScreen\Provider\__construct().

    {
        $this->testOutputGUI = $testOutputGUI;
        $this->testSession = $testSession;

        parent::__construct($testOBJ);
    }

Here is the call graph for this function:

Member Function Documentation

buildPdfFilename()

ilTestSubmissionReviewGUI::buildPdfFilename ( )

protected

not in use, but we keep the code (no archive for every user at end of test !!)

Returns

string

Definition at line 245 of file class.ilTestSubmissionReviewGUI.php.

References $DIC, $filename, $ilSetting, $path, ilFileUtils\getWebspaceDir(), ilFileUtils\makeDirParents(), and ilFileUtils\removeTrailingPathSeparators().

                                         : string
    {
        global $DIC;
        $ilSetting = $DIC['ilSetting'];

        $inst_id = $ilSetting->get('inst_id', null);

        require_once 'Services/Utilities/classes/class.ilUtil.php';

        $path = ilFileUtils::getWebspaceDir() . '/assessment/' . $this->testOutputGUI->object->getId() . '/exam_pdf';

        if (!is_dir($path)) {
            ilFileUtils::makeDirParents($path);
        }

        $filename = ilFileUtils::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH) . '/' . $path . '/exam_N';
        $filename .= $inst_id . '-' . $this->testOutputGUI->object->getId();
        $filename .= '-' . $this->testSession->getActiveId() . '-';
        $filename .= $this->testSession->getPass() . '.pdf';

        return $filename;
    }

Here is the call graph for this function:

buildToolbar()

ilTestSubmissionReviewGUI::buildToolbar (   $toolbarId )

protected

Returns

ilToolbarGUI

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

References ilTestPlayerCommands\BACK_FROM_FINISHING, ILIAS\Repository\ctrl(), ilTestPlayerCommands\FINISH_TEST, ilButton\FORM_TARGET_BLANK, ilLinkButton\getInstance(), ILIAS\Repository\object(), and ilTestPlayerCommands\QUESTION_SUMMARY.

Referenced by show().

                                               : ilToolbarGUI
    {
        require_once 'Modules/Test/classes/class.ilTestPlayerCommands.php';
        require_once 'Services/UIComponent/Toolbar/classes/class.ilToolbarGUI.php';
        require_once 'Services/UIComponent/Button/classes/class.ilLinkButton.php';
        require_once 'Services/UIComponent/Button/classes/class.ilButton.php';

        $toolbar = new ilToolbarGUI();
        $toolbar->setId($toolbarId);

        $backUrl = $this->ctrl->getLinkTarget(
            $this->testOutputGUI,
            $this->object->getListOfQuestionsEnd() ?
            ilTestPlayerCommands::QUESTION_SUMMARY : ilTestPlayerCommands::BACK_FROM_FINISHING
        );

        $button = ilLinkButton::getInstance();
        $button->setCaption('btn_previous');
        $button->setUrl($backUrl);
        $toolbar->addButtonInstance($button);

        if ($this->object->getShowExamviewPdf()) {
            $pdfUrl = $this->ctrl->getLinkTarget($this, 'pdfDownload');

            $button = ilLinkButton::getInstance();
            $button->setCaption('pdf_export');
            $button->setUrl($pdfUrl);
            $button->setTarget(ilButton::FORM_TARGET_BLANK);
            $toolbar->addButtonInstance($button);
        }

        $this->ctrl->setParameter($this->testOutputGUI, 'reviewed', 1);
        $nextUrl = $this->ctrl->getLinkTarget($this->testOutputGUI, ilTestPlayerCommands::FINISH_TEST);
        $this->ctrl->setParameter($this->testOutputGUI, 'reviewed', 0);

        $button = ilLinkButton::getInstance();
        $button->setPrimary(true);
        $button->setCaption('btn_next');
        $button->setUrl($nextUrl);
        $toolbar->addButtonInstance($button);

        return $toolbar;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildUserReviewOutput()

ilTestSubmissionReviewGUI::buildUserReviewOutput ( )

protected

Definition at line 141 of file class.ilTestSubmissionReviewGUI.php.

References $DIC, $results, ilTestServiceGUI\buildQuestionRelatedObjectivesList(), ilLOTestQuestionAdapter\getInstance(), ilTestServiceGUI\getObjectiveOrientedContainer(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by pdfDownload(), and show().

                                              : string
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        $ilObjDataCache = $DIC['ilObjDataCache'];

        require_once 'Modules/Test/classes/class.ilTestResultHeaderLabelBuilder.php';
        $testResultHeaderLabelBuilder = new ilTestResultHeaderLabelBuilder($this->lng, $ilObjDataCache);

        $objectivesList = null;

        if ($this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()) {
            $testSequence = $this->testSequenceFactory->getSequenceByActiveIdAndPass($this->testSession->getActiveId(), $this->testSession->getPass());
            $testSequence->loadFromDb();
            $testSequence->loadQuestions();

            require_once 'Modules/Course/classes/Objectives/class.ilLOTestQuestionAdapter.php';
            $objectivesAdapter = ilLOTestQuestionAdapter::getInstance($this->testSession);

            $objectivesList = $this->buildQuestionRelatedObjectivesList($objectivesAdapter, $testSequence);
            $objectivesList->loadObjectivesTitles();

            $testResultHeaderLabelBuilder->setObjectiveOrientedContainerId($this->testSession->getObjectiveOrientedContainerId());
            $testResultHeaderLabelBuilder->setUserId($this->testSession->getUserId());
            $testResultHeaderLabelBuilder->setTestObjId($this->object->getId());
            $testResultHeaderLabelBuilder->setTestRefId($this->object->getRefId());
            $testResultHeaderLabelBuilder->initObjectiveOrientedMode();
        }

        $results = $this->object->getTestResult(
            $this->testSession->getActiveId(),
            $this->testSession->getPass(),
            false,
            !$this->getObjectiveOrientedContainer()->isObjectiveOrientedPresentationRequired()
        );

        require_once 'class.ilTestEvaluationGUI.php';
        $testevaluationgui = new ilTestEvaluationGUI($this->object);
        $testevaluationgui->setContextResultPresentation(false);

        $results_output = $testevaluationgui->getPassListOfAnswers(
            $results,
            $this->testSession->getActiveId(),
            $this->testSession->getPass(),
            false,
            false,
            false,
            false,
            false,
            $objectivesList,
            $testResultHeaderLabelBuilder
        );

        return $results_output;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

dispatchCommand()

ilTestSubmissionReviewGUI::dispatchCommand ( )

protected

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\object(), pdfDownload(), and show().

Referenced by executeCommand().

    {
        switch ($this->ctrl->getCmd()) {
            case 'pdfDownload':

                if ($this->object->getShowExamviewPdf()) {
                    $this->pdfDownload();
                }

                break;

            case 'show':
            default:

                $this->show();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilTestSubmissionReviewGUI::executeCommand

(

)

Definition at line 43 of file class.ilTestSubmissionReviewGUI.php.

References ILIAS\Repository\ctrl(), dispatchCommand(), and ILIAS\Repository\object().

                                    : string
    {
        if (!$this->object->getEnableExamview()) {
            return '';
        }

        switch ($this->ctrl->getNextClass($this)) {
            default:
                $this->dispatchCommand();
                break;
        }

        return '';
    }

Here is the call graph for this function:

getContentBlockName()

ilTestSubmissionReviewGUI::getContentBlockName ( )

private

Returns the name of the current content block (depends on the kiosk mode setting)

Returns

string The name of the content block public

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

References ILIAS\Repository\object().

Referenced by show().

                                          : string
    {
        if ($this->object->getKioskMode()) {
            // See: https://mantis.ilias.de/view.php?id=27784
            //$this->tpl->setBodyClass("kiosk");
            $this->tpl->hideFooter();
            return "CONTENT";
        } else {
            return "ADM_CONTENT";
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

pdfDownload()

ilTestSubmissionReviewGUI::pdfDownload ( )

protected

Definition at line 225 of file class.ilTestSubmissionReviewGUI.php.

References $filename, buildUserReviewOutput(), exit, ilTestPDFGenerator\generatePDF(), ilTestPDFGenerator\PDF_OUTPUT_DOWNLOAD, PDF_USER_RESULT, and ilPDFGeneratorUtils\prepareGenerationRequest().

Referenced by dispatchCommand().

    {
        ilPDFGeneratorUtils::prepareGenerationRequest("Test", PDF_USER_RESULT);

        $reviewOutput = $this->buildUserReviewOutput();

        $filename = $this->testOutputGUI->object->getRefId();
        $filename .= '-' . $this->testSession->getActiveId() . '-';
        $filename .= $this->testSession->getPass() . '.pdf';

        ilTestPDFGenerator::generatePDF($reviewOutput, ilTestPDFGenerator::PDF_OUTPUT_DOWNLOAD, $filename, PDF_USER_RESULT);

        exit;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

show()

ilTestSubmissionReviewGUI::show ( )

protected

Definition at line 196 of file class.ilTestSubmissionReviewGUI.php.

References $DIC, buildToolbar(), buildUserReviewOutput(), getContentBlockName(), ILIAS\Repository\lng(), ilObjTest\lookupExamId(), ILIAS\Repository\object(), and ilTestPlayerLayoutProvider\TEST_PLAYER_TITLE.

Referenced by dispatchCommand().

    {
        global $DIC;
        $DIC->globalScreen()->tool()->context()->current()->getAdditionalData()->replace(
            ilTestPlayerLayoutProvider::TEST_PLAYER_TITLE,
            $this->object->getTitle() . ' - ' . $this->lng->txt('tst_results_overview')
        );

        $html = $this->buildToolbar('review_nav_top')->getHTML();
        $html .= $this->buildUserReviewOutput() . '<br />';
        $html .= $this->buildToolbar('review_nav_bottom')->getHTML();

        if ($this->object->isShowExamIdInTestPassEnabled() && !$this->object->getKioskMode()) {
            $examIdTpl = new ilTemplate("tpl.exam_id_block.html", true, true, 'Modules/Test');
            $examIdTpl->setVariable('EXAM_ID_VAL', ilObjTest::lookupExamId(
                $this->testSession->getActiveId(),
                $this->testSession->getPass(),
                $this->object->getId()
            ));
            $examIdTpl->setVariable('EXAM_ID_TXT', $this->lng->txt('exam_id'));
            $html .= $examIdTpl->get();
        }

        $this->tpl->setVariable(
            $this->getContentBlockName(),
            $html
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$testOutputGUI

ilTestSubmissionReviewGUI::$testOutputGUI = null

protected

Definition at line 30 of file class.ilTestSubmissionReviewGUI.php.

Referenced by __construct().

$testSession

ilTestSubmissionReviewGUI::$testSession

protected

Definition at line 33 of file class.ilTestSubmissionReviewGUI.php.

Referenced by __construct().

---

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

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