Text question GUI representation. More...

Inheritance diagram for assTextQuestionGUI:

Collaboration diagram for assTextQuestionGUI:

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

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

	outAdditionalOutput ()

	magicAfterTestOutput ()

	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=NULL, $is_postponed=FALSE, $use_post_solutions=FALSE, $inlineFeedback=false)

	addSuggestedSolution ()

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

	getSpecificFeedbackOutput ($active_id, $pass)
	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...

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

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

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

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

	getJsCode ()

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)

	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
	getBestAnswer ($asHtml)

	getUserAnswer ($active_id, $pass)

Static Private Member Functions
static	buildAnswerTextOnlyArray ($answers)

Additional Inherited Members
Static Public Member Functions inherited from assQuestionGUI
static	_getQuestionGUI ($question_type, $question_id=-1)
	Creates a question gui representation and returns the alias to the question gui note: please do not use $this inside this method to allow static calls. More...

static	_getGUIClassNameForId ($a_q_id)

static	_getClassNameForQType ($q_type)

static	getCommandsFromClassConstants ($guiClassName, $cmdConstantNameBegin='CMD_')
	extracts values of all constants of given class with given prefix as array can be used to get all possible commands in case of these commands are defined as constants More...

Data Fields inherited from assQuestionGUI
const	FORM_MODE_EDIT = 'edit'

const	FORM_MODE_ADJUST = 'adjust'

const	FORM_ENCODING_URLENCODE = 'application/x-www-form-urlencoded'

const	FORM_ENCODING_MULTIPART = 'multipart/form-data'

const	SESSION_PREVIEW_DATA_BASE_INDEX = 'ilAssQuestionPreviewAnswers'

	$object

	$tpl

	$lng

	$error

	$errormessage

	$sequence_no
	sequence number in test More...

	$question_count
	question count in test More...

const	PRESENTATION_CONTEXT_TEST = 'pContextTest'

const	PRESENTATION_CONTEXT_RESULTS = 'pContextResults'

const	RENDER_PURPOSE_PLAYBACK = 'renderPurposePlayback'

const	RENDER_PURPOSE_DEMOPLAY = 'renderPurposeDemoplay'

const	RENDER_PURPOSE_PREVIEW = 'renderPurposePreview'

const	RENDER_PURPOSE_PRINT_PDF = 'renderPurposePrintPdf'

const	RENDER_PURPOSE_INPUT_VALUE = 'renderPurposeInputValue'

const	EDIT_CONTEXT_AUTHORING = 'authoring'

const	EDIT_CONTEXT_ADJUSTMENT = 'adjustment'

Protected Attributes inherited from assQuestionGUI
	$editForm

Detailed Description

Text question GUI representation.

The assTextQuestionGUI class encapsulates the GUI representation for text 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 assTextQuestionGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

assTextQuestionGUI::__construct ( $id = -1 )

assTextQuestionGUI constructor

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

Parameters

integer $id The database id of a text question object

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

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

Member Function Documentation

◆ addSuggestedSolution()

assTextQuestionGUI::addSuggestedSolution ( )

Definition at line 456 of file class.assTextQuestionGUI.php.

        {
                $_SESSION["subquestion_index"] = 0;
                if ($_POST["cmd"]["addSuggestedSolution"])
                {
                        if ($this->writePostData())
                        {
                                ilUtil::sendInfo($this->getErrorMessage());
                                $this->editQuestion();
                                return;
                        }
                        if (!$this->checkInput())
                        {
                                ilUtil::sendInfo($this->lng->txt("fill_out_all_required_fields_add_answer"));
                                $this->editQuestion();
                                return;
                        }
                }
                $this->object->saveToDb();
                $this->ctrl->setParameter($this, "q_id", $this->object->getId());
                $this->tpl->setVariable("HEADER", $this->object->getTitle());
                $this->getQuestionTemplate();
                parent::addSuggestedSolution();
        }

References $_POST, $_SESSION, editQuestion(), assQuestionGUI\getErrorMessage(), assQuestionGUI\getQuestionTemplate(), ilUtil\sendInfo(), and writePostData().

Here is the call graph for this function:

◆ buildAnswerTextOnlyArray()

static assTextQuestionGUI::buildAnswerTextOnlyArray ( $answers )

staticprivate

Definition at line 104 of file class.assTextQuestionGUI.php.

        {
                $answerTexts = array();
                
                foreach($answers as $answer)
                {
                        $answerTexts[] = $answer->getAnswertext();
                }
                
                return $answerTexts;
        }

◆ editQuestion()

assTextQuestionGUI::editQuestion ( $checkonly = FALSE )

Creates an output of the edit form for the question.

@access public

Definition at line 66 of file class.assTextQuestionGUI.php.

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

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

Referenced by addSuggestedSolution(), and writePostData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAfterParticipationSuppressionAnswerPostVars()

assTextQuestionGUI::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 732 of file class.assTextQuestionGUI.php.

        {
                return array();
        }

◆ getAfterParticipationSuppressionQuestionPostVars()

assTextQuestionGUI::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 746 of file class.assTextQuestionGUI.php.

        {
                return array();
        }

◆ getAggregatedAnswersView()

assTextQuestionGUI::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 759 of file class.assTextQuestionGUI.php.

        {
                return ''; //print_r($relevant_answers,true);
        }

◆ getBestAnswer()

assTextQuestionGUI::getBestAnswer ( $asHtml )

private

Definition at line 276 of file class.assTextQuestionGUI.php.

        {
                $answers = $this->object->getAnswers();
                if( !count($answers) )
                {
                        return '';
                }
                
                if($asHtml)
                {
                        $tplFile = 'tpl.il_as_qpl_text_question_best_solution_html.html';
                }
                else
                {
                        $tplFile = 'tpl.il_as_qpl_text_question_best_solution_ta.html';
                }
 
                $tpl = new ilTemplate($tplFile, true, true, 'Modules/TestQuestionPool');
                
                foreach ($answers as $answer)
                {
                        $keywordString = $answer->getAnswertext();
                        
                        if( in_array($this->object->getKeywordRelation(), assTextQuestion::getScoringModesWithPointsByKeyword()) )
                        {
                                $keywordString .= ' ' . $this->lng->txt('for') . ' ';
                                $keywordString .= $answer->getPoints() . ' ' . $this->lng->txt('points');
                        }
 
                        $tpl->setCurrentBlock('keyword');
                        $tpl->setVariable('KEYWORD', $keywordString);
                        $tpl->parseCurrentBlock();
                }
                
                $tpl->setVariable('KEYWORD_HEADER', $this->lng->txt('solution_contain_keywords'));
                $tpl->setVariable('SCORING_LABEL', $this->lng->txt('essay_scoring_mode').': ');
                
                switch( $this->object->getKeywordRelation() )
                {
                        case 'any':
                                $tpl->setVariable('SCORING_MODE', $this->lng->txt('essay_scoring_mode_keyword_relation_any'));
                                break;
                        case 'all':
                                $tpl->setVariable('SCORING_MODE', $this->lng->txt('essay_scoring_mode_keyword_relation_all'));
                                break;
                        case 'one':
                                $tpl->setVariable('SCORING_MODE', $this->lng->txt('essay_scoring_mode_keyword_relation_one'));
                                break;
                }
 
                return $tpl->get();
        }

References assQuestionGUI\$tpl, and assTextQuestion\getScoringModesWithPointsByKeyword().

Referenced by getSolutionOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getJsCode()

assTextQuestionGUI::getJsCode ( )

protected

Definition at line 437 of file class.assTextQuestionGUI.php.

        {
                $tpl = new ilTemplate('tpl.charcounter.html', true, true, 'Modules/TestQuestionPool');
                
                $tpl->setCurrentBlock('tinymce_handler');
                $tpl->touchBlock('tinymce_handler');
                $tpl->parseCurrentBlock();
                
                if ($this->object->getMaxNumOfChars() > 0)
                {
                        $tpl->setCurrentBlock('letter_counter_js');
                        $tpl->setVariable("QID", $this->object->getId());
                        $tpl->setVariable("MAXCHARS", $this->object->getMaxNumOfChars());
                        $tpl->parseCurrentBlock();
                }
                
                return $tpl->get();
        }

References assQuestionGUI\$tpl.

Referenced by getPreview(), and getTestOutput().

Here is the caller graph for this function:

◆ getPreview()

assTextQuestionGUI::getPreview	(	$show_question_only = `FALSE`,
		$showInlineFeedback = `false`
	)

Reimplemented from assQuestionGUI.

Definition at line 340 of file class.assTextQuestionGUI.php.

        {
                // generate the question output
                include_once "./Services/UICore/classes/class.ilTemplate.php";
                $template = new ilTemplate("tpl.il_as_qpl_text_question_output.html", TRUE, TRUE, "Modules/TestQuestionPool");
                if ($this->object->getMaxNumOfChars())
                {
                        $template->setCurrentBlock("maximum_char_hint");
                        $template->setVariable("MAXIMUM_CHAR_HINT", sprintf($this->lng->txt("text_maximum_chars_allowed"), $this->object->getMaxNumOfChars()));
                        $template->parseCurrentBlock();
                        #mbecker: No such block. $template->setCurrentBlock("has_maxchars");
                        $template->setVariable("MAXCHARS", $this->object->getMaxNumOfChars());
                        $template->parseCurrentBlock();
                        $template->setCurrentBlock("maxchars_counter");
                        $template->setVariable("QID", $this->object->getId());
                        $template->setVariable("MAXCHARS", $this->object->getMaxNumOfChars());
                        $template->setVariable("TEXTBOXSIZE", strlen($this->object->getMaxNumOfChars()));
                        $template->setVariable("CHARACTERS", $this->lng->txt("characters"));
                        $template->parseCurrentBlock();
                }
 
                if( is_object($this->getPreviewSession()) )
                {
                        $template->setVariable("ESSAY", ilUtil::prepareFormOutput(
                                $this->getPreviewSession()->getParticipantsSolution()
                        ));
                }
                
                $questiontext = $this->object->getQuestion();
                $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
                $template->setVariable("QID", $this->object->getId());
                
                $questionoutput = $template->get();
                
                $questionoutput .= $this->getJsCode();
 
                if (!$show_question_only)
                {
                        // get page object output
                        $questionoutput = $this->getILIASPage($questionoutput);
                }
                return $questionoutput;
        }

References assQuestionGUI\getILIASPage(), getJsCode(), assQuestionGUI\getPreviewSession(), ilUtil\prepareFormOutput(), and sprintf.

Here is the call graph for this function:

◆ getSolutionOutput()

assTextQuestionGUI::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 150 of file class.assTextQuestionGUI.php.

        {
                // get the solution of the user for the active pass or from the last pass if allowed
                
                $user_solution = $this->getUserAnswer( $active_id, $pass );
                
                if (($active_id > 0) && (!$show_correct_solution))
                {
                        $solution = $user_solution;
                }
                else
                {
                        $solution = $this->getBestAnswer($this->renderPurposeSupportsFormHtml());
                }
                
                // generate the question output
                include_once "./Services/UICore/classes/class.ilTemplate.php";
                $template = new ilTemplate("tpl.il_as_qpl_text_question_output_solution.html", TRUE, TRUE, "Modules/TestQuestionPool");
                $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html",TRUE, TRUE, "Modules/TestQuestionPool");
 
                $solution = $this->object->getHtmlUserSolutionPurifier()->purify($solution);
                if( $this->renderPurposeSupportsFormHtml() )
                {
                        $template->setCurrentBlock('essay_div');
                        $template->setVariable("DIV_ESSAY", $this->object->prepareTextareaOutput($solution, TRUE));
                }
                else
                {
                        $template->setCurrentBlock('essay_textarea');
                        $template->setVariable("TA_ESSAY", $this->object->prepareTextareaOutput($solution, TRUE, true));
                }
                $template->parseCurrentBlock();
 
                $questiontext = $this->object->getQuestion();
                
                if (!$show_correct_solution)
                {
                        $max_no_of_chars = $this->object->getMaxNumOfChars();
                        
                        if ($max_no_of_chars == 0)
                        {
                                $max_no_of_chars = ucfirst($this->lng->txt('unlimited'));
                        }
                        $act_no_of_chars = $this->object->countLetters($user_solution);
                        $template->setVariable("CHARACTER_INFO", '<b>' . $max_no_of_chars . '</b>' . 
                                $this->lng->txt('answer_characters') . ' <b>' . $act_no_of_chars . '</b>');
                }
                if (($active_id > 0) && (!$show_correct_solution))
                {
                        if ($graphicalOutput)
                        {
                                // output of ok/not ok icons for user entered solutions
                                $reached_points = $this->object->getReachedPoints($active_id, $pass);
                                if ($reached_points == $this->object->getMaximumPoints())
                                {
                                        $template->setCurrentBlock("icon_ok");
                                        $template->setVariable("ICON_OK", ilUtil::getImagePath("icon_ok.svg"));
                                        $template->setVariable("TEXT_OK", $this->lng->txt("answer_is_right"));
                                        $template->parseCurrentBlock();
                                }
                                else
                                {
                                        $template->setCurrentBlock("icon_ok");
                                        if ($reached_points > 0)
                                        {
                                                $template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_mostly_ok.svg"));
                                                $template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_not_correct_but_positive"));
                                        }
                                        else
                                        {
                                                $template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_not_ok.svg"));
                                                $template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_wrong"));
                                        }
                                        $template->parseCurrentBlock();
                                }
                        }
                }
                if ($show_question_text==true)
                {
                        $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
                }
                $questionoutput = $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
                        );
                        
                        $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_question_only)
                {
                        // get page object output
                        $solutionoutput = $this->getILIASPage($solutionoutput);
                }
                return $solutionoutput;
        }

References $pass, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_CORRECT, ilAssQuestionFeedback\CSS_CLASS_FEEDBACK_WRONG, getBestAnswer(), assQuestionGUI\getGenericFeedbackOutput(), assQuestionGUI\getILIASPage(), ilUtil\getImagePath(), getSpecificFeedbackOutput(), getUserAnswer(), assQuestionGUI\hasCorrectSolution(), assQuestionGUI\isTestPresentationContext(), and assQuestionGUI\renderPurposeSupportsFormHtml().

Here is the call graph for this function:

◆ getSpecificFeedbackOutput()

assTextQuestionGUI::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 552 of file class.assTextQuestionGUI.php.

        {
                        $feedback = '<table><tbody>';
                        $user_answers = $this->object->getSolutionValues($active_id);
                        $user_answer = '  '. $user_answers[0]['value1'];
                
                        foreach ($this->object->getAnswers() as $idx => $ans)
                        {
                                if ($this->object->isKeywordMatching($user_answer, $ans->getAnswertext() ))
                                {
                                        $fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
                                                        $this->object->getId(), $idx
                                        );
                                        $feedback .= '<tr><td><b><i>' . $ans->getAnswertext() . '</i></b></td><td>';
                                        $feedback .= $fb . '</td> </tr>';
                                }
                        }
                
                        $feedback .= '</tbody></table>';
                        return $this->object->prepareTextareaOutput($feedback, TRUE);
        }

Referenced by getSolutionOutput().

Here is the caller graph for this function:

◆ getTestOutput()

assTextQuestionGUI::getTestOutput	(	$active_id,
		$pass = `NULL`,
		$is_postponed = `FALSE`,
		$use_post_solutions = `FALSE`,
		$inlineFeedback = `false`
	)

Reimplemented from assQuestionGUI.

Definition at line 384 of file class.assTextQuestionGUI.php.

        {
                // get the solution of the user for the active pass or from the last pass if allowed
                $user_solution = "";
                if ($active_id)
                {
                        $solutions = NULL;
                        // hey: prevPassSolutions - obsolete due to central check
                        #include_once "./Modules/Test/classes/class.ilObjTest.php";
                        #if (!ilObjTest::_getUsePreviousAnswers($active_id, true))
                        #{
                        #       if (is_null($pass)) $pass = ilObjTest::_getPass($active_id);
                        #}
                        // hey.
                        $solutions = $this->object->getUserSolutionPreferingIntermediate($active_id, $pass);
                        foreach ($solutions as $idx => $solution_value)
                        {
                                $user_solution = $solution_value["value1"];
                        }
                }
                
                // generate the question output
                include_once "./Services/UICore/classes/class.ilTemplate.php";
                $template = new ilTemplate("tpl.il_as_qpl_text_question_output.html", TRUE, TRUE, "Modules/TestQuestionPool");
                if ($this->object->getMaxNumOfChars())
                {
                        $template->setCurrentBlock("maximum_char_hint");
                        $template->setVariable("MAXIMUM_CHAR_HINT", sprintf($this->lng->txt("text_maximum_chars_allowed"), $this->object->getMaxNumOfChars()));
                        $template->parseCurrentBlock();
                        #mbecker: No such block. $template->setCurrentBlock("has_maxchars");
                        $template->setVariable("MAXCHARS", $this->object->getMaxNumOfChars());
                        $template->parseCurrentBlock();
                        $template->setCurrentBlock("maxchars_counter");
                        $template->setVariable("MAXCHARS", $this->object->getMaxNumOfChars());
                        $template->setVariable("QID", $this->object->getId());
                        $template->setVariable("TEXTBOXSIZE", strlen($this->object->getMaxNumOfChars()));
                        $template->setVariable("CHARACTERS", $this->lng->txt("characters"));
                        $template->parseCurrentBlock();
                }
                $template->setVariable("QID", $this->object->getId());
                $template->setVariable("ESSAY", ilUtil::prepareFormOutput($user_solution));
                $questiontext = $this->object->getQuestion();
                $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
                $questionoutput = $template->get();
                
                $questionoutput .= $this->getJsCode();
                
                $pageoutput = $this->outQuestionPage("", $is_postponed, $active_id, $questionoutput);
                include_once "./Services/YUI/classes/class.ilYuiUtil.php";
                ilYuiUtil::initDomEvent();
                return $pageoutput;
        }

References $pass, getJsCode(), ilYuiUtil\initDomEvent(), assQuestionGUI\outQuestionPage(), ilUtil\prepareFormOutput(), and sprintf.

Here is the call graph for this function:

◆ getUserAnswer()

assTextQuestionGUI::getUserAnswer	(	$active_id,
		$pass
	)

private

Definition at line 329 of file class.assTextQuestionGUI.php.

        {
                $user_solution = "";
                $solutions     = $this->object->getSolutionValues( $active_id, $pass );
                foreach ($solutions as $idx => $solution_value)
                {
                        $user_solution = $solution_value["value1"];
                }
                return $user_solution;
        }

References $pass.

Referenced by getSolutionOutput().

Here is the caller graph for this function:

◆ magicAfterTestOutput()

assTextQuestionGUI::magicAfterTestOutput ( )

Reimplemented from assQuestionGUI.

Definition at line 120 of file class.assTextQuestionGUI.php.

        {
                // TODO - BEGIN: what exactly is done here? cant we use the parent method? 
 
                include_once "./Services/RTE/classes/class.ilRTE.php";
                $rtestring = ilRTE::_getRTEClassname();
                include_once "./Services/RTE/classes/class.$rtestring.php";
                $rte = new $rtestring();
                include_once "./Services/Object/classes/class.ilObject.php";
                $obj_id = ilObject::_lookupObjectId($_GET["ref_id"]);
                $obj_type = ilObject::_lookupType($_GET["ref_id"], TRUE);
                $rte->addUserTextEditor("textinput");
                $this->outAdditionalOutput();
 
                // TODO - END: what exactly is done here? cant we use the parent method? 
        }

References $_GET, ilRTE\_getRTEClassname(), ilObject\_lookupObjectId(), ilObject\_lookupType(), and outAdditionalOutput().

Here is the call graph for this function:

◆ outAdditionalOutput()

assTextQuestionGUI::outAdditionalOutput ( )

Reimplemented from assQuestionGUI.

Definition at line 116 of file class.assTextQuestionGUI.php.

117 {

118 }

Referenced by magicAfterTestOutput().

Here is the caller graph for this function:

◆ populateAnswerSpecificFormPart()

assTextQuestionGUI::populateAnswerSpecificFormPart ( \ilPropertyFormGUI $form )

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

        {
                $scoringMode = new ilRadioGroupInputGUI(
                        $this->lng->txt( 'essay_scoring_mode' ), 'scoring_mode'
                );
 
                $scoringOptionNone = new ilRadioOption($this->lng->txt( 'essay_scoring_mode_without_keywords' ),
                                                                                           'non', $this->lng->txt( 'essay_scoring_mode_without_keywords_desc'
                        )
                );
                $scoringOptionAnyKeyword = new ilRadioOption($this->lng->txt( 'essay_scoring_mode_keyword_relation_any' ),
                                                                                                         'any', $this->lng->txt( 'essay_scoring_mode_keyword_relation_any_desc'
                        )
                );
                $scoringOptionAllKeyword = new ilRadioOption($this->lng->txt( 'essay_scoring_mode_keyword_relation_all' ),
                                                                                                         'all', $this->lng->txt( 'essay_scoring_mode_keyword_relation_all_desc'
                        )
                );
                $scoringOptionOneKeyword = new ilRadioOption($this->lng->txt( 'essay_scoring_mode_keyword_relation_one' ),
                                                                                                         'one', $this->lng->txt( 'essay_scoring_mode_keyword_relation_one_desc'
                        )
                );
 
                $scoringMode->addOption( $scoringOptionNone );
                $scoringMode->addOption( $scoringOptionAnyKeyword );
                $scoringMode->addOption( $scoringOptionAllKeyword );
                $scoringMode->addOption( $scoringOptionOneKeyword );
                $scoringMode->setRequired( true );
                $scoringMode->setValue( strlen( $this->object->getKeywordRelation() ) ? $this->object->getKeywordRelation(
                                                                ) : 'non'
                );
 
                if ($this->object->getAnswerCount() == 0)
                {
                        $this->object->addAnswer( "", 1, 0, 0 );
                }
                require_once "./Modules/TestQuestionPool/classes/class.ilEssayKeywordWizardInputGUI.php";
 
                // Without Keywords
                $nonKeywordPoints = new ilNumberInputGUI($this->lng->txt( "points" ), "non_keyword_points");
                $nonKeywordPoints->allowDecimals(true);
                $nonKeywordPoints->setValue( $this->object->getPoints() );
                $nonKeywordPoints->setRequired( TRUE );
                $nonKeywordPoints->setSize( 3 );
                $nonKeywordPoints->setMinValue( 0.0 );
                $nonKeywordPoints->setMinvalueShouldBeGreater( true );
                $scoringOptionNone->addSubItem( $nonKeywordPoints );
 
                // Any Keyword
                $anyKeyword = new ilEssayKeywordWizardInputGUI($this->lng->txt( "answers" ), "any_keyword");
                $anyKeyword->setRequired( TRUE );
                $anyKeyword->setQuestionObject( $this->object );
                $anyKeyword->setSingleline( TRUE );
                $anyKeyword->setValues( $this->object->getAnswers() );
                $scoringOptionAnyKeyword->addSubItem( $anyKeyword );
 
                // All Keywords
                $allKeyword = new ilTextWizardInputGUI($this->lng->txt( "answers" ), "all_keyword");
                $allKeyword->setRequired( TRUE );
                //$allKeyword->setQuestionObject($this->object);
                //$allKeyword->setSingleline(TRUE);
                $allKeyword->setValues( self::buildAnswerTextOnlyArray( $this->object->getAnswers() ) );
                $scoringOptionAllKeyword->addSubItem( $allKeyword );
                $allKeywordPoints = new ilNumberInputGUI($this->lng->txt( "points" ), "all_keyword_points");
                $allKeywordPoints->allowDecimals(true);
                $allKeywordPoints->setValue( $this->object->getPoints() );
                $allKeywordPoints->setRequired( TRUE );
                $allKeywordPoints->setSize( 3 );
                $allKeywordPoints->setMinValue( 0.0 );
                $allKeywordPoints->setMinvalueShouldBeGreater( true );
                $scoringOptionAllKeyword->addSubItem( $allKeywordPoints );
 
                // One Keywords
                $oneKeyword = new ilTextWizardInputGUI($this->lng->txt( "answers" ), "one_keyword");
                $oneKeyword->setRequired( TRUE );
                //$oneKeyword->setQuestionObject($this->object);
                //$oneKeyword->setSingleline(TRUE);
                $oneKeyword->setValues( self::buildAnswerTextOnlyArray( $this->object->getAnswers() ) );
                $scoringOptionOneKeyword->addSubItem( $oneKeyword );
                $oneKeywordPoints = new ilNumberInputGUI($this->lng->txt( "points" ), "one_keyword_points");
                $oneKeywordPoints->allowDecimals(true);
                $oneKeywordPoints->setValue( $this->object->getPoints() );
                $oneKeywordPoints->setRequired( TRUE );
                $oneKeywordPoints->setSize( 3 );
                $oneKeywordPoints->setMinValue( 0.0 );
                $oneKeywordPoints->setMinvalueShouldBeGreater( true );
                $scoringOptionOneKeyword->addSubItem( $oneKeywordPoints );
 
                $form->addItem( $scoringMode );
        }

References ilPropertyFormGUI\addItem().

Referenced by editQuestion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateQuestionSpecificFormPart()

assTextQuestionGUI::populateQuestionSpecificFormPart ( \ilPropertyFormGUI $form )

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

        {
                // maxchars
                $maxchars = new ilNumberInputGUI($this->lng->txt( "maxchars" ), "maxchars");
                $maxchars->setSize( 5 );
                if ($this->object->getMaxNumOfChars() > 0)
                        $maxchars->setValue( $this->object->getMaxNumOfChars() );
                $maxchars->setInfo( $this->lng->txt( "description_maxchars" ) );
                $form->addItem( $maxchars );
 
                // text rating
                $textrating = new ilSelectInputGUI($this->lng->txt("text_rating"), "text_rating");
                $text_options = array(
                        "ci" => $this->lng->txt("cloze_textgap_case_insensitive"),
                        "cs" => $this->lng->txt("cloze_textgap_case_sensitive"),
                        "l1" => sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "1"),
                        "l2" => sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "2"),
                        "l3" => sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "3"),
                        "l4" => sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "4"),
                        "l5" => sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "5")
                );
                $textrating->setOptions($text_options);
                $textrating->setValue($this->object->getTextRating());
                $form->addItem($textrating);
 
                return $form;
        }

References ilPropertyFormGUI\addItem(), and sprintf.

Referenced by editQuestion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setQuestionTabs()

assTextQuestionGUI::setQuestionTabs ( )

Sets the ILIAS tabs for this question type.

@access public

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

Reimplemented from assQuestionGUI.

Definition at line 488 of file class.assTextQuestionGUI.php.

        {
                global $rbacsystem, $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");
                        // edit question properties
                        $ilTabs->addTarget("edit_question",
                                $url,
                                array("editQuestion", "save", "saveEdit", "originalSyncForm"),
                                $classname, "", $force_active);
                }
 
                // add tab for question feedback within common class assQuestionGUI
                $this->addTab_QuestionFeedback($ilTabs);
 
                // add tab for question hint within common class assQuestionGUI
                $this->addTab_QuestionHints($ilTabs);
 
                // add tab for question's suggested solution within common class assQuestionGUI
                $this->addTab_SuggestedSolution($ilTabs, $classname);
 
                // Assessment of questions sub menu entry
                if ($_GET["q_id"])
                {
                        $ilTabs->addTarget("statistics",
                                $this->ctrl->getLinkTargetByClass($classname, "assessment"),
                                array("assessment"),
                                $classname, "");
                }
 
                $this->addBackTab($ilTabs);
        }

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

Here is the call graph for this function:

◆ writeAnswerSpecificPostData()

assTextQuestionGUI::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 581 of file class.assTextQuestionGUI.php.

        {
                switch ($this->object->getKeywordRelation())
                {
                        case 'non':
                                $this->object->setAnswers( array() );
                                $this->object->setPoints( $_POST['non_keyword_points'] );
                                break;
                        case 'any':
                                $this->object->setAnswers( $_POST['any_keyword'] );
                                $this->object->setPoints( $this->object->getMaximumPoints() );
                                break;
                        case 'all':
                                $this->object->setAnswers( $_POST['all_keyword'] );
                                $this->object->setPoints( $_POST['all_keyword_points'] );
                                break;
                        case 'one':
                                $this->object->setAnswers( $_POST['one_keyword'] );
                                $this->object->setPoints( $_POST['one_keyword_points'] );
                                break;
                }
        }

References $_POST.

Referenced by writePostData().

Here is the caller graph for this function:

◆ writePostData()

assTextQuestionGUI::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 46 of file class.assTextQuestionGUI.php.

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

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

Referenced by addSuggestedSolution().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeQuestionSpecificPostData()

assTextQuestionGUI::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 574 of file class.assTextQuestionGUI.php.

        {
                $this->object->setMaxNumOfChars( $_POST["maxchars"] );
                $this->object->setTextRating( $_POST["text_rating"] );
                $this->object->setKeywordRelation( $_POST['scoring_mode'] );
        }

References $_POST.

Referenced by writePostData().

Here is the caller graph for this function:

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

Modules/TestQuestionPool/classes/class.assTextQuestionGUI.php

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addSuggestedSolution()

◆ buildAnswerTextOnlyArray()

◆ editQuestion()

◆ getAfterParticipationSuppressionAnswerPostVars()

◆ getAfterParticipationSuppressionQuestionPostVars()

◆ getAggregatedAnswersView()

◆ getBestAnswer()

◆ getJsCode()

◆ getPreview()

◆ getSolutionOutput()

◆ getSpecificFeedbackOutput()

◆ getTestOutput()

◆ getUserAnswer()

◆ magicAfterTestOutput()

◆ outAdditionalOutput()

◆ populateAnswerSpecificFormPart()

◆ populateQuestionSpecificFormPart()

◆ setQuestionTabs()

◆ writeAnswerSpecificPostData()

◆ writePostData()

◆ writeQuestionSpecificPostData()