Multiple choice question GUI representation. More...

Inheritance diagram for assMultipleChoiceGUI:

Collaboration diagram for assMultipleChoiceGUI:

Public Member Functions
	__construct ($id=-1)
	assMultipleChoiceGUI constructor More...

	hasInlineFeedback ()

	editQuestion ($checkonly=false)
	Creates an output of the edit form for the question. More...

	addBasicQuestionFormProperties ($form)
	Add basic question form properties: assessment: title, author, description, question, working time. More...

	uploadchoice ()
	Upload an image. More...

	removeimagechoice ()
	Remove an image. More...

	addchoice ()
	Add a new answer. More...

	removechoice ()
	Remove an answer. 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)

	isUseEmptySolutionInputChecked ()

	setUseEmptySolutionInputChecked ($useEmptySolutionInputChecked)

	populateJavascriptFilesRequiredForWorkForm (ilTemplate $tpl)

	setQuestionTabs ()
	Sets the ILIAS tabs for this question type. More...

	getChoiceKeys ()
	Create the key index numbers for the array of choices. 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...

	writeAnswerSpecificPostData (ilPropertyFormGUI $form)
	Extracts the answer specific values from $_POST and applies them to the data object. More...

	populateQuestionSpecificFormPart (\ilPropertyFormGUI $form)

	populateAnswerSpecificFormPart (\ilPropertyFormGUI $form)

	getAfterParticipationSuppressionAnswerPostVars ()
	Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment. 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...

	aggregateAnswers ($relevant_answers_chosen, $answers_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...

Public Member Functions inherited from ilGuiAnswerScoringAdjustable
	populateAnswerSpecificFormPart (ilPropertyFormGUI $form)
	Adds the answer specific form parts to a question property form gui. More...

	writeAnswerSpecificPostData (ilPropertyFormGUI $form)
	Extracts the answer specific values from $_POST and applies them to the data object. More...

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

Data Fields
	$choiceKeys

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

	getEditAnswersSingleLine ($checkonly=false)
	Get the single/multiline editing of answers. More...

	getUseUnchangedAnswerCheckboxHtml ()

	buildEditForm ()

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 ()

Protected Attributes
	$useEmptySolutionInputChecked = false

Protected Attributes inherited from assQuestionGUI
	$editForm

	$use_intermediate_solution = false

Private Member Functions
	populateSpecificFeedbackInline ($user_solution, $answer_id, $template)

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

Detailed Description

Multiple choice question GUI representation.

The assMultipleChoiceGUI class encapsulates the GUI representation for multiple choice 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_Calls assMultipleChoiceGUI: ilFormPropertyDispatchGUI

Definition at line 23 of file class.assMultipleChoiceGUI.php.

Constructor & Destructor Documentation

◆ __construct()

assMultipleChoiceGUI::__construct ( $id = -1 )

assMultipleChoiceGUI constructor

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

Parameters

integer $id The database id of a multiple choice question object @access public

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

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

References $id.

Member Function Documentation

◆ addBasicQuestionFormProperties()

assMultipleChoiceGUI::addBasicQuestionFormProperties ( $form )

Add basic question form properties: assessment: title, author, description, question, working time.

Returns: int Default Nr of Tries

Reimplemented from assQuestionGUI.

Definition at line 136 of file class.assMultipleChoiceGUI.php.

    {
        parent::addBasicQuestionFormProperties($form);
        $form->getItemByPostVar('question')->setInitialRteWidth('100');
    }

References $form.

Referenced by buildEditForm().

Here is the caller graph for this function:

◆ addchoice()

assMultipleChoiceGUI::addchoice ( )

Add a new answer.

Definition at line 167 of file class.assMultipleChoiceGUI.php.

    {
        $this->writePostData(true);
        $position = key($_POST['cmd']['addchoice']);
        $this->object->addAnswer("", 0, 0, $position + 1);
        $this->editQuestion();
    }

References $_POST, editQuestion(), and writePostData().

Here is the call graph for this function:

◆ aggregateAnswers()

assMultipleChoiceGUI::aggregateAnswers	(	$relevant_answers_chosen,
		$answers_defined_on_question
	)

Definition at line 947 of file class.assMultipleChoiceGUI.php.

    {
        $aggregate = array();
        foreach ($answers_defined_on_question as $answer) {
            $aggregated_info_for_answer = array();
            $aggregated_info_for_answer['answertext'] = $answer->getAnswerText();
            $aggregated_info_for_answer['count_checked'] = 0;
 
            foreach ($relevant_answers_chosen as $relevant_answer) {
                if ($relevant_answer['value1'] == $answer->getOrder()) {
                    $aggregated_info_for_answer['count_checked']++;
                }
            }
            $aggregated_info_for_answer['count_unchecked'] =
                ceil(count($relevant_answers_chosen) / count($answers_defined_on_question))
                - $aggregated_info_for_answer['count_checked'];
 
            $aggregate[] = $aggregated_info_for_answer;
        }
        return $aggregate;
    }

Referenced by getAggregatedAnswersView(), and getAnswersFrequency().

Here is the caller graph for this function:

◆ buildEditForm()

assMultipleChoiceGUI::buildEditForm ( )

protected

Returns: ilPropertyFormGUI

Reimplemented from assQuestionGUI.

Definition at line 1046 of file class.assMultipleChoiceGUI.php.

    {
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->outQuestionType());
        $form->setTableWidth("100%");
        $form->setId("assmultiplechoice");
        
        // title, author, description, question, working time (assessment mode)
        $this->addBasicQuestionFormProperties($form);
        $this->populateQuestionSpecificFormPart($form);
        $this->populateAnswerSpecificFormPart($form);
        $this->populateTaxonomyFormSection($form);
        $this->addQuestionFormCommandButtons($form);
        return $form;
    }

References $form, addBasicQuestionFormProperties(), assQuestionGUI\addQuestionFormCommandButtons(), assQuestionGUI\outQuestionType(), populateAnswerSpecificFormPart(), populateQuestionSpecificFormPart(), and assQuestionGUI\populateTaxonomyFormSection().

Referenced by editQuestion(), and writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editQuestion()

assMultipleChoiceGUI::editQuestion ( $checkonly = false )

Creates an output of the edit form for the question.

Parameters

bool $checkonly

Returns: bool

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

    {
        $save = $this->isSaveCommand();
        $this->getQuestionTemplate();
        
        $form = $this->buildEditForm();
 
        $isSingleline = $this->getEditAnswersSingleLine($checkonly);
        if ($isSingleline) {
            $form->setMultipart(true);
        } else {
            $form->setMultipart(false);
        }
 
        $errors = false;
 
        if ($save) {
            $form->getItemByPostVar('selection_limit')->setMaxValue(count((array) $_POST['choice']['answer']));
 
            $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 $_POST, $errors, $form, buildEditForm(), getEditAnswersSingleLine(), assQuestionGUI\getQuestionTemplate(), and assQuestionGUI\isSaveCommand().

Referenced by addchoice(), removechoice(), removeimagechoice(), uploadchoice(), and writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAfterParticipationSuppressionAnswerPostVars()

assMultipleChoiceGUI::getAfterParticipationSuppressionAnswerPostVars ( )

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 ilGuiAnswerScoringAdjustable.

Definition at line 913 of file class.assMultipleChoiceGUI.php.

    {
        return array();
    }

◆ getAfterParticipationSuppressionQuestionPostVars()

assMultipleChoiceGUI::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 927 of file class.assMultipleChoiceGUI.php.

    {
        return array();
    }

◆ getAggregatedAnswersView()

assMultipleChoiceGUI::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 940 of file class.assMultipleChoiceGUI.php.

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

References aggregateAnswers(), and renderAggregateView().

Here is the call graph for this function:

◆ getAnswersFrequency()

assMultipleChoiceGUI::getAnswersFrequency	(	$relevantAnswers,
		$questionIndex
	)

Reimplemented from assQuestionGUI.

Definition at line 1064 of file class.assMultipleChoiceGUI.php.

    {
        $agg = $this->aggregateAnswers($relevantAnswers, $this->object->getAnswers());
        
        $answers = array();
        
        foreach ($agg as $ans) {
            $answers[] = array(
                'answer' => $ans['answertext'],
                'frequency' => $ans['count_checked']
            );
        }
        
        return $answers;
    }

References aggregateAnswers().

Here is the call graph for this function:

◆ getChoiceKeys()

assMultipleChoiceGUI::getChoiceKeys ( )

Create the key index numbers for the array of choices.

Returns: array

Definition at line 744 of file class.assMultipleChoiceGUI.php.

    {
        $choiceKeys = array_keys($this->object->answers);
 
        if ($this->object->getShuffle()) {
            $choiceKeys = $this->object->getShuffler()->shuffle($choiceKeys);
        }
 
        return $choiceKeys;
    }

References $choiceKeys.

Referenced by getPreview(), getSolutionOutput(), and getTestOutput().

Here is the caller graph for this function:

◆ getEditAnswersSingleLine()

assMultipleChoiceGUI::getEditAnswersSingleLine ( $checkonly = false )

protected

Get the single/multiline editing of answers.

The settings of an already saved question is preferred
A new question will use the setting of the last edited question by the user
Parameters

bool $checkonly get the setting for checking a POST

Returns
bool

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

    {
        if ($checkonly) {
            // form posting is checked
            return ($_POST['types'] == 0) ? true : false;
        }
 
        $lastChange = $this->object->getLastChange();
        if (empty($lastChange) && !isset($_POST['types'])) {
            // a new question is edited
            return $this->object->getMultilineAnswerSetting() ? false : true;
        } else {
            // a saved question is edited
            return $this->object->isSingleline;
        }
    }

References $_POST.

Referenced by editQuestion(), populateAnswerSpecificFormPart(), and populateQuestionSpecificFormPart().

Here is the caller graph for this function:

◆ getPreview()

assMultipleChoiceGUI::getPreview	(	$show_question_only = `false`,
		$showInlineFeedback = `false`
	)

Reimplemented from assQuestionGUI.

Definition at line 419 of file class.assMultipleChoiceGUI.php.

    {
        $user_solution = is_object($this->getPreviewSession()) ? (array) $this->getPreviewSession()->getParticipantsSolution() : array();
        // shuffle output
        $keys = $this->getChoiceKeys();
 
        // generate the question output
        include_once "./Services/UICore/classes/class.ilTemplate.php";
        $template = new ilTemplate("tpl.il_as_qpl_mc_mr_output.html", true, true, "Modules/TestQuestionPool");
        foreach ($keys as $answer_id) {
            $answer = $this->object->answers[$answer_id];
            if (strlen($answer->getImage())) {
                if ($this->object->getThumbSize()) {
                    $template->setCurrentBlock("preview");
                    $template->setVariable("URL_PREVIEW", $this->object->getImagePathWeb() . $answer->getImage());
                    $template->setVariable("TEXT_PREVIEW", $this->lng->txt('preview'));
                    $template->setVariable("IMG_PREVIEW", ilUtil::getImagePath('enlarge.svg'));
                    $template->setVariable("ANSWER_IMAGE_URL", $this->object->getImagePathWeb() . $this->object->getThumbPrefix() . $answer->getImage());
                    list($width, $height, $type, $attr) = getimagesize($this->object->getImagePath() . $answer->getImage());
                    $alt = $answer->getImage();
                    if (strlen($answer->getAnswertext())) {
                        $alt = $answer->getAnswertext();
                    }
                    $alt = preg_replace("/<[^>]*?>/", "", $alt);
                    $template->setVariable("ANSWER_IMAGE_ALT", ilUtil::prepareFormOutput($alt));
                    $template->setVariable("ANSWER_IMAGE_TITLE", ilUtil::prepareFormOutput($alt));
                    $template->parseCurrentBlock();
                } else {
                    $template->setCurrentBlock("answer_image");
                    $template->setVariable("ANSWER_IMAGE_URL", $this->object->getImagePathWeb() . $answer->getImage());
                    list($width, $height, $type, $attr) = getimagesize($this->object->getImagePath() . $answer->getImage());
                    $alt = $answer->getImage();
                    if (strlen($answer->getAnswertext())) {
                        $alt = $answer->getAnswertext();
                    }
                    $alt = preg_replace("/<[^>]*?>/", "", $alt);
                    $template->setVariable("ATTR", $attr);
                    $template->setVariable("ANSWER_IMAGE_ALT", ilUtil::prepareFormOutput($alt));
                    $template->setVariable("ANSWER_IMAGE_TITLE", ilUtil::prepareFormOutput($alt));
                    $template->parseCurrentBlock();
                }
            }
 
            if ($showInlineFeedback) {
                $this->populateSpecificFeedbackInline($user_solution, $answer_id, $template);
            }
            
            $template->setCurrentBlock("answer_row");
            $template->setVariable("QID", $this->object->getId());
            $template->setVariable("ANSWER_ID", $answer_id);
            $template->setVariable("ANSWER_TEXT", $this->object->prepareTextareaOutput($answer->getAnswertext(), true));
            foreach ($user_solution as $mc_solution) {
                if (strcmp($mc_solution, $answer_id) == 0) {
                    $template->setVariable("CHECKED_ANSWER", " checked=\"checked\"");
                }
            }
            $template->parseCurrentBlock();
        }
        if ($this->object->getSelectionLimit()) {
            $template->setVariable('SELECTION_LIMIT_HINT', sprintf(
                $this->lng->txt('ass_mc_sel_lim_hint'),
                $this->object->getSelectionLimit(),
                $this->object->getAnswerCount()
            ));
            
            $template->setVariable('SELECTION_LIMIT_VALUE', $this->object->getSelectionLimit());
        } else {
            $template->setVariable('SELECTION_LIMIT_VALUE', 'null');
        }
        $template->setVariable("QUESTION_ID", $this->object->getId());
        $questiontext = $this->object->getQuestion();
        $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, true));
        $questionoutput = $template->get();
        if (!$show_question_only) {
            // get page object output
            $questionoutput = $this->getILIASPage($questionoutput);
        }
        return $questionoutput;
    }

References $keys, $template, $type, getChoiceKeys(), assQuestionGUI\getILIASPage(), ilUtil\getImagePath(), assQuestionGUI\getPreviewSession(), populateSpecificFeedbackInline(), and ilUtil\prepareFormOutput().

Here is the call graph for this function:

◆ getSolutionOutput()

assMultipleChoiceGUI::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
bool	$show_question_text

Returns: string The solution output of the question as HTML code

Reimplemented from assQuestionGUI.

Definition at line 211 of file class.assMultipleChoiceGUI.php.

      {
        // shuffle output
        $keys = $this->getChoiceKeys();
 
        // get the solution of the user for the active pass or from the last pass if allowed
        $user_solution = array();
        if (($active_id > 0) && (!$show_correct_solution)) {
            $solutions = $this->object->getSolutionValues($active_id, $pass, !$this->getUseIntermediateSolution());
            foreach ($solutions as $idx => $solution_value) {
                array_push($user_solution, $solution_value["value1"]);
            }
        } else {
            // take the correct solution instead of the user solution
            foreach ($this->object->answers as $index => $answer) {
                $points_checked = $answer->getPointsChecked();
                $points_unchecked = $answer->getPointsUnchecked();
                if ($points_checked > $points_unchecked) {
                    if ($points_checked > 0) {
                        array_push($user_solution, $index);
                    }
                }
            }
        }
        
        // generate the question output
        include_once "./Services/UICore/classes/class.ilTemplate.php";
        $template = new ilTemplate("tpl.il_as_qpl_mc_mr_output_solution.html", true, true, "Modules/TestQuestionPool");
        $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", true, true, "Modules/TestQuestionPool");
        foreach ($keys as $answer_id) {
            $answer = $this->object->answers[$answer_id];
            if (($active_id > 0) && (!$show_correct_solution)) {
                if ($graphicalOutput) {
                    // output of ok/not ok icons for user entered solutions
                    $ok = false;
                    $checked = false;
                    foreach ($user_solution as $mc_solution) {
                        if (strcmp($mc_solution, $answer_id) == 0) {
                            $checked = true;
                        }
                    }
                    if ($checked) {
                        if ($answer->getPointsChecked() > $answer->getPointsUnchecked()) {
                            $ok = true;
                        } else {
                            $ok = false;
                        }
                    } else {
                        if ($answer->getPointsChecked() > $answer->getPointsUnchecked()) {
                            $ok = false;
                        } else {
                            $ok = true;
                        }
                    }
                    if ($ok) {
                        $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");
                        $template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_not_ok.svg"));
                        $template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_wrong"));
                        $template->parseCurrentBlock();
                    }
                }
            }
            if (strlen($answer->getImage())) {
                $template->setCurrentBlock("answer_image");
                if ($this->object->getThumbSize()) {
                    $template->setVariable("ANSWER_IMAGE_URL", $this->object->getImagePathWeb() . $this->object->getThumbPrefix() . $answer->getImage());
                } else {
                    $template->setVariable("ANSWER_IMAGE_URL", $this->object->getImagePathWeb() . $answer->getImage());
                }
                $alt = $answer->getImage();
                if (strlen($answer->getAnswertext())) {
                    $alt = $answer->getAnswertext();
                }
                $alt = preg_replace("/<[^>]*?>/", "", $alt);
                $template->setVariable("ANSWER_IMAGE_ALT", ilUtil::prepareFormOutput($alt));
                $template->setVariable("ANSWER_IMAGE_TITLE", ilUtil::prepareFormOutput($alt));
                $template->parseCurrentBlock();
            }
        
            if ($show_feedback) {
                if ($this->object->getSpecificFeedbackSetting() == 2) {
                    foreach ($user_solution as $mc_solution) {
                        if (strcmp($mc_solution, $answer_id) == 0) {
                            $fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
                                $this->object->getId(),
                                0,
                                $answer_id
                            );
                            if (strlen($fb)) {
                                $template->setCurrentBlock("feedback");
                                $template->setVariable("FEEDBACK", $this->object->prepareTextareaOutput($fb, true));
                                $template->parseCurrentBlock();
                            }
                        }
                    }
                }
                
                if ($this->object->getSpecificFeedbackSetting() == 1) {
                    $fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
                        $this->object->getId(),
                        0,
                        $answer_id
                    );
                    if (strlen($fb)) {
                        $template->setCurrentBlock("feedback");
                        $template->setVariable("FEEDBACK", $this->object->prepareTextareaOutput($fb, true));
                        $template->parseCurrentBlock();
                    }
                }
                
                if ($this->object->getSpecificFeedbackSetting() == 3) {
                    $answer = $this->object->getAnswer($answer_id);
                    
                    if ($answer->getPoints() > 0) {
                        $fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
                            $this->object->getId(),
                            0,
                            $answer_id
                        );
                        if (strlen($fb)) {
                            $template->setCurrentBlock("feedback");
                            $template->setVariable("FEEDBACK", $this->object->prepareTextareaOutput($fb, true));
                            $template->parseCurrentBlock();
                        }
                    }
                }
            }
            $template->setCurrentBlock("answer_row");
            $template->setVariable("ANSWER_TEXT", $this->object->prepareTextareaOutput($answer->getAnswertext(), true));
            $checked = false;
            if ($result_output) {
                $pointschecked = $this->object->answers[$answer_id]->getPointsChecked();
                $pointsunchecked = $this->object->answers[$answer_id]->getPointsUnchecked();
                $resulttextchecked = ($pointschecked == 1) || ($pointschecked == -1) ? "%s " . $this->lng->txt("point") : "%s " . $this->lng->txt("points");
                $resulttextunchecked = ($pointsunchecked == 1) || ($pointsunchecked == -1) ? "%s " . $this->lng->txt("point") : "%s " . $this->lng->txt("points");
                $template->setVariable("RESULT_OUTPUT", sprintf("(" . $this->lng->txt("checkbox_checked") . " = $resulttextchecked, " . $this->lng->txt("checkbox_unchecked") . " = $resulttextunchecked)", $pointschecked, $pointsunchecked));
            }
            foreach ($user_solution as $mc_solution) {
                if (strcmp($mc_solution, $answer_id) == 0) {
                    if ($this->renderPurposeSupportsFormHtml() || $this->isRenderPurposePrintPdf()) {
                        $template->setVariable("SOLUTION_IMAGE", ilUtil::getHtmlPath(ilUtil::getImagePath("checkbox_checked.png")));
                        $template->setVariable("SOLUTION_ALT", $this->lng->txt("checked"));
                    } else {
                        $template->setVariable('QID', $this->object->getId());
                        $template->setVariable('SUFFIX', $show_correct_solution ? 'bestsolution' : 'usersolution');
                        $template->setVariable('SOLUTION_VALUE', $answer_id);
                        $template->setVariable('SOLUTION_CHECKED', 'checked');
                    }
                    $checked = true;
                }
            }
            if (!$checked) {
                if ($this->renderPurposeSupportsFormHtml() || $this->isRenderPurposePrintPdf()) {
                    $template->setVariable("SOLUTION_IMAGE", ilUtil::getHtmlPath(ilUtil::getImagePath("checkbox_unchecked.png")));
                    $template->setVariable("SOLUTION_ALT", $this->lng->txt("unchecked"));
                } else {
                    $template->setVariable('QID', $this->object->getId());
                    $template->setVariable('SUFFIX', $show_correct_solution ? 'bestsolution' : 'usersolution');
                    $template->setVariable('SOLUTION_VALUE', $answer_id);
                }
            }
            $template->parseCurrentBlock();
        }
        $questiontext = $this->object->getQuestion();
        if ($show_question_text == true) {
            $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, true));
        }
        $questionoutput = $template->get();
        $feedback = ($show_feedback && !$this->isTestPresentationContext()) ? $this->getAnswerFeedbackOutput($active_id, $pass) : "";
        
        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));
        }
        $solutiontemplate->setVariable("SOLUTION_OUTPUT", $questionoutput);
 
        $solutionoutput = $solutiontemplate->get();
        
        if ($show_feedback && $this->hasInlineFeedback()) {
            $solutionoutput = $this->buildFocusAnchorHtml() . $solutionoutput;
        }
        
        if (!$show_question_only) {
            // get page object output
            $solutionoutput = $this->getILIASPage($solutionoutput);
        }
        return $solutionoutput;
    }

References $index, $keys, $ok, $pass, $template, assQuestionGUI\buildFocusAnchorHtml(), ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_CORRECT, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_WRONG, assQuestionGUI\getAnswerFeedbackOutput(), getChoiceKeys(), ilUtil\getHtmlPath(), assQuestionGUI\getILIASPage(), ilUtil\getImagePath(), assQuestionGUI\getUseIntermediateSolution(), assQuestionGUI\hasCorrectSolution(), hasInlineFeedback(), assQuestionGUI\isRenderPurposePrintPdf(), assQuestionGUI\isTestPresentationContext(), ilUtil\prepareFormOutput(), and assQuestionGUI\renderPurposeSupportsFormHtml().

Here is the call graph for this function:

◆ getSpecificFeedbackOutput()

assMultipleChoiceGUI::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 755 of file class.assMultipleChoiceGUI.php.

    {
        // No return value, this question type supports inline specific feedback.
        $output = "";
        return $this->object->prepareTextareaOutput($output, true);
    }

References Sabre\VObject\$output.

◆ getTestOutput()

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

Parameters

integer	$active_id
integer \| null	$pass
bool	$is_postponed
bool	$use_post_solutions
bool	$show_feedback

Returns: string

Reimplemented from assQuestionGUI.

Definition at line 508 of file class.assMultipleChoiceGUI.php.

      {
        // shuffle output
        $keys = $this->getChoiceKeys();
 
        // get the solution of the user for the active pass or from the last pass if allowed
        $user_solution = array();
        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.
            foreach ($solutions as $idx => $solution_value) {
                // fau: testNav - don't add the dummy entry for 'none of the above' to the user options
                if ($solution_value["value1"] == 'mc_none_above') {
                    $this->setUseEmptySolutionInputChecked(true);
                    continue;
                }
                
                $user_solution[] = $solution_value["value1"];
                // fau.
            }
            
            if (empty($user_solution) && $this->object->getTestPresentationConfig()->isWorkedThrough()) {
                $this->setUseEmptySolutionInputChecked(true);
            }
        }
        // generate the question output
        $this->tpl->addJavaScript('Modules/TestQuestionPool/js/ilAssMultipleChoice.js');
        include_once "./Services/UICore/classes/class.ilTemplate.php";
        $template = new ilTemplate("tpl.il_as_qpl_mc_mr_output.html", true, true, "Modules/TestQuestionPool");
        foreach ($keys as $answer_id) {
            $answer = $this->object->answers[$answer_id];
            if (strlen($answer->getImage())) {
                if ($this->object->getThumbSize()) {
                    $template->setCurrentBlock("preview");
                    $template->setVariable("URL_PREVIEW", $this->object->getImagePathWeb() . $answer->getImage());
                    $template->setVariable("TEXT_PREVIEW", $this->lng->txt('preview'));
                    $template->setVariable("IMG_PREVIEW", ilUtil::getImagePath('enlarge.svg'));
                    $template->setVariable("ANSWER_IMAGE_URL", $this->object->getImagePathWeb() . $this->object->getThumbPrefix() . $answer->getImage());
                    list($width, $height, $type, $attr) = getimagesize($this->object->getImagePath() . $answer->getImage());
                    $alt = $answer->getImage();
                    if (strlen($answer->getAnswertext())) {
                        $alt = $answer->getAnswertext();
                    }
                    $alt = preg_replace("/<[^>]*?>/", "", $alt);
                    $template->setVariable("ANSWER_IMAGE_ALT", ilUtil::prepareFormOutput($alt));
                    $template->setVariable("ANSWER_IMAGE_TITLE", ilUtil::prepareFormOutput($alt));
                    $template->parseCurrentBlock();
                } else {
                    $template->setCurrentBlock("answer_image");
                    $template->setVariable("ANSWER_IMAGE_URL", $this->object->getImagePathWeb() . $answer->getImage());
                    list($width, $height, $type, $attr) = getimagesize($this->object->getImagePath() . $answer->getImage());
                    $alt = $answer->getImage();
                    if (strlen($answer->getAnswertext())) {
                        $alt = $answer->getAnswertext();
                    }
                    $alt = preg_replace("/<[^>]*?>/", "", $alt);
                    $template->setVariable("ATTR", $attr);
                    $template->setVariable("ANSWER_IMAGE_ALT", ilUtil::prepareFormOutput($alt));
                    $template->setVariable("ANSWER_IMAGE_TITLE", ilUtil::prepareFormOutput($alt));
                    $template->parseCurrentBlock();
                }
            }
            
            if ($show_feedback) {
                $this->populateSpecificFeedbackInline($user_solution, $answer_id, $template);
            }
 
            $template->setCurrentBlock("answer_row");
            $template->setVariable("QID", $this->object->getId());
            $template->setVariable("ANSWER_ID", $answer_id);
            $template->setVariable("ANSWER_TEXT", $this->object->prepareTextareaOutput($answer->getAnswertext(), true));
            foreach ($user_solution as $mc_solution) {
                if (strcmp($mc_solution, $answer_id) == 0) {
                    $template->setVariable("CHECKED_ANSWER", " checked=\"checked\"");
                }
            }
            $template->parseCurrentBlock();
        }
            
        $questiontext = $this->object->getQuestion();
        $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, true));
        $template->setVariable("QUESTION_ID", $this->object->getId());
        if ($this->object->getSelectionLimit()) {
            $template->setVariable('SELECTION_LIMIT_HINT', sprintf(
                $this->lng->txt('ass_mc_sel_lim_hint'),
                $this->object->getSelectionLimit(),
                $this->object->getAnswerCount()
            ));
            
            $template->setVariable('SELECTION_LIMIT_VALUE', $this->object->getSelectionLimit());
        } else {
            $template->setVariable('SELECTION_LIMIT_VALUE', 'null');
        }
        $questionoutput = $template->get();
        $pageoutput = $this->outQuestionPage("", $is_postponed, $active_id, $questionoutput, $show_feedback);
        return $pageoutput;
    }

References $keys, $pass, $template, $type, getChoiceKeys(), ilUtil\getImagePath(), assQuestionGUI\outQuestionPage(), populateSpecificFeedbackInline(), ilUtil\prepareFormOutput(), and setUseEmptySolutionInputChecked().

Here is the call graph for this function:

◆ getUseUnchangedAnswerCheckboxHtml()

assMultipleChoiceGUI::getUseUnchangedAnswerCheckboxHtml ( )

protected

Reimplemented from assQuestionGUI.

Definition at line 632 of file class.assMultipleChoiceGUI.php.

    {
        // hey: prevPassSolutions - use abstracted template to share with other purposes of this kind
        $this->tpl->addJavaScript('Modules/TestQuestionPool/js/ilAssMultipleChoice.js');
        
        $tpl = new ilTemplate('tpl.tst_question_additional_behaviour_checkbox.html', true, true, 'Modules/TestQuestionPool');
        
        // HEY: affects next if (!) /// noneAboveChecked repaired but disabled because the checked input ..
        if (false) { // .. makes the qstEditController initialize the "edit" instead of the "answered" state
        if ($this->isUseEmptySolutionInputChecked()) {
            $tpl->setCurrentBlock('checked');
            $tpl->touchBlock('checked');
            $tpl->parseCurrentBlock();
        }
        }
        
        $tpl->setCurrentBlock('checkbox');
        $tpl->setVariable('TXT_FORCE_FORM_DIFF_LABEL', $this->object->getTestPresentationConfig()->getUseUnchangedAnswerLabel());
        $tpl->parseCurrentBlock();
        // hey.
        return $tpl->get();
    }

References assQuestionGUI\$tpl, and isUseEmptySolutionInputChecked().

Here is the call graph for this function:

◆ hasInlineFeedback()

assMultipleChoiceGUI::hasInlineFeedback ( )

Returns: bool

Reimplemented from assQuestionGUI.

Definition at line 48 of file class.assMultipleChoiceGUI.php.

    {
        return $this->object->feedbackOBJ->isSpecificAnswerFeedbackAvailable($this->object->getId());
    }

Referenced by getSolutionOutput().

Here is the caller graph for this function:

◆ isUseEmptySolutionInputChecked()

assMultipleChoiceGUI::isUseEmptySolutionInputChecked ( )

Definition at line 622 of file class.assMultipleChoiceGUI.php.

    {
        return $this->useEmptySolutionInputChecked;
    }

References $useEmptySolutionInputChecked.

Referenced by getUseUnchangedAnswerCheckboxHtml().

Here is the caller graph for this function:

◆ populateAnswerSpecificFormPart()

assMultipleChoiceGUI::populateAnswerSpecificFormPart ( \ilPropertyFormGUI $form )

Definition at line 883 of file class.assMultipleChoiceGUI.php.

    {
        // Choices
        include_once "./Modules/TestQuestionPool/classes/class.ilMultipleChoiceWizardInputGUI.php";
        $choices = new ilMultipleChoiceWizardInputGUI($this->lng->txt("answers"), "choice");
        $choices->setRequired(true);
        $choices->setQuestionObject($this->object);
        $isSingleline = $this->getEditAnswersSingleLine();
        $choices->setSingleline($isSingleline);
        $choices->setAllowMove(false);
        if ($this->object->getSelfAssessmentEditingMode()) {
            $choices->setSize(40);
        }
        $choices->setMaxLength(800);
        if ($this->object->getAnswerCount() == 0) {
            $this->object->addAnswer("", 0, 0, 0);
        }
        $choices->setValues($this->object->getAnswers());
        $form->addItem($choices);
    }

References $form, and getEditAnswersSingleLine().

Referenced by buildEditForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateCorrectionsFormProperties()

assMultipleChoiceGUI::populateCorrectionsFormProperties ( ilPropertyFormGUI $form )

Parameters

ilPropertyFormGUI $form

Reimplemented from assQuestionGUI.

Definition at line 1080 of file class.assMultipleChoiceGUI.php.

    {
        require_once 'Modules/TestQuestionPool/classes/forms/class.ilAssMultipleChoiceCorrectionsInputGUI.php';
        $choices = new ilAssMultipleChoiceCorrectionsInputGUI($this->lng->txt("answers"), "choice");
        $choices->setRequired(true);
        $choices->setQuestionObject($this->object);
        $choices->setValues($this->object->getAnswers());
        $form->addItem($choices);
    }

References $form.

◆ populateJavascriptFilesRequiredForWorkForm()

assMultipleChoiceGUI::populateJavascriptFilesRequiredForWorkForm ( ilTemplate $tpl )

Reimplemented from assQuestionGUI.

Definition at line 655 of file class.assMultipleChoiceGUI.php.

    {
        $tpl->addJavaScript('Modules/TestQuestionPool/js/ilAssMultipleChoice.js');
    }

References assQuestionGUI\$tpl.

◆ populateQuestionSpecificFormPart()

assMultipleChoiceGUI::populateQuestionSpecificFormPart ( \ilPropertyFormGUI $form )

Definition at line 823 of file class.assMultipleChoiceGUI.php.

    {
        // shuffle
        $shuffle = new ilCheckboxInputGUI($this->lng->txt("shuffle_answers"), "shuffle");
        $shuffle->setValue(1);
        $shuffle->setChecked($this->object->getShuffle());
        $shuffle->setRequired(false);
        $form->addItem($shuffle);
 
        require_once 'Services/Form/classes/class.ilNumberInputGUI.php';
        $selLim = new ilNumberInputGUI($this->lng->txt('ass_mc_sel_lim_setting'), 'selection_limit');
        $selLim->setInfo($this->lng->txt('ass_mc_sel_lim_setting_desc'));
        $selLim->setSize(2);
        $selLim->setRequired(false);
        $selLim->allowDecimals(false);
        $selLim->setMinvalueShouldBeGreater(false);
        $selLim->setMaxvalueShouldBeLess(false);
        $selLim->setMinValue(1);
        $selLim->setMaxValue($this->object->getAnswerCount());
        $selLim->setValue($this->object->getSelectionLimit());
        $form->addItem($selLim);
        
        if ($this->object->getId()) {
            $hidden = new ilHiddenInputGUI("", "ID");
            $hidden->setValue($this->object->getId());
            $form->addItem($hidden);
        }
 
        $isSingleline = $this->getEditAnswersSingleLine();
 
        if (!$this->object->getSelfAssessmentEditingMode()) {
            // Answer types
            $types = new ilSelectInputGUI($this->lng->txt("answer_types"), "types");
            $types->setRequired(false);
            $types->setValue(($isSingleline) ? 0 : 1);
            $types->setOptions(
                array(
                                    0 => $this->lng->txt('answers_singleline'),
                                    1 => $this->lng->txt('answers_multiline'),
                                )
            );
            $form->addItem($types);
        }
 
        if ($isSingleline) {
            // thumb size
            $thumb_size = new ilNumberInputGUI($this->lng->txt("thumb_size"), "thumb_size");
            $thumb_size->setSuffix($this->lng->txt("thumb_size_unit_pixel"));
            $thumb_size->setMinValue(20);
            $thumb_size->setDecimals(0);
            $thumb_size->setSize(6);
            $thumb_size->setInfo($this->lng->txt('thumb_size_info'));
            $thumb_size->setValue($this->object->getThumbSize());
            $thumb_size->setRequired(false);
            $form->addItem($thumb_size);
            return $isSingleline;
        }
        return $isSingleline;
    }

References $form, and getEditAnswersSingleLine().

Referenced by buildEditForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateSpecificFeedbackInline()

assMultipleChoiceGUI::populateSpecificFeedbackInline	(	$user_solution,
		$answer_id,
		$template
	)

private

Parameters

$user_solution
$answer_id
$template

Returns: array

Definition at line 1001 of file class.assMultipleChoiceGUI.php.

    {
        if ($this->object->getSpecificFeedbackSetting() == 2) {
            foreach ($user_solution as $mc_solution) {
                if (strcmp($mc_solution, $answer_id) == 0) {
                    $fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation($this->object->getId(), 0, $answer_id);
                    if (strlen($fb)) {
                        $template->setCurrentBlock("feedback");
                        $template->setVariable("FEEDBACK", $this->object->prepareTextareaOutput($fb, true));
                        $template->parseCurrentBlock();
                    }
                }
            }
        }
 
        if ($this->object->getSpecificFeedbackSetting() == 1) {
            $fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation($this->object->getId(), 0, $answer_id);
            if (strlen($fb)) {
                $template->setCurrentBlock("feedback");
                $template->setVariable("FEEDBACK", $this->object->prepareTextareaOutput($fb, true));
                $template->parseCurrentBlock();
            }
        }
 
        if ($this->object->getSpecificFeedbackSetting() == 3) {
            $answer = $this->object->getAnswer($answer_id);
 
            if ($answer->getPoints() > 0) {
                $fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation($this->object->getId(), 0, $answer_id);
                if (strlen($fb)) {
                    $template->setCurrentBlock("feedback");
                    $template->setVariable("FEEDBACK", $this->object->prepareTextareaOutput($fb, true));
                    $template->parseCurrentBlock();
                }
            }
        }
    }

References $template.

Referenced by getPreview(), and getTestOutput().

Here is the caller graph for this function:

◆ removechoice()

assMultipleChoiceGUI::removechoice ( )

Remove an answer.

Definition at line 178 of file class.assMultipleChoiceGUI.php.

    {
        $this->writePostData(true);
        $position = key($_POST['cmd']['removechoice']);
        $this->object->deleteAnswer($position);
        $this->editQuestion();
    }

References $_POST, editQuestion(), and writePostData().

Here is the call graph for this function:

◆ removeimagechoice()

assMultipleChoiceGUI::removeimagechoice ( )

Remove an image.

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

    {
        $this->writePostData(true);
        $position = key($_POST['cmd']['removeimagechoice']);
        $filename = $_POST['choice']['imagename'][$position];
        $this->object->removeAnswerImage($position);
        $this->editQuestion();
    }

References $_POST, $filename, editQuestion(), and writePostData().

Here is the call graph for this function:

◆ renderAggregateView()

assMultipleChoiceGUI::renderAggregateView ( $aggregate )

Parameters

$aggregate

Returns: ilTemplate

Definition at line 974 of file class.assMultipleChoiceGUI.php.

    {
        $tpl = new ilTemplate('tpl.il_as_aggregated_answers_table.html', true, true, "Modules/TestQuestionPool");
        
        $tpl->setCurrentBlock('headercell');
        $tpl->setVariable('HEADER', $this->lng->txt('tst_answer_aggr_answer_header'));
        $tpl->parseCurrentBlock();
        
        $tpl->setCurrentBlock('headercell');
        $tpl->setVariable('HEADER', $this->lng->txt('tst_answer_aggr_frequency_header'));
        $tpl->parseCurrentBlock();
 
        foreach ($aggregate as $line_data) {
            $tpl->setCurrentBlock('aggregaterow');
            $tpl->setVariable('OPTION', $line_data['answertext']);
            $tpl->setVariable('COUNT', $line_data['count_checked']);
            $tpl->parseCurrentBlock();
        }
        return $tpl;
    }

References assQuestionGUI\$tpl.

Referenced by getAggregatedAnswersView().

Here is the caller graph for this function:

◆ saveCorrectionsFormProperties()

assMultipleChoiceGUI::saveCorrectionsFormProperties ( ilPropertyFormGUI $form )

Parameters

ilPropertyFormGUI $form

Reimplemented from assQuestionGUI.

Definition at line 1093 of file class.assMultipleChoiceGUI.php.

    {
        $pointsChecked = $form->getInput('choice')['points'];
        $pointsUnchecked = $form->getInput('choice')['points_unchecked'];
        
        foreach ($this->object->getAnswers() as $index => $answer) {
            /* @var ASS_AnswerMultipleResponseImage $answer */
            $answer->setPointsChecked((float) $pointsChecked[$index]);
            $answer->setPointsUnchecked((float) $pointsUnchecked[$index]);
        }
    }

References $form, and $index.

◆ setQuestionTabs()

assMultipleChoiceGUI::setQuestionTabs ( )

Sets the ILIAS tabs for this question type.

Todo:: : MOVE THIS STEPS TO COMMON QUESTION CLASS assQuestionGUI

Reimplemented from assQuestionGUI.

Definition at line 665 of file class.assMultipleChoiceGUI.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");
            }
            $force_active = false;
            // edit question properties
            $ilTabs->addTarget(
                "edit_question",
                $url,
                array("editQuestion", "save", "saveEdit", "addchoice", "removechoice", "removeimagechoice", "uploadchoice", "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, $DIC, $url, assQuestionGUI\addBackTab(), assQuestionGUI\addTab_QuestionFeedback(), assQuestionGUI\addTab_QuestionHints(), assQuestionGUI\addTab_QuestionPreview(), and assQuestionGUI\addTab_SuggestedSolution().

Here is the call graph for this function:

◆ setUseEmptySolutionInputChecked()

assMultipleChoiceGUI::setUseEmptySolutionInputChecked ( $useEmptySolutionInputChecked )

Definition at line 627 of file class.assMultipleChoiceGUI.php.

    {
        $this->useEmptySolutionInputChecked = $useEmptySolutionInputChecked;
    }

References $useEmptySolutionInputChecked.

Referenced by getTestOutput().

Here is the caller graph for this function:

◆ supportsIntermediateSolutionOutput()

assMultipleChoiceGUI::supportsIntermediateSolutionOutput ( )

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

Returns: bool

Reimplemented from assQuestionGUI.

Definition at line 191 of file class.assMultipleChoiceGUI.php.

    {
        return true;
    }

◆ uploadchoice()

assMultipleChoiceGUI::uploadchoice ( )

Upload an image.

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

    {
        $this->writePostData(true);
        $position = key($_POST['cmd']['uploadchoice']);
        $this->editQuestion();
    }

References $_POST, editQuestion(), and writePostData().

Here is the call graph for this function:

◆ writeAnswerSpecificPostData()

assMultipleChoiceGUI::writeAnswerSpecificPostData ( ilPropertyFormGUI $form )

Extracts the answer 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 ilGuiAnswerScoringAdjustable.

Definition at line 779 of file class.assMultipleChoiceGUI.php.

    {
        // Delete all existing answers and create new answers from the form data
        $this->object->flushAnswers();
        if ($this->object->isSingleline) {
            foreach ($_POST['choice']['answer'] as $index => $answertext) {
                $answertext = ilUtil::secureString($answertext);
                
                $picturefile = $_POST['choice']['imagename'][$index];
                $file_org_name = $_FILES['choice']['name']['image'][$index];
                $file_temp_name = $_FILES['choice']['tmp_name']['image'][$index];
 
                if (strlen($file_temp_name)) {
                    // check suffix
                    $suffix = strtolower(array_pop(explode(".", $file_org_name)));
                    if (in_array($suffix, array( "jpg", "jpeg", "png", "gif" ))) {
                        // upload image
                        $filename = $this->object->buildHashedImageFilename($file_org_name);
                        if ($this->object->setImageFile($filename, $file_temp_name) == 0) {
                            $picturefile = $filename;
                        }
                    }
                }
                $this->object->addAnswer(
                    $answertext,
                    $_POST['choice']['points'][$index],
                    $_POST['choice']['points_unchecked'][$index],
                    $index,
                    $picturefile
                );
            }
        } else {
            foreach ($_POST['choice']['answer'] as $index => $answer) {
                $answertext = $answer;
                $this->object->addAnswer(
                    $answertext,
                    $_POST['choice']['points'][$index],
                    $_POST['choice']['points_unchecked'][$index],
                    $index
                );
            }
        }
    }

References $_POST, $filename, $index, and ilUtil\secureString().

Referenced by writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writePostData()

assMultipleChoiceGUI::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 56 of file class.assMultipleChoiceGUI.php.

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

References $form, buildEditForm(), editQuestion(), assQuestionGUI\saveTaxonomyAssignments(), writeAnswerSpecificPostData(), assQuestionGUI\writeQuestionGenericPostData(), and writeQuestionSpecificPostData().

Referenced by addchoice(), removechoice(), removeimagechoice(), and uploadchoice().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeQuestionSpecificPostData()

assMultipleChoiceGUI::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 762 of file class.assMultipleChoiceGUI.php.

    {
        $this->object->setShuffle($_POST["shuffle"]);
        
        $selectionLimit = (int) $form->getItemByPostVar('selection_limit')->getValue();
        $this->object->setSelectionLimit($selectionLimit > 0 ? $selectionLimit : null);
 
        $this->object->setMultilineAnswerSetting($_POST["types"]);
        if (is_array($_POST['choice']['imagename']) && $_POST["types"] == 1) {
            $this->object->isSingleline = true;
            ilUtil::sendInfo($this->lng->txt('info_answer_type_change'), true);
        } else {
            $this->object->isSingleline = ($_POST["types"] == 0) ? true : false;
        }
        $this->object->setThumbSize((strlen($_POST["thumb_size"])) ? $_POST["thumb_size"] : "");
    }

References $_POST, $form, and ilUtil\sendInfo().

Referenced by writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $choiceKeys

assMultipleChoiceGUI::$choiceKeys

Definition at line 25 of file class.assMultipleChoiceGUI.php.

Referenced by getChoiceKeys().

◆ $useEmptySolutionInputChecked

assMultipleChoiceGUI::$useEmptySolutionInputChecked = false

protected

Definition at line 620 of file class.assMultipleChoiceGUI.php.

Referenced by isUseEmptySolutionInputChecked(), and setUseEmptySolutionInputChecked().

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

Modules/TestQuestionPool/classes/class.assMultipleChoiceGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addBasicQuestionFormProperties()

◆ addchoice()

◆ aggregateAnswers()

◆ buildEditForm()

◆ editQuestion()

◆ getAfterParticipationSuppressionAnswerPostVars()

◆ getAfterParticipationSuppressionQuestionPostVars()

◆ getAggregatedAnswersView()

◆ getAnswersFrequency()

◆ getChoiceKeys()

◆ getEditAnswersSingleLine()

◆ getPreview()

◆ getSolutionOutput()

◆ getSpecificFeedbackOutput()

◆ getTestOutput()

◆ getUseUnchangedAnswerCheckboxHtml()

◆ hasInlineFeedback()

◆ isUseEmptySolutionInputChecked()

◆ populateAnswerSpecificFormPart()

◆ populateCorrectionsFormProperties()

◆ populateJavascriptFilesRequiredForWorkForm()

◆ populateQuestionSpecificFormPart()

◆ populateSpecificFeedbackInline()

◆ removechoice()

◆ removeimagechoice()

◆ renderAggregateView()

◆ saveCorrectionsFormProperties()

◆ setQuestionTabs()

◆ setUseEmptySolutionInputChecked()

◆ supportsIntermediateSolutionOutput()

◆ uploadchoice()

◆ writeAnswerSpecificPostData()

◆ writePostData()

◆ writeQuestionSpecificPostData()

Field Documentation

◆ $choiceKeys

◆ $useEmptySolutionInputChecked