assLongMenuGUI Class Reference

Inheritance diagram for assLongMenuGUI:

Collaboration diagram for assLongMenuGUI:

Public Member Functions
	__construct ($id=-1)
	getCommand ($cmd)
	writeQuestionSpecificPostData (ilPropertyFormGUI $form)
	Extracts the question specific values from $_POST and applies them to the data object. More...
	populateQuestionSpecificFormPart (ilPropertyFormGUI $form)
	populateAnswerSpecificFormPart (ilPropertyFormGUI $form)
	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)
	setQuestionTabs ()
	Sets the ILIAS tabs for this question type. More...
	getSpecificFeedbackOutput ($active_id, $pass)
	Returns the answer specific feedback for the question. 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...
	getLongMenuTextWithInputFieldsInsteadOfGaps ($user_solution=array(), $solution=false, $graphical=false)
Public Member Functions inherited from assQuestionGUI
	__construct ()
	assQuestionGUI constructor More...
	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="")
	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 ($active_id, $pass)
	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)
	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 ()
	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...

Data Fields
	$lng
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
	getUserSolution ($active_id, $pass)
	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...
	editQuestion (ilPropertyFormGUI $form=null)
	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 ()

Private Member Functions
	getTextGapTemplate ($key, $value, $solution, $ok=false, $graphical=false)
	getSelectGapTemplate ($key, $answers, $user_value, $solution, $ok=false, $graphical=false)

Private Attributes
	$rbacsystem
	$ilTabs

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...
Protected Attributes inherited from assQuestionGUI
	$editForm

Detailed Description

Definition at line 15 of file class.assLongMenuGUI.php.

Constructor & Destructor Documentation

__construct()

assLongMenuGUI::__construct

(

$id = -1

)

Definition at line 21 of file class.assLongMenuGUI.php.

    {
        parent::__construct();
        include_once './Modules/TestQuestionPool/classes/class.assLongMenu.php';
        $this->object = new assLongMenu();
        if ($id >= 0) {
            $this->object->loadFromDb($id);
        }
        global $rbacsystem, $ilTabs, $lng;
        $this->rbacsystem       = $rbacsystem;
        $this->ilTabs           = $ilTabs;
        $this->lng                      = $lng;
    }

References $id, $ilTabs, $lng, and $rbacsystem.

Member Function Documentation

buildEditForm()

assLongMenuGUI::buildEditForm ( )

protected

Returns

ilPropertyFormGUI

Reimplemented from assQuestionGUI.

Definition at line 113 of file class.assLongMenuGUI.php.

    {
        $form = $this->buildBasicEditFormObject();
 
        $this->addQuestionFormCommandButtons($form);
 
        $this->addBasicQuestionFormProperties($form);
 
        $this->populateQuestionSpecificFormPart($form);
        $this->populateAnswerSpecificFormPart($form);
 
        $this->populateTaxonomyFormSection($form);
 
        return $form;
    }

References $form, assQuestionGUI\addBasicQuestionFormProperties(), assQuestionGUI\addQuestionFormCommandButtons(), assQuestionGUI\buildBasicEditFormObject(), 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()

assLongMenuGUI::editQuestion ( ilPropertyFormGUI  $form = null )

protected

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

    {
        if ($form === null) {
            $form = $this->buildEditForm();
        }
 
        $this->getQuestionTemplate();
        $this->tpl->addCss('Modules/Test/templates/default/ta.css');
 
        $this->tpl->setVariable("QUESTION_DATA", $this->ctrl->getHTML($form));
    }

References $form, buildEditForm(), and assQuestionGUI\getQuestionTemplate().

Referenced by writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

getAfterParticipationSuppressionQuestionPostVars()

assLongMenuGUI::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 493 of file class.assLongMenuGUI.php.

    {
        return array();
    }

getAggregatedAnswersView()

assLongMenuGUI::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 506 of file class.assLongMenuGUI.php.

    {
        $overview = array();
        $aggregation = array();
        foreach ($relevant_answers as $answer) {
            $overview[$answer['active_fi']][$answer['pass']][$answer['value1']] = $answer['value2'];
        }
 
        foreach ($overview as $active) {
            foreach ($active as $answer) {
                foreach ($answer as $option => $value) {
                    $aggregation[$option][$value] = $aggregation[$option][$value] + 1;
                }
            }
        }
        $tpl = new ilTemplate('tpl.il_as_aggregated_long_menu_answers_table.html', true, true, "Modules/TestQuestionPool");
        $json = json_decode($this->object->getJsonStructure());
        foreach ($json as $key => $value) {
            $tpl->setVariable('TITLE', 'Longmenu ' . ($key+1));
            if (array_key_exists($key, $aggregation)) {
                $aggregate = $aggregation[$key];
                foreach ($aggregate as $answer => $counts) {
                    $tpl->setVariable('OPTION', $answer);
                    $tpl->setVariable('COUNT', $counts);
                    $tpl->parseCurrentBlock();
                }
            }
        }
 
        return $tpl->get();
    }

References $key, and assQuestionGUI\$tpl.

getCommand()

assLongMenuGUI::getCommand

(

$cmd

)

Reimplemented from assQuestionGUI.

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

    {
        return $cmd;
    }

getLongMenuTextWithInputFieldsInsteadOfGaps()

assLongMenuGUI::getLongMenuTextWithInputFieldsInsteadOfGaps	(		$user_solution = array(),
			$solution = false,
			$graphical = false
	)

Definition at line 538 of file class.assLongMenuGUI.php.

    {
        $return_value = '';
        $text_array = preg_split("/\\[" . assLongMenu::GAP_PLACEHOLDER . " (\\d+)\\]/", $this->object->getLongMenuTextValue());
        $correct_answers = $this->object->getCorrectAnswers();
        $answers = $this->object->getAnswers();
        foreach ($text_array as $key => $value) {
            $answer_is_correct = false;
            $user_value = '';
            $return_value .= $value;
            if ($key < sizeof($text_array) - 1) {
                if ($correct_answers[$key][2] == assLongMenu::ANSWER_TYPE_TEXT_VAL) {
                    if (array_key_exists($key, $user_solution)) {
                        $user_value = $user_solution[$key];
                        if (in_array($user_value, $correct_answers[$key][0])) {
                            $answer_is_correct = true;
                        }
                    }
                    
                    $return_value .=  $this->getTextGapTemplate($key, $user_value, $solution, $answer_is_correct, $graphical);
                } elseif ($correct_answers[$key][2] == assLongMenu::ANSWER_TYPE_SELECT_VAL) {
                    if (array_key_exists($key, $user_solution)) {
                        $user_value = $user_solution[$key];
                        if (in_array($user_value, $correct_answers[$key][0])) {
                            $answer_is_correct = true;
                        }
                    }
                    $return_value .=  $this->getSelectGapTemplate($key, $answers[$key], $user_value, $solution, $answer_is_correct, $graphical);
                }
            }
        }
        return $return_value;
    }

References $key, assLongMenu\ANSWER_TYPE_SELECT_VAL, assLongMenu\ANSWER_TYPE_TEXT_VAL, assLongMenu\GAP_PLACEHOLDER, getSelectGapTemplate(), and getTextGapTemplate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getPreview()

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

Reimplemented from assQuestionGUI.

Definition at line 314 of file class.assLongMenuGUI.php.

    {
        $user_solution = is_object($this->getPreviewSession()) ? (array) $this->getPreviewSession()->getParticipantsSolution() : array();
        $user_solution = array_values($user_solution);
        
        include_once "./Services/UICore/classes/class.ilTemplate.php";
        $template = new ilTemplate("tpl.il_as_qpl_longmenu_output.html", true, true, "Modules/TestQuestionPool");
 
        $question_text = $this->object->getQuestion();
        $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($question_text, true));
        $template->setVariable("ANSWER_OPTIONS_JSON", json_encode($this->object->getAvailableAnswerOptions()));
        $template->setVariable('AUTOCOMPLETE_LENGTH', $this->object->getMinAutoComplete());
        $template->setVariable('LONGMENU_TEXT', $this->getLongMenuTextWithInputFieldsInsteadOfGaps($user_solution));
 
        $question_output = $template->get();
        if (!$show_question_only) {
            $question_output = $this->getILIASPage($question_output);
        }
        return $question_output;
    }

References $template, assQuestionGUI\getILIASPage(), getLongMenuTextWithInputFieldsInsteadOfGaps(), and assQuestionGUI\getPreviewSession().

Here is the call graph for this function:

getSelectGapTemplate()

assLongMenuGUI::getSelectGapTemplate (   $key,   $answers,   $user_value,   $solution,   $ok = false,   $graphical = false  )

private

Definition at line 594 of file class.assLongMenuGUI.php.

    {
        $tpl = new ilTemplate("tpl.il_as_qpl_long_menu_select_gap.html", true, true, "Modules/TestQuestionPool");
        $tpl->setVariable('KEY', $key);
        if ($solution) {
            $tpl->setVariable('DISABLED', 'disabled');
            $tpl->setVariable('JS_IGNORE', '_ignore');
            $tpl->setCurrentBlock('best_solution');
            if ($user_value == -1) {
                $tpl->setVariable("SOLUTION", $this->lng->txt("please_select"));
            } else {
                $tpl->setVariable('SOLUTION', $user_value);
            }
            if ($graphical) {
                if ($ok) {
                    $tpl->setVariable("ICON_OK", ilUtil::getImagePath("icon_ok.svg"));
                    $tpl->setVariable("TEXT_OK", $this->lng->txt("answer_is_right"));
                } else {
                    $tpl->setVariable("ICON_OK", ilUtil::getImagePath("icon_not_ok.svg"));
                    $tpl->setVariable("TEXT_OK", $this->lng->txt("answer_is_wrong"));
                }
            }
            $tpl->parseCurrentBlock();
        } else {
            $tpl->setVariable("PLEASE_SELECT", $this->lng->txt("please_select"));
            foreach ($answers as $value) {
                $tpl->setCurrentBlock('select_option');
                $tpl->setVariable('VALUE', $value);
                if ($value == $user_value) {
                    $tpl->setVariable('SELECTED', 'selected');
                }
                $tpl->parseCurrentBlock();
            }
        }
        return $tpl->get();
    }

References $key, $ok, assQuestionGUI\$tpl, and ilUtil\getImagePath().

Referenced by getLongMenuTextWithInputFieldsInsteadOfGaps().

Here is the call graph for this function:

Here is the caller graph for this function:

getSolutionOutput()

assLongMenuGUI::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 257 of file class.assLongMenuGUI.php.

      {
        include_once "./Services/UICore/classes/class.ilTemplate.php";
        $template = new ilTemplate("tpl.il_as_qpl_lome_question_output_solution.html", true, true, "Modules/TestQuestionPool");
        
        if ($show_question_text) {
            $question_text = $this->object->getQuestion();
            $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($question_text, true));
        }
        if (($active_id > 0) && (!$show_correct_solution)) {
            $correct_solution   = $this->getUserSolution($active_id, $pass);
        } else {
            $correct_solution = $this->object->getCorrectAnswersForQuestionSolution($this->object->getId());
        }
        $template->setVariable('LONGMENU_TEXT_SOLUTION', $this->getLongMenuTextWithInputFieldsInsteadOfGaps($correct_solution, true, $graphicalOutput));
        $solution_template = new ilTemplate("tpl.il_as_tst_solution_output.html", true, true, "Modules/TestQuestionPool");
        $question_output = $template->get();
        $feedback = '';
        if ($show_feedback) {
            if (!$this->isTestPresentationContext()) {
                $fb = $this->getGenericFeedbackOutput($active_id, $pass);
                $feedback .= strlen($fb) ? $fb : '';
            }
            
            $fb = $this->getSpecificFeedbackOutput($active_id, $pass);
            $feedback .=  strlen($fb) ? $fb : '';
        }
        if (strlen($feedback)) {
            $cssClass = (
                $this->hasCorrectSolution($active_id, $pass) ?
                ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_CORRECT : ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_WRONG
            );
            
            $solution_template->setVariable("ILC_FB_CSS_CLASS", $cssClass);
            $solution_template->setVariable("FEEDBACK", $this->object->prepareTextareaOutput($feedback, true));
        }
 
        $solution_template->setVariable("SOLUTION_OUTPUT", $question_output);
 
        $solution_output = $solution_template->get();
 
        if (!$show_question_only) {
            $solution_output = $this->getILIASPage($solution_output);
        }
 
        return $solution_output;
    }

References $pass, $template, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_CORRECT, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_WRONG, assQuestionGUI\getGenericFeedbackOutput(), assQuestionGUI\getILIASPage(), getLongMenuTextWithInputFieldsInsteadOfGaps(), getSpecificFeedbackOutput(), getUserSolution(), assQuestionGUI\hasCorrectSolution(), and assQuestionGUI\isTestPresentationContext().

Here is the call graph for this function:

getSpecificFeedbackOutput()

assLongMenuGUI::getSpecificFeedbackOutput	(		$active_id,
			$pass
	)

Returns the answer specific feedback for the question.

This method should be overwritten by the actual question.

Todo:

Mark this method abstract!

Parameters

integer	$active_id	Active ID of the user
integer	$pass	Active pass

Returns

string HTML Code with the answer specific feedback @access public

Reimplemented from assQuestionGUI.

Definition at line 459 of file class.assLongMenuGUI.php.

    {
        if (!$this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation($this->object->getId(), 0)) {
            return '';
        }
 
        $feedback = '<table class="test_specific_feedback"><tbody>';
        $gaps = $this->object->getCorrectAnswers();
        foreach ($gaps as $index => $answer) {
            $caption = assLongMenu::GAP_PLACEHOLDER . ' ';
            $caption .= $index + 1 . ': ';
 
            $feedback .= '<tr><td>';
 
            $feedback .= $caption . '</td><td>';
            $feedback .= $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
                $this->object->getId(),
                $index
            ) . '</td> </tr>';
        }
        $feedback .= '</tbody></table>';
        return $this->object->prepareTextareaOutput($feedback, true);
    }

References $index, and assLongMenu\GAP_PLACEHOLDER.

Referenced by getSolutionOutput().

Here is the caller graph for this function:

getTestOutput()

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

Reimplemented from assQuestionGUI.

Definition at line 337 of file class.assLongMenuGUI.php.

      {
        $user_solution = array();
        if ($active_id) {
            $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->getUserSolutionPreferingIntermediate($active_id, $pass);
            foreach ($solutions as $idx => $solution_value) {
                $user_solution[$solution_value["value1"]] = $solution_value["value2"];
            }
        }
 
        // generate the question output
        include_once "./Services/UICore/classes/class.ilTemplate.php";
        $template = new ilTemplate("tpl.il_as_qpl_longmenu_output.html", true, true, "Modules/TestQuestionPool");
        
        $question_text = $this->object->getQuestion();
        $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($question_text, true));
        $template->setVariable("ANSWER_OPTIONS_JSON", json_encode($this->object->getAvailableAnswerOptions()));
        $template->setVariable('LONGMENU_TEXT', $this->getLongMenuTextWithInputFieldsInsteadOfGaps($user_solution));
        $template->setVariable('AUTOCOMPLETE_LENGTH', $this->object->getMinAutoComplete());
        $question_output = $template->get();
        $page_output = $this->outQuestionPage("", $is_postponed, $active_id, $question_output);
        return $page_output;
    }

References $pass, $template, ilObjTest\_getPass(), ilObjTest\_getUsePreviousAnswers(), getLongMenuTextWithInputFieldsInsteadOfGaps(), and assQuestionGUI\outQuestionPage().

Here is the call graph for this function:

getTextGapTemplate()

assLongMenuGUI::getTextGapTemplate (   $key,   $value,   $solution,   $ok = false,   $graphical = false  )

private

Definition at line 572 of file class.assLongMenuGUI.php.

    {
        $tpl = new ilTemplate("tpl.il_as_qpl_long_menu_text_gap.html", true, true, "Modules/TestQuestionPool");
        if ($solution) {
            $tpl->setVariable('DISABLED', 'disabled');
            $tpl->setVariable('JS_IGNORE', '_ignore');
            if ($graphical) {
                if ($ok) {
                    $tpl->setVariable("ICON_OK", ilUtil::getImagePath("icon_ok.svg"));
                    $tpl->setVariable("TEXT_OK", $this->lng->txt("answer_is_right"));
                } else {
                    $tpl->setVariable("ICON_OK", ilUtil::getImagePath("icon_not_ok.svg"));
                    $tpl->setVariable("TEXT_OK", $this->lng->txt("answer_is_wrong"));
                }
            }
        }
        $tpl->setVariable('VALUE', $value);
        $tpl->setVariable('KEY', $key);
        
        return $tpl->get();
    }

References $key, $ok, assQuestionGUI\$tpl, and ilUtil\getImagePath().

Referenced by getLongMenuTextWithInputFieldsInsteadOfGaps().

Here is the call graph for this function:

Here is the caller graph for this function:

getUserSolution()

assLongMenuGUI::getUserSolution (   $active_id,   $pass  )

protected

Parameters

$active_id
$pass

Returns

array

Definition at line 40 of file class.assLongMenuGUI.php.

    {
        $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) {
                $user_solution[$solution_value["value1"]] = $solution_value["value2"];
            }
            return $user_solution;
        }
        return $user_solution;
    }

References $pass.

Referenced by getSolutionOutput().

Here is the caller graph for this function:

populateAnswerSpecificFormPart()

assLongMenuGUI::populateAnswerSpecificFormPart

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

Returns

ilPropertyFormGUI

Definition at line 239 of file class.assLongMenuGUI.php.

    {
        return $form;
    }

References $form.

Referenced by buildEditForm().

Here is the caller graph for this function:

populateQuestionSpecificFormPart()

assLongMenuGUI::populateQuestionSpecificFormPart

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

Returns

ilPropertyFormGUI

Implements ilGuiQuestionScoringAdjustable.

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

    {
        $long_menu_text = new ilTextAreaInputGUI($this->lng->txt("longmenu_text"), 'longmenu_text');
        $long_menu_text->setRequired(true);
        //$long_menu_text->setInfo($this->lng->txt("longmenu_hint"));
        $long_menu_text->setRows(10);
        $long_menu_text->setCols(80);
        if (!$this->object->getSelfAssessmentEditingMode()) {
            if ($this->object->getAdditionalContentEditingMode() == assQuestion::ADDITIONAL_CONTENT_EDITING_MODE_DEFAULT) {
                include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
                $long_menu_text->setRteTags(ilObjAdvancedEditing::_getUsedHTMLTags("assessment"));
                $long_menu_text->addPlugin("latex");
                $long_menu_text->addButton("latex");
                $long_menu_text->addButton("pastelatex");
                $long_menu_text->setRTESupport($this->object->getId(), "qpl", "assessment");
                $long_menu_text->setUseRte(true);
            }
        } else {
            require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssSelfAssessmentQuestionFormatter.php';
            $long_menu_text->setRteTags(ilAssSelfAssessmentQuestionFormatter::getSelfAssessmentTags());
            $long_menu_text->setUseTagsForRteOnly(false);
        }
 
        $long_menu_text->setValue($this->object->prepareTextareaOutput($this->object->getLongMenuTextValue()));
        $form->addItem($long_menu_text);
        
        $tpl = new ilTemplate("tpl.il_as_qpl_long_menu_gap_button_code.html", true, true, "Modules/TestQuestionPool");
        $tpl->setVariable('INSERT_GAP', $this->lng->txt('insert_gap'));
        $tpl->parseCurrentBlock();
        $button = new ilCustomInputGUI(' ', '');
        $button->setHtml($tpl->get());
        $form->addItem($button);
 
        require_once("./Services/UIComponent/Modal/classes/class.ilModalGUI.php");
        $modal = ilModalGUI::getInstance();
        $modal->setHeading('');
        $modal->setId("ilGapModal");
        //$modal->setBackdrop(ilModalGUI::BACKDROP_OFF);
        $modal->setBody('');
 
        $min_auto_complete = new ilNumberInputGUI($this->lng->txt("min_auto_complete"), 'min_auto_complete');
        
        $auto_complete = $this->object->getMinAutoComplete();
        if ($auto_complete == 0) {
            $auto_complete = assLongMenu::MIN_LENGTH_AUTOCOMPLETE;
        }
        $min_auto_complete->setValue($auto_complete);
        $min_auto_complete->setMinValue(1);
        $min_auto_complete->setMaxValue(99);
        $min_auto_complete->setSize(5);
        $form->addItem($min_auto_complete);
        
        $hidden_text = new ilHiddenInputGUI('hidden_text_files');
        $form->addItem($hidden_text);
 
        $hidden_correct = new ilHiddenInputGUI('hidden_correct_answers');
        $form->addItem($hidden_correct);
        
        $tpl = new ilTemplate("tpl.il_as_qpl_long_menu_gap.html", true, true, "Modules/TestQuestionPool");
        if (is_array($_POST) && array_key_exists('hidden_text_files', $_POST)) {
            $tpl->setVariable('CORRECT_ANSWERS', $_POST['hidden_correct_answers']);
            $tpl->setVariable('ALL_ANSWERS', $_POST['hidden_text_files']);
        } else {
            $tpl->setVariable('CORRECT_ANSWERS', $this->object->getJsonStructure());
            $tpl->setVariable('ALL_ANSWERS', $this->object->getAnswersObject());
        }
        $tpl->setVariable('MAX_INPUT_FIELDS', assLongMenu::MAX_INPUT_FIELDS);
        $tpl->setVariable('GAP_PLACEHOLDER', assLongMenu::GAP_PLACEHOLDER);
        $tpl->setVariable('SELECT_BOX', $this->lng->txt('insert_gap'));
        $tpl->setVariable("SELECT", $this->lng->txt('answers_select'));
        $tpl->setVariable("TEXT", $this->lng->txt('answers_text_box'));
        $tpl->setVariable("POINTS", $this->lng->txt('points'));
        $tpl->setVariable("INFO_TEXT_UPLOAD", $this->lng->txt('info_text_upload'));
        $tpl->setVariable("TXT_BROWSE", $this->lng->txt('select_file'));
        $tpl->setVariable("MANUAL_EDITING", $this->lng->txt('manual_editing'));
        $tpl->setVariable("CORRECT_ANSWER_TXT", $this->lng->txt('correct_answers'));
        $tpl->setVariable("ANSWER_OPTIONS_TXT", $this->lng->txt('answer_options'));
        $tpl->setVariable("ANSWERS_TXT", $this->lng->txt('answers'));
        $tpl->setVariable("TYPE_TXT", $this->lng->txt('type'));
        $tpl->setVariable("EDIT_TXT", $this->lng->txt('edit'));
        $tpl->setVariable("ADD_ANSWER_TXT", $this->lng->txt('add_answers'));
        $tpl->setVariable('POINTS_ERROR', $this->lng->txt('enter_enough_positive_points'));
        $tpl->setVariable('AUTOCOMPLETE_ERROR', $this->lng->txt('autocomplete_error'));
        $tpl->setVariable('MISSING_VALUE', $this->lng->txt('msg_input_is_required'));
        $tpl->setVariable('SAVE', $this->lng->txt('save'));
        $tpl->setVariable('CANCEL', $this->lng->txt('cancel'));
        require_once("Services/Form/classes/class.ilTagInputGUI.php");
        $tag_input = new ilTagInputGUI();
        $tag_input->setTypeAhead(true);
        $tag_input->setPostVar('taggable');
        $tag_input->setJsSelfInit(false);
        $tag_input->setTypeAheadMinLength(1);
        $tpl->setVariable("TAGGING_PROTOTYPE", $tag_input->render(''));
        
        $tpl->setVariable("MY_MODAL", $modal->getHTML());
        
        $tpl->parseCurrentBlock();
        $button = new ilCustomInputGUI(' ', '');
        $button->setHtml($tpl->get());
        $form->addItem($button);
        return $form;
    }

References $_POST, $form, assQuestionGUI\$tpl, ilObjAdvancedEditing\_getUsedHTMLTags(), assQuestion\ADDITIONAL_CONTENT_EDITING_MODE_DEFAULT, assLongMenu\GAP_PLACEHOLDER, ilModalGUI\getInstance(), ilAssSelfAssessmentQuestionFormatter\getSelfAssessmentTags(), assLongMenu\MAX_INPUT_FIELDS, and assLongMenu\MIN_LENGTH_AUTOCOMPLETE.

Referenced by buildEditForm().

Here is the call graph for this function:

Here is the caller graph for this function:

setQuestionTabs()

assLongMenuGUI::setQuestionTabs

(

)

Sets the ILIAS tabs for this question type.

@access public

Reimplemented from assQuestionGUI.

Definition at line 381 of file class.assLongMenuGUI.php.

    {
        $this->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 ($this->rbacsystem->checkAccess('write', $_GET["ref_id"])) {
                // edit page
                $this->ilTabs->addTarget(
                    "edit_page",
                    $this->ctrl->getLinkTargetByClass("ilAssQuestionPageGUI", "edit"),
                    array("edit", "insert", "exec_pg"),
                    "",
                    "",
                    $force_active
                );
            }
 
            $this->addTab_QuestionPreview($this->ilTabs);
        }
 
        $force_active = false;
        if ($this->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("/^delete_.*/", $key, $matches)) {
                        $force_active = true;
                    }
                }
            }
            // edit question properties
            $this->ilTabs->addTarget(
                "edit_question",
                $url,
                array("editQuestion", "save", "saveEdit", "addkvp", "removekvp", "originalSyncForm"),
                $classname,
                "",
                $force_active
            );
        }
 
        // add tab for question feedback within common class assQuestionGUI
        $this->addTab_QuestionFeedback($this->ilTabs);
 
        // add tab for question hint within common class assQuestionGUI
        $this->addTab_QuestionHints($this->ilTabs);
 
        // add tab for question's suggested solution within common class assQuestionGUI
        $this->addTab_SuggestedSolution($this->ilTabs, $classname);
 
        // Assessment of questions sub menu entry
        if ($_GET["q_id"]) {
            $this->ilTabs->addTarget(
                "statistics",
                $this->ctrl->getLinkTargetByClass($classname, "assessment"),
                array("assessment"),
                $classname,
                ""
            );
        }
 
        $this->addBackTab($this->ilTabs);
    }

References $_GET, $_POST, $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:

writePostData()

assLongMenuGUI::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 69 of file class.assLongMenuGUI.php.

    {
        $form = $this->buildEditForm();
        $form->setValuesByPost();
        $this->writeQuestionGenericPostData();
        $this->writeQuestionSpecificPostData($form);
        $custom_check = $this->object->checkQuestionCustomPart();
        if (!$form->checkInput() ||  !$custom_check) {
            if (!$custom_check) {
                ilUtil::sendFailure($this->lng->txt("form_input_not_valid"));
            }
            $this->editQuestion($form);
            return 1;
        }
        $this->saveTaxonomyAssignments();
        return 0;
    }

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

Here is the call graph for this function:

writeQuestionSpecificPostData()

assLongMenuGUI::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 87 of file class.assLongMenuGUI.php.

    {
        $this->object->setLongMenuTextValue(ilUtil::stripSlashesRecursive($_POST['longmenu_text']));
        $this->object->setAnswers(json_decode(ilUtil::stripSlashesRecursive($_POST['hidden_text_files'])));
        $this->object->setCorrectAnswers(json_decode(ilUtil::stripSlashesRecursive($_POST['hidden_correct_answers'])));
        $this->object->setAnswerType(ilUtil::stripSlashesRecursive($_POST['long_menu_type']));
        $this->object->setQuestion($_POST['question']);
        $this->object->setLongMenuTextValue($_POST["longmenu_text"]);
        $this->object->setMinAutoComplete((int) $_POST["min_auto_complete"]);
        $this->saveTaxonomyAssignments();
    }

References $_POST, assQuestionGUI\saveTaxonomyAssignments(), and ilUtil\stripSlashesRecursive().

Referenced by writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ilTabs

assLongMenuGUI::$ilTabs

private

Definition at line 18 of file class.assLongMenuGUI.php.

Referenced by __construct().

$lng

assLongMenuGUI::$lng

Definition at line 19 of file class.assLongMenuGUI.php.

Referenced by __construct().

$rbacsystem

assLongMenuGUI::$rbacsystem

private

Definition at line 17 of file class.assLongMenuGUI.php.

Referenced by __construct().

---

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

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