Class ilTestSubmissionReviewGUI. More...

Inheritance diagram for ilTestSubmissionReviewGUI:

Collaboration diagram for ilTestSubmissionReviewGUI:

Public Member Functions
	__construct (ilTestOutputGUI $testOutputGUI, ilObjTest $testOBJ, ilTestSession $testSession)

	executeCommand ()
	execute command More...

Public Member Functions inherited from ilTestServiceGUI
	isContextResultPresentation ()

	setContextResultPresentation ($contextResultPresentation)

	__construct (ilObjTest $a_object)
	The constructor takes the test object reference as parameter. More...

	setParticipantData ($participantData)

	getParticipantData ()

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

	setObjectiveOrientedContainer (ilTestObjectiveOrientedContainer $objectiveOrientedContainer)

	getObjectiveOrientedContainer ()

	executeCommand ()
	execute command More...

	getCommand ($cmd)
	Retrieves the ilCtrl command. More...

	buildPassOverviewTableGUI ($targetGUI, $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)

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
	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
	$testOutputGUI = null

	$testSession

Protected Attributes inherited from ilTestServiceGUI
	$db

	$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

Class ilTestSubmissionReviewGUI.

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

Version: $Id$

@ctrl_calls ilTestSubmissionReviewGUI: ilAssQuestionPageGUI

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

Constructor & Destructor Documentation

◆ __construct()

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

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

    {
        $this->testOutputGUI = $testOutputGUI;
        $this->testSession = $testSession;
        
        parent::__construct($testOBJ);
    }

References $testOutputGUI, and $testSession.

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 208 of file class.ilTestSubmissionReviewGUI.php.

    {
        global $ilSetting;
        
        $inst_id = $ilSetting->get('inst_id', null);
        
        require_once 'Services/Utilities/classes/class.ilUtil.php';
        
        $path =  ilUtil::getWebspaceDir() . '/assessment/' . $this->testOutputGUI->object->getId() . '/exam_pdf';
        
        if (!is_dir($path)) {
            ilUtil::makeDirParents($path);
        }
        
        $filename = ilUtil::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;
    }

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

Here is the call graph for this function:

◆ buildToolbar()

ilTestSubmissionReviewGUI::buildToolbar ( $toolbarId )

protected

Returns: ilToolbarGUI

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

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

References ilTestPlayerCommands\BACK_FROM_FINISHING, ilTestPlayerCommands\FINISH_TEST, ilButton\FORM_TARGET_BLANK, ilLinkButton\getInstance(), and ilTestPlayerCommands\QUESTION_SUMMARY.

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildUserReviewOutput()

ilTestSubmissionReviewGUI::buildUserReviewOutput ( )

protected

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

    {
        $ilObjDataCache = isset($GLOBALS['DIC']) ? $GLOBALS['DIC']['ilObjDataCache'] : $GLOBALS['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;
    }

References $GLOBALS, $results, ilTestServiceGUI\buildQuestionRelatedObjectivesList(), ilLOTestQuestionAdapter\getInstance(), and ilTestServiceGUI\getObjectiveOrientedContainer().

Referenced by pdfDownload(), and show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dispatchCommand()

ilTestSubmissionReviewGUI::dispatchCommand ( )

protected

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

    {
        switch ($this->ctrl->getCmd()) {
            case 'pdfDownload':
                
                if ($this->object->getShowExamviewPdf()) {
                    $this->pdfDownload();
                }
                
                break;
                
            case 'show':
            default:
                
                $this->show();
        }
    }

References pdfDownload(), and show().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilTestSubmissionReviewGUI::executeCommand ( )

execute command

Reimplemented from ilTestServiceGUI.

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

    {
        if (!$this->object->getEnableExamview()) {
            return '';
        }
        
        switch ($this->ctrl->getNextClass($this)) {
            default:
                $this->dispatchCommand();
                break;
        }
        
        return '';
    }

References dispatchCommand().

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

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

    {
        if ($this->object->getKioskMode()) {
            $this->tpl->setBodyClass("kiosk");
            $this->tpl->setAddFooter(false);
            return "CONTENT";
        } else {
            return "ADM_CONTENT";
        }
    }

Referenced by show().

Here is the caller graph for this function:

◆ pdfDownload()

ilTestSubmissionReviewGUI::pdfDownload ( )

protected

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

    {
        $reviewOutput = $this->buildUserReviewOutput();
        
        require_once './Services/PDFGeneration/classes/class.ilPDFGeneration.php';
        ilPDFGeneration::prepareGeneration();
 
        require_once 'Modules/Test/classes/class.ilTestPDFGenerator.php';
        ilTestPDFGenerator::generatePDF($reviewOutput, ilTestPDFGenerator::PDF_OUTPUT_DOWNLOAD, PDF_USER_RESULT);
        
        exit;
    }

References buildUserReviewOutput(), exit, ilTestPDFGenerator\generatePDF(), ilTestPDFGenerator\PDF_OUTPUT_DOWNLOAD, PDF_USER_RESULT, and ilPDFGeneration\prepareGeneration().

Referenced by dispatchCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ show()

ilTestSubmissionReviewGUI::show ( )

protected

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

    {
        $html = $this->buildToolbar('review_nav_top')->getHTML();
        $html .= $this->buildUserReviewOutput() . '<br />';
        $html .= $this->buildToolbar('review_nav_bottom')->getHTML();
        
        $this->tpl->setVariable($this->getContentBlockName(), $html);
    }