assOrderingHorizontalGUI Class Reference

The assOrderingHorizontalGUI class encapsulates the GUI representation for horizontal ordering questions. More...

Inheritance diagram for assOrderingHorizontalGUI:

Collaboration diagram for assOrderingHorizontalGUI:

Public Member Functions
	__construct ($id=-1)
	assOrderingHorizontalGUI constructor More...
	getCommand ($cmd)
	editQuestion ($checkonly=false)
	Creates an output of the edit form for the question. More...
	supportsIntermediateSolutionOutput ()
	Question type specific support of intermediate solution output The function getSolutionOutput respects getUseIntermediateSolution() More...
	getSolutionOutput ( $active_id, $pass=null, $graphicalOutput=false, $result_output=false, $show_question_only=true, $show_feedback=false, $show_correct_solution=false, $show_manual_scoring=false, $show_question_text=true)
	Get the question solution output. More...
	getPreview ($show_question_only=false, $showInlineFeedback=false)
	getTestOutput ($active_id, $pass, $is_postponed=false, $use_post_solutions=false, $show_feedback=false)
	saveFeedback ()
	Saves the feedback for a single choice question. More...
	setQuestionTabs ()
	Sets the ILIAS tabs for this question type. More...
	getSpecificFeedbackOutput ($userSolution)
	Returns the answer specific feedback for the question. More...
	writeQuestionSpecificPostData (ilPropertyFormGUI $form)
	Extracts the question specific values from $_POST and applies them to the data object. More...
	getAfterParticipationSuppressionQuestionPostVars ()
	Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment. More...
	populateQuestionSpecificFormPart (\ilPropertyFormGUI $form)
	getAggregatedAnswersView ($relevant_answers)
	Returns an html string containing a question specific representation of the answers so far given in the test for use in the right column in the scoring adjustment user interface. More...
	aggregateAnswers ($relevant_answers_chosen, $answer_defined_on_question)
	renderAggregateView ($aggregate)
	getAnswersFrequency ($relevantAnswers, $questionIndex)
	populateCorrectionsFormProperties (ilPropertyFormGUI $form)
	saveCorrectionsFormProperties (ilPropertyFormGUI $form)
Public Member Functions inherited from assQuestionGUI
	__construct ()
	assQuestionGUI constructor More...
	hasInlineFeedback ()
	this method can be overwritten per question type More...
	addHeaderAction ()
	redrawHeaderAction ()
	getHeaderAction ()
	getNotesHTML ()
	executeCommand ()
	execute command More...
	getCommand ($cmd)
	getType ()
	needed for page editor compliance More...
	getPresentationContext ()
	setPresentationContext ($presentationContext)
	isTestPresentationContext ()
	isPreviousSolutionPrefilled ()
	setPreviousSolutionPrefilled ($previousSolutionPrefilled)
	getRenderPurpose ()
	setRenderPurpose ($renderPurpose)
	isRenderPurposePrintPdf ()
	isRenderPurposePreview ()
	isRenderPurposeInputValue ()
	isRenderPurposePlayback ()
	isRenderPurposeDemoplay ()
	renderPurposeSupportsFormHtml ()
	getEditContext ()
	setEditContext ($editContext)
	isAuthoringEditContext ()
	isAdjustmentEditContext ()
	setAdjustmentEditContext ()
	getNavigationGUI ()
	setNavigationGUI ($navigationGUI)
	setTaxonomyIds ($taxonomyIds)
	getTaxonomyIds ()
	setTargetGui ($linkTargetGui)
	setTargetGuiClass ($targetGuiClass)
	getTargetGuiClass ()
	setQuestionHeaderBlockBuilder ($questionHeaderBlockBuilder)
	getQuestionHeaderBlockBuilder ()
	setQuestionActionCmd ($questionActionCmd)
	getQuestionActionCmd ()
&	createQuestionGUI ($question_type, $question_id=-1)
	Creates a question gui representation. More...
	populateJavascriptFilesRequiredForWorkForm (ilTemplate $tpl)
	getQuestionTemplate ()
	get question template More...
	getILIASPage ($html="")
	Returns the ILIAS Page around a question. More...
	outQuestionPage ($a_temp_var, $a_postponed=false, $active_id="", $html="", $inlineFeedbackEnabled=false)
	output question page More...
	cancel ()
	cancel action More...
	originalSyncForm ($return_to="", $return_to_feedback='')
	sync ()
	cancelSync ()
	saveEdit ()
	save question More...
	save ()
	save question More...
	saveReturn ()
	save question More...
	apply ()
	apply changes More...
	getContextPath ($cont_obj, $a_endnode_id, $a_startnode_id=1)
	get context path in content object tree More...
	setSequenceNumber ($nr)
	getSequenceNumber ()
	setQuestionCount ($a_question_count)
	getQuestionCount ()
	getErrorMessage ()
	setErrorMessage ($errormessage)
	addErrorMessage ($errormessage)
	outAdditionalOutput ()
	getQuestionType ()
	Returns the question type string. More...
	getAsValueAttribute ($a_value)
	Returns a HTML value attribute. More...
	addNewIdListener (&$a_object, $a_method, $a_parameters="")
	Add a listener that is notified with the new question ID, when a new question is saved. More...
	callNewIdListeners ($a_new_id)
	Call the new id listeners. More...
	addQuestionFormCommandButtons ($form)
	Add the command buttons of a question properties form. More...
	addBasicQuestionFormProperties ($form)
	Add basic question form properties: assessment: title, author, description, question, working time. More...
	getAnswerFeedbackOutput ($active_id, $pass)
	Returns the answer generic feedback depending on the results of the question. More...
	getGenericFeedbackOutput ($active_id, $pass)
	Returns the answer specific feedback for the question. More...
	getGenericFeedbackOutputForCorrectSolution ()
	getGenericFeedbackOutputForIncorrectSolution ()
	getSpecificFeedbackOutput ($userSolution)
	Returns the answer specific feedback for the question. More...
	outQuestionType ()
	showSuggestedSolution ()
	suggestedsolution ()
	Allows to add suggested solutions for questions. More...
	outSolutionExplorer ()
	saveSuggestedSolution ()
	cancelExplorer ()
	outPageSelector ()
	outChapterSelector ()
	outGlossarySelector ()
	linkChilds ()
	addPG ()
	addST ()
	addGIT ()
	isSaveCommand ()
	setQuestionTabs ()
	addTab_SuggestedSolution (ilTabsGUI $tabs, $classname)
	getEditQuestionTabCommands ()
	getSolutionOutput ( $active_id, $pass=null, $graphicalOutput=false, $result_output=false, $show_question_only=true, $show_feedback=false, $show_correct_solution=false, $show_manual_scoring=false, $show_question_text=true)
	supportsIntermediateSolutionOutput ()
	Question type specific support of intermediate solution output The function getSolutionOutput respects getUseIntermediateSolution() More...
	hasIntermediateSolution ($activeId, $passIndex)
	Check if the question has an intermediate solution. More...
	setUseIntermediateSolution ($use)
	getUseIntermediateSolution ()
	Get if intermediate solution should be used for solution output. More...
	isAutosaveable ()
	getPreview ($show_question_only=false, $showInlineFeedback=false)
	outQuestionForTest ( $formaction, $active_id, $pass, $is_question_postponed=false, $user_post_solutions=false, $show_specific_inline_feedback=false)
	magicAfterTestOutput ()
	getTestOutput ( $active_id, $pass, $is_question_postponed, $user_post_solutions, $show_specific_inline_feedback)
	getFormEncodingType ()
	setPreviewSession ($previewSession)
	getPreviewSession ()
	showHints ()
	buildFocusAnchorHtml ()
	isAnswerFreuqencyStatisticSupported ()
	getSubQuestionsIndex ()
	getAnswersFrequency ($relevantAnswers, $questionIndex)
	getAnswerFrequencyTableGUI ($parentGui, $parentCmd, $relevantAnswers, $questionIndex)
	prepareReprintableCorrectionsForm (ilPropertyFormGUI $form)
	populateCorrectionsFormProperties (ilPropertyFormGUI $form)
	saveCorrectionsFormProperties (ilPropertyFormGUI $form)
Public Member Functions inherited from ilGuiQuestionScoringAdjustable
	populateQuestionSpecificFormPart (ilPropertyFormGUI $form)
	Adds the question specific forms parts to a question property form gui. More...
	writeQuestionSpecificPostData (ilPropertyFormGUI $form)
	Extracts the question specific values from $_POST and applies them to the data object. More...
	getAfterParticipationSuppressionQuestionPostVars ()
	Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment. More...
	getAggregatedAnswersView ($relevant_answers)
	Returns an html string containing a question specific representation of the answers so far given in the test for use in the right column in the scoring adjustment user interface. More...

Protected Member Functions
	writePostData ($always=false)
	{Evaluates a posted edit form and writes the form data in the question object. Returns integer A positive value, if one of the required fields wasn't set, else 0 } More...
Protected Member Functions inherited from assQuestionGUI
	writePostData ($always=false)
	Evaluates a posted edit form and writes the form data in the question object. More...
	renderEditForm ($form)
	getUseUnchangedAnswerCheckboxHtml ()
	getPreviousSolutionProvidedMessage ()
	getPreviousSolutionConfirmationCheckboxHtml ()
	saveTaxonomyAssignments ()
	populateTaxonomyFormSection (ilPropertyFormGUI $form)
	getBasicEditQuestionTabCommands ()
	getAdditionalEditQuestionCommands ()
	addTab_QuestionFeedback (ilTabsGUI $tabs)
	adds the feedback tab to ilTabsGUI More...
	addTab_QuestionHints (ilTabsGUI $tabs)
	adds the hints tab to ilTabsGUI More...
	addTab_QuestionPreview (ilTabsGUI $tabsGUI)
	hasCorrectSolution ($activeId, $passIndex)
	writeQuestionGenericPostData ()
	completeTestOutputFormAction ($formAction, $active_id, $pass)
	addBackTab (ilTabsGUI $ilTabs)
	buildBasicEditFormObject ()
	buildEditForm ()

Additional Inherited Members
Static Public Member Functions inherited from assQuestionGUI
static	_getQuestionGUI ($question_type, $question_id=-1)
	Creates a question gui representation and returns the alias to the question gui note: please do not use $this inside this method to allow static calls. More...
static	_getGUIClassNameForId ($a_q_id)
static	_getClassNameForQType ($q_type)
static	getCommandsFromClassConstants ($guiClassName, $cmdConstantNameBegin='CMD_')
	extracts values of all constants of given class with given prefix as array can be used to get all possible commands in case of these commands are defined as constants More...
Data Fields inherited from assQuestionGUI
const	FORM_MODE_EDIT = 'edit'
const	FORM_MODE_ADJUST = 'adjust'
const	FORM_ENCODING_URLENCODE = 'application/x-www-form-urlencoded'
const	FORM_ENCODING_MULTIPART = 'multipart/form-data'
const	SESSION_PREVIEW_DATA_BASE_INDEX = 'ilAssQuestionPreviewAnswers'
	$object
	$tpl
	$lng
	$error
	$errormessage
	$sequence_no
	sequence number in test More...
	$question_count
	question count in test More...
const	PRESENTATION_CONTEXT_TEST = 'pContextTest'
const	PRESENTATION_CONTEXT_RESULTS = 'pContextResults'
const	RENDER_PURPOSE_PLAYBACK = 'renderPurposePlayback'
const	RENDER_PURPOSE_DEMOPLAY = 'renderPurposeDemoplay'
const	RENDER_PURPOSE_PREVIEW = 'renderPurposePreview'
const	RENDER_PURPOSE_PRINT_PDF = 'renderPurposePrintPdf'
const	RENDER_PURPOSE_INPUT_VALUE = 'renderPurposeInputValue'
const	EDIT_CONTEXT_AUTHORING = 'authoring'
const	EDIT_CONTEXT_ADJUSTMENT = 'adjustment'
Protected Attributes inherited from assQuestionGUI
	$editForm
	$use_intermediate_solution = false

Detailed Description

The assOrderingHorizontalGUI class encapsulates the GUI representation for horizontal ordering questions.

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

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

Version

$Id$

@ilctrl_iscalledby assOrderingHorizontalGUI: ilObjQuestionPoolGUI @ilCtrl_Calls assOrderingHorizontalGUI: ilPropertyFormGUI, ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

__construct()

assOrderingHorizontalGUI::__construct

(

$id = -1

)

assOrderingHorizontalGUI constructor

The constructor takes possible arguments an creates an instance of the assOrderingHorizontalGUI object.

Parameters

integer

$id

The database id of a single choice question object @access public

Definition at line 32 of file class.assOrderingHorizontalGUI.php.

    {
        parent::__construct();
        include_once "./Modules/TestQuestionPool/classes/class.assOrderingHorizontal.php";
        $this->object = new assOrderingHorizontal();
        $this->setErrorMessage($this->lng->txt("msg_form_save_error"));
        if ($id >= 0) {
            $this->object->loadFromDb($id);
        }
    }

References $id, and assQuestionGUI\setErrorMessage().

Here is the call graph for this function:

Member Function Documentation

aggregateAnswers()

assOrderingHorizontalGUI::aggregateAnswers	(		$relevant_answers_chosen,
			$answer_defined_on_question
	)

Definition at line 546 of file class.assOrderingHorizontalGUI.php.

    {
        $aggregate = array();
        foreach ($relevant_answers_chosen as $answer) {
            $answer = str_replace($this->object->getAnswerSeparator(), '  -  ', $answer);
            if (in_array($answer['value1'], $aggregate)) {
                $aggregate[$answer['value1']] = $aggregate[$answer['value1']] + 1;
            } else {
                $aggregate[$answer['value1']] = 1;
            }
        }
 
        return $aggregate;
    }

Referenced by getAggregatedAnswersView().

Here is the caller graph for this function:

editQuestion()

assOrderingHorizontalGUI::editQuestion

(

$checkonly = false

)

Creates an output of the edit form for the question.

@access public

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

    {
        $save = $this->isSaveCommand();
        $this->getQuestionTemplate();
 
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $this->editForm = $form;
 
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->outQuestionType());
        $form->setMultipart(false);
        $form->setTableWidth("100%");
        $form->setId("orderinghorizontal");
 
        $this->addBasicQuestionFormProperties($form);
        $this->populateQuestionSpecificFormPart($form);
 
 
        $this->populateTaxonomyFormSection($form);
 
        $this->addQuestionFormCommandButtons($form);
        
        $errors = false;
    
        if ($save) {
            $form->setValuesByPost();
            $errors = !$form->checkInput();
            $form->setValuesByPost(); // again, because checkInput now performs the whole stripSlashes handling and we need this if we don't want to have duplication of backslashes
            if ($errors) {
                $checkonly = false;
            }
        }
 
        if (!$checkonly) {
            $this->tpl->setVariable("QUESTION_DATA", $form->getHTML());
        }
        return $errors;
    }

References $errors, $form, assQuestionGUI\addBasicQuestionFormProperties(), assQuestionGUI\addQuestionFormCommandButtons(), assQuestionGUI\getQuestionTemplate(), assQuestionGUI\isSaveCommand(), assQuestionGUI\outQuestionType(), populateQuestionSpecificFormPart(), and assQuestionGUI\populateTaxonomyFormSection().

Referenced by writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

getAfterParticipationSuppressionQuestionPostVars()

assOrderingHorizontalGUI::getAfterParticipationSuppressionQuestionPostVars

(

)

Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment.

The form elements will be shown disabled, so the users see the usual form but can only edit the settings, which make sense in the given context.

E.g. array('cloze_type', 'image_filename')

Returns

string[]

Implements ilGuiQuestionScoringAdjustable.

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

    {
        return array();
    }

getAggregatedAnswersView()

assOrderingHorizontalGUI::getAggregatedAnswersView

(

$relevant_answers

)

Returns an html string containing a question specific representation of the answers so far given in the test for use in the right column in the scoring adjustment user interface.

Parameters

array

$relevant_answers

Returns

string

Implements ilGuiQuestionScoringAdjustable.

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

    {
        return  $this->renderAggregateView(
            $this->aggregateAnswers($relevant_answers, $this->object->getOrderText())
        )->get();
    }

References aggregateAnswers(), and renderAggregateView().

Here is the call graph for this function:

getAnswersFrequency()

assOrderingHorizontalGUI::getAnswersFrequency	(		$relevantAnswers,
			$questionIndex
	)

Reimplemented from assQuestionGUI.

Definition at line 579 of file class.assOrderingHorizontalGUI.php.

    {
        $answers = array();
        
        foreach ($relevantAnswers as $ans) {
            $md5 = md5($ans['value1']);
            
            if (!isset($answers[$md5])) {
                $answer = str_replace(
                    $this->object->getAnswerSeparator(),
                    '  -  ',
                    $ans['value1']
                );
                
                $answers[$md5] = array(
                    'answer' => $answer, 'frequency' => 0
                );
            }
            
            $answers[$md5]['frequency']++;
        }
        
        return $answers;
    }

getCommand()

assOrderingHorizontalGUI::getCommand

(

$cmd

)

Reimplemented from assQuestionGUI.

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

    {
        return $cmd;
    }

getPreview()

assOrderingHorizontalGUI::getPreview	(		$show_question_only = false,
			$showInlineFeedback = false
	)

Reimplemented from assQuestionGUI.

Definition at line 250 of file class.assOrderingHorizontalGUI.php.

    {
        if (is_object($this->getPreviewSession()) && strlen((string) $this->getPreviewSession()->getParticipantsSolution())) {
            $elements = (string) $this->getPreviewSession()->getParticipantsSolution();
            $elements = $this->object->splitAndTrimOrderElementText($elements, $this->object->getAnswerSeparator());
        } else {
            $elements = $this->object->getRandomOrderingElements();
        }
        
        $template = new ilTemplate("tpl.il_as_qpl_orderinghorizontal_preview.html", true, true, "Modules/TestQuestionPool");
        foreach ($elements as $id => $element) {
            $template->setCurrentBlock("element");
            $template->setVariable("ELEMENT_ID", "e_" . $this->object->getId() . "_$id");
            $template->setVariable("ORDERING_VALUE", ilUtil::prepareFormOutput($element));
            $template->setVariable("ELEMENT_VALUE", ilUtil::prepareFormOutput($element));
            $template->parseCurrentBlock();
        }
        $template->setVariable("QUESTION_ID", $this->object->getId());
        $template->setVariable("VALUE_ORDERRESULT", ' value="' . join('{::}', $elements) . '"');
        if ($this->object->textsize >= 10) {
            $template->setVariable("STYLE", " style=\"font-size: " . $this->object->textsize . "%;\"");
        }
        $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($this->object->getQuestion(), true));
        $questionoutput = $template->get();
        if (!$show_question_only) {
            // get page object output
            $questionoutput = $this->getILIASPage($questionoutput);
        }
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        if ($DIC['ilBrowser']->isMobile() || $DIC['ilBrowser']->isIpad()) {
            $this->tpl->addJavaScript('./libs/bower/bower_components/jqueryui-touch-punch/jquery.ui.touch-punch.min.js');
        }
        $this->tpl->addJavascript("./Modules/TestQuestionPool/templates/default/orderinghorizontal.js");
        return $questionoutput;
    }

References $DIC, $id, $template, assQuestionGUI\getILIASPage(), assQuestionGUI\getPreviewSession(), and ilUtil\prepareFormOutput().

Here is the call graph for this function:

getSolutionOutput()

assOrderingHorizontalGUI::getSolutionOutput	(		$active_id,
			$pass = null,
			$graphicalOutput = false,
			$result_output = false,
			$show_question_only = true,
			$show_feedback = false,
			$show_correct_solution = false,
			$show_manual_scoring = false,
			$show_question_text = true
	)

Get the question solution output.

Parameters

integer	$active_id	The active user id
integer	$pass	The test pass
boolean	$graphicalOutput	Show visual feedback for right/wrong answers
boolean	$result_output	Show the reached points for parts of the question
boolean	$show_question_only	Show the question without the ILIAS content around
boolean	$show_feedback	Show the question feedback
boolean	$show_correct_solution	Show the correct solution instead of the user solution
boolean	$show_manual_scoring	Show specific information for the manual scoring output

Returns

The solution output of the question as HTML code

Reimplemented from assQuestionGUI.

Definition at line 132 of file class.assOrderingHorizontalGUI.php.

      {
        // get the solution of the user for the active pass or from the last pass if allowed
        $template = new ilTemplate("tpl.il_as_qpl_orderinghorizontal_output_solution.html", true, true, "Modules/TestQuestionPool");
 
        //$solutionvalue = "";
        if (($active_id > 0) && (!$show_correct_solution)) {
            $elements = [];
            $solutions = $this->object->getSolutionValues($active_id, $pass, !$this->getUseIntermediateSolution());
            if (strlen($solutions[0]["value1"])) {
                $elements = explode("{::}", $solutions[0]["value1"]);
            }
 
            if (!count($elements)) {
                $elements = $this->object->getRandomOrderingElements();
            }
 
            foreach ($elements as $id => $element) {
                $template->setCurrentBlock("element");
                $template->setVariable("ELEMENT_ID", "sol_e_" . $this->object->getId() . "_$id");
                $template->setVariable("ELEMENT_VALUE", ilUtil::prepareFormOutput($element));
                $template->parseCurrentBlock();
            }
 
            //$solutionvalue = str_replace("{::}", " ", $solutions[0]["value1"]);
        } else {
            $elements = $this->object->getOrderingElements();
            foreach ($elements as $id => $element) {
                $template->setCurrentBlock("element");
                $template->setVariable("ELEMENT_ID", "sol_e_" . $this->object->getId() . "_$id");
                $template->setVariable("ELEMENT_VALUE", ilUtil::prepareFormOutput($element));
                $template->parseCurrentBlock();
            }
            //$solutionvalue = join($this->object->getOrderingElements(), " ");
        }
 
        if (($active_id > 0) && (!$show_correct_solution)) {
            if ($this->object->getStep() === null) {
                $reached_points = $this->object->getReachedPoints($active_id, $pass);
            } else {
                $reached_points = $this->object->calculateReachedPoints($active_id, $pass);
            }
            if ($graphicalOutput) {
                // output of ok/not ok icons for user entered solutions
                if ($reached_points == $this->object->getMaximumPoints()) {
                    $template->setCurrentBlock("icon_ok");
                    $template->setVariable("ICON_OK", ilUtil::getImagePath("icon_ok.svg"));
                    $template->setVariable("TEXT_OK", $this->lng->txt("answer_is_right"));
                    $template->parseCurrentBlock();
                } else {
                    $template->setCurrentBlock("icon_ok");
                    if ($reached_points > 0) {
                        $template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_mostly_ok.svg"));
                        $template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_not_correct_but_positive"));
                    } else {
                        $template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_not_ok.svg"));
                        $template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_wrong"));
                    }
                    $template->parseCurrentBlock();
                }
            }
        } else {
            $reached_points = $this->object->getPoints();
        }
 
        if ($result_output) {
            $resulttext = ($reached_points == 1) ? "(%s " . $this->lng->txt("point") . ")" : "(%s " . $this->lng->txt("points") . ")";
            $template->setVariable("RESULT_OUTPUT", sprintf($resulttext, $reached_points));
        }
        if ($show_question_text == true) {
            $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($this->object->getQuestion(), true));
        }
        //              $template->setVariable("SOLUTION_TEXT", ilUtil::prepareFormOutput($solutionvalue));
        if ($this->object->textsize >= 10) {
            $template->setVariable("STYLE", " style=\"font-size: " . $this->object->textsize . "%;\"");
        }
 
        $questionoutput = $template->get();
        $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", true, true, "Modules/TestQuestionPool");
        $solutiontemplate->setVariable("SOLUTION_OUTPUT", $questionoutput);
 
 
        $feedback = '';
        if ($show_feedback) {
            if (!$this->isTestPresentationContext()) {
                $fb = $this->getGenericFeedbackOutput($active_id, $pass);
                $feedback .= strlen($fb) ? $fb : '';
            }
            
            $fb = $this->getSpecificFeedbackOutput(array());
            $feedback .= strlen($fb) ? $fb : '';
        }
        if (strlen($feedback)) {
            $cssClass = (
                $this->hasCorrectSolution($active_id, $pass) ?
                ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_CORRECT : ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_WRONG
            );
            
            $solutiontemplate->setVariable("ILC_FB_CSS_CLASS", $cssClass);
            $solutiontemplate->setVariable("FEEDBACK", $this->object->prepareTextareaOutput($feedback, true));
        }
        $solutionoutput = $solutiontemplate->get();
        if (!$show_question_only) {
            // get page object output
            $solutionoutput = $this->getILIASPage($solutionoutput);
        }
        return $solutionoutput;
    }

References $id, $pass, $template, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_CORRECT, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_WRONG, assQuestionGUI\getGenericFeedbackOutput(), assQuestionGUI\getILIASPage(), ilUtil\getImagePath(), getSpecificFeedbackOutput(), assQuestionGUI\getUseIntermediateSolution(), assQuestionGUI\hasCorrectSolution(), assQuestionGUI\isTestPresentationContext(), and ilUtil\prepareFormOutput().

Here is the call graph for this function:

getSpecificFeedbackOutput()

assOrderingHorizontalGUI::getSpecificFeedbackOutput

(

$userSolution

)

Returns the answer specific feedback for the question.

This method should be overwritten by the actual question.

Todo:

Mark this method abstract!

Parameters

array

$userSolution

($userSolution[<value1>] = <value2>)

Returns

string HTML Code with the answer specific feedback @access public

Reimplemented from assQuestionGUI.

Definition at line 445 of file class.assOrderingHorizontalGUI.php.

    {
        if (strpos($this->object->getOrderText(), '::')) {
            $answers = explode('::', $this->object->getOrderText());
        } else {
            $answers = explode(' ', $this->object->getOrderText());
        }
 
        if (!$this->object->feedbackOBJ->specificAnswerFeedbackExists()) {
            return '';
        }
 
        $output = '<table class="test_specific_feedback"><tbody>';
 
        foreach ($answers as $idx => $answer) {
            $feedback = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
                $this->object->getId(),
                0,
                $idx
            );
 
            $output .= "<tr><td>{$answer}</td><td>{$feedback}</td></tr>";
        }
 
        $output .= '</tbody></table>';
 
        return $this->object->prepareTextareaOutput($output, true);
    }

References Sabre\VObject\$output.

Referenced by getSolutionOutput().

Here is the caller graph for this function:

getTestOutput()

assOrderingHorizontalGUI::getTestOutput	(		$active_id,
			$pass,
			$is_postponed = false,
			$use_post_solutions = false,
			$show_feedback = false
	)

Reimplemented from assQuestionGUI.

Definition at line 287 of file class.assOrderingHorizontalGUI.php.

    {
        // generate the question output
        $template = new ilTemplate("tpl.il_as_qpl_orderinghorizontal_output.html", true, true, "Modules/TestQuestionPool");
        $elements = $this->object->getRandomOrderingElements();
        
        if ($active_id) {
            // hey: prevPassSolutions - obsolete due to central check
            #$solutions = NULL;
            #include_once "./Modules/Test/classes/class.ilObjTest.php";
            #if (!ilObjTest::_getUsePreviousAnswers($active_id, true))
            #{
            #   if (is_null($pass)) $pass = ilObjTest::_getPass($active_id);
            #}
            $solutions = $this->object->getTestOutputSolutions($active_id, $pass);
            // hey.
            if (is_array($solutions) && count($solutions) == 1) {
                $elements = explode("{::}", $solutions[0]["value1"]);
            }
        }
        if (!is_array($solutions) || count($solutions) == 0) {
            $_SESSION['qst_ordering_horizontal_elements'] = $elements;
        } else {
            unset($_SESSION['qst_ordering_horizontal_elements']);
        }
        foreach ($elements as $id => $element) {
            $template->setCurrentBlock("element");
            $template->setVariable("ELEMENT_ID", "e_" . $this->object->getId() . "_$id");
            $template->setVariable("ORDERING_VALUE", ilUtil::prepareFormOutput($element));
            $template->setVariable("ELEMENT_VALUE", ilUtil::prepareFormOutput($element));
            $template->parseCurrentBlock();
        }
        $template->setVariable("QUESTION_ID", $this->object->getId());
        if ($this->object->textsize >= 10) {
            $template->setVariable("STYLE", " style=\"font-size: " . $this->object->textsize . "%;\"");
        }
        $template->setVariable("VALUE_ORDERRESULT", ' value="' . join('{::}', $elements) . '"');
        $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($this->object->getQuestion(), true));
        $questionoutput = $template->get();
        if (!$show_question_only) {
            // get page object output
            $questionoutput = $this->getILIASPage($questionoutput);
        }
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        if ($DIC['ilBrowser']->isMobile() || $DIC['ilBrowser']->isIpad()) {
            $this->tpl->addJavaScript('./libs/bower/bower_components/jqueryui-touch-punch/jquery.ui.touch-punch.min.js');
        }
        $this->tpl->addJavascript("./Modules/TestQuestionPool/templates/default/orderinghorizontal.js");
        $questionoutput = $template->get();
        $pageoutput = $this->outQuestionPage("", $is_postponed, $active_id, $questionoutput);
        return $pageoutput;
    }

References $_SESSION, $DIC, $id, $pass, $template, assQuestionGUI\getILIASPage(), assQuestionGUI\outQuestionPage(), and ilUtil\prepareFormOutput().

Here is the call graph for this function:

populateCorrectionsFormProperties()

assOrderingHorizontalGUI::populateCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

Reimplemented from assQuestionGUI.

Definition at line 604 of file class.assOrderingHorizontalGUI.php.

    {
        // points
        $points = new ilNumberInputGUI($this->lng->txt("points"), "points");
        
        $points->allowDecimals(true);
        $points->setValue($this->object->getPoints());
        $points->setRequired(true);
        $points->setSize(3);
        $points->setMinValue(0.0);
        $points->setMinvalueShouldBeGreater(true);
        $form->addItem($points);
    }

References $form.

populateQuestionSpecificFormPart()

assOrderingHorizontalGUI::populateQuestionSpecificFormPart

(

\ilPropertyFormGUI

$form

)

Definition at line 495 of file class.assOrderingHorizontalGUI.php.

    {
        // ordertext
        $ordertext = new ilTextAreaInputGUI($this->lng->txt("ordertext"), "ordertext");
        $ordertext->setValue($this->object->prepareTextareaOutput($this->object->getOrderText()));
        $ordertext->setRequired(true);
        $ordertext->setInfo(sprintf($this->lng->txt("ordertext_info"), $this->object->separator));
        $ordertext->setRows(10);
        $ordertext->setCols(80);
        $form->addItem($ordertext);
        // textsize
        $textsize = new ilNumberInputGUI($this->lng->txt("textsize"), "textsize");
        $textsize->setValue($this->object->getTextSize());
        $textsize->setInfo($this->lng->txt("textsize_info"));
        $textsize->setSize(6);
        $textsize->setMinValue(10);
        $textsize->setRequired(false);
        $form->addItem($textsize);
        // points
        $points = new ilNumberInputGUI($this->lng->txt("points"), "points");
 
        $points->allowDecimals(true);
        // mbecker: Fix for mantis bug 7866: Predefined values schould make sense.
        // This implements a default value of "1" for this question type.
        if ($this->object->getPoints() == null) {
            $points->setValue("1");
        } else {
            $points->setValue($this->object->getPoints());
        }
        $points->setRequired(true);
        $points->setSize(3);
        $points->setMinValue(0.0);
        $points->setMinvalueShouldBeGreater(true);
        $form->addItem($points);
    }

References $form.

Referenced by editQuestion().

Here is the caller graph for this function:

renderAggregateView()

assOrderingHorizontalGUI::renderAggregateView

(

$aggregate

)

Parameters

$aggregate

Returns

ilTemplate

Definition at line 566 of file class.assOrderingHorizontalGUI.php.

    {
        $tpl = new ilTemplate('tpl.il_as_aggregated_answers_table.html', true, true, "Modules/TestQuestionPool");
 
        foreach ($aggregate as $key => $line_data) {
            $tpl->setCurrentBlock('aggregaterow');
            $tpl->setVariable('COUNT', $line_data);
            $tpl->setVariable('OPTION', $key);
            $tpl->parseCurrentBlock();
        }
        return $tpl;
    }

References $key, and assQuestionGUI\$tpl.

Referenced by getAggregatedAnswersView().

Here is the caller graph for this function:

saveCorrectionsFormProperties()

assOrderingHorizontalGUI::saveCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

Reimplemented from assQuestionGUI.

Definition at line 621 of file class.assOrderingHorizontalGUI.php.

    {
        $this->object->setPoints((float) $form->getInput('points'));
    }

References ilPropertyFormGUI\getInput().

Here is the call graph for this function:

saveFeedback()

assOrderingHorizontalGUI::saveFeedback

(

)

Saves the feedback for a single choice question.

@access public

Definition at line 346 of file class.assOrderingHorizontalGUI.php.

    {
        include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
        $errors = $this->feedback(true);
        $this->object->saveFeedbackGeneric(0, $_POST["feedback_incomplete"]);
        $this->object->saveFeedbackGeneric(1, $_POST["feedback_complete"]);
        $this->object->cleanupMediaObjectUsage();
        parent::saveFeedback();
    }

References $_POST, and $errors.

setQuestionTabs()

assOrderingHorizontalGUI::setQuestionTabs

(

)

Sets the ILIAS tabs for this question type.

@access public

Todo:

: MOVE THIS STEPS TO COMMON QUESTION CLASS assQuestionGUI

Reimplemented from assQuestionGUI.

Definition at line 363 of file class.assOrderingHorizontalGUI.php.

    {
        global $DIC;
        $rbacsystem = $DIC['rbacsystem'];
        $ilTabs = $DIC['ilTabs'];
 
        $ilTabs->clearTargets();
        
        $this->ctrl->setParameterByClass("ilAssQuestionPageGUI", "q_id", $_GET["q_id"]);
        include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
        $q_type = $this->object->getQuestionType();
 
        if (strlen($q_type)) {
            $classname = $q_type . "GUI";
            $this->ctrl->setParameterByClass(strtolower($classname), "sel_question_types", $q_type);
            $this->ctrl->setParameterByClass(strtolower($classname), "q_id", $_GET["q_id"]);
        }
 
        if ($_GET["q_id"]) {
            if ($rbacsystem->checkAccess('write', $_GET["ref_id"])) {
                // edit page
                $ilTabs->addTarget(
                    "edit_page",
                    $this->ctrl->getLinkTargetByClass("ilAssQuestionPageGUI", "edit"),
                    array("edit", "insert", "exec_pg"),
                    "",
                    "",
                    $force_active
                );
            }
 
            $this->addTab_QuestionPreview($ilTabs);
        }
 
        $force_active = false;
        if ($rbacsystem->checkAccess('write', $_GET["ref_id"])) {
            $url = "";
            if ($classname) {
                $url = $this->ctrl->getLinkTargetByClass($classname, "editQuestion");
            }
            $commands = $_POST["cmd"];
            if (is_array($commands)) {
                foreach ($commands as $key => $value) {
                    if (preg_match("/^suggestrange_.*/", $key, $matches)) {
                        $force_active = true;
                    }
                }
            }
            // edit question properties
            $ilTabs->addTarget(
                "edit_question",
                $url,
                array("editQuestion", "save", "saveEdit", "originalSyncForm"),
                $classname,
                "",
                $force_active
            );
        }
 
        // add tab for question feedback within common class assQuestionGUI
        $this->addTab_QuestionFeedback($ilTabs);
 
        // add tab for question hint within common class assQuestionGUI
        $this->addTab_QuestionHints($ilTabs);
 
        // add tab for question's suggested solution within common class assQuestionGUI
        $this->addTab_SuggestedSolution($ilTabs, $classname);
 
        // Assessment of questions sub menu entry
        if ($_GET["q_id"]) {
            $ilTabs->addTarget(
                "statistics",
                $this->ctrl->getLinkTargetByClass($classname, "assessment"),
                array("assessment"),
                $classname,
                ""
            );
        }
 
        $this->addBackTab($ilTabs);
    }

References $_GET, $_POST, $DIC, $key, $url, assQuestionGUI\addBackTab(), assQuestionGUI\addTab_QuestionFeedback(), assQuestionGUI\addTab_QuestionHints(), assQuestionGUI\addTab_QuestionPreview(), and assQuestionGUI\addTab_SuggestedSolution().

Here is the call graph for this function:

supportsIntermediateSolutionOutput()

assOrderingHorizontalGUI::supportsIntermediateSolutionOutput

(

)

Question type specific support of intermediate solution output The function getSolutionOutput respects getUseIntermediateSolution()

Returns

bool

Reimplemented from assQuestionGUI.

Definition at line 114 of file class.assOrderingHorizontalGUI.php.

    {
        return true;
    }

writePostData()

assOrderingHorizontalGUI::writePostData (   $always = false )

protected

{Evaluates a posted edit form and writes the form data in the question object.

Returns

integer A positive value, if one of the required fields wasn't set, else 0

}

Reimplemented from assQuestionGUI.

Definition at line 51 of file class.assOrderingHorizontalGUI.php.

    {
        $hasErrors = (!$always) ? $this->editQuestion(true) : false;
        if (!$hasErrors) {
            require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
            $this->writeQuestionGenericPostData();
            $this->writeQuestionSpecificPostData(new ilPropertyFormGUI());
            $this->saveTaxonomyAssignments();
            return 0;
        }
        return 1;
    }

References editQuestion(), assQuestionGUI\saveTaxonomyAssignments(), assQuestionGUI\writeQuestionGenericPostData(), and writeQuestionSpecificPostData().

Here is the call graph for this function:

writeQuestionSpecificPostData()

assOrderingHorizontalGUI::writeQuestionSpecificPostData

(

ilPropertyFormGUI

$form

)

Extracts the question specific values from $_POST and applies them to the data object.

Parameters

bool

$always

If true, a check for form validity is omitted.

Returns

void

Implements ilGuiQuestionScoringAdjustable.

Definition at line 474 of file class.assOrderingHorizontalGUI.php.

    {
        $this->object->setTextSize($_POST["textsize"]);
        $this->object->setOrderText($_POST["ordertext"]);
        $this->object->setPoints($_POST["points"]);
    }

References $_POST.

Referenced by writePostData().

Here is the caller graph for this function:

---

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

• Modules/TestQuestionPool/classes/class.assOrderingHorizontalGUI.php