assTextQuestionGUI Class Reference

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 ()
	supportsIntermediateSolutionOutput ()
	Question type specific support of intermediate solution output The function getSolutionOutput respects getUseIntermediateSolution() More...
	getSolutionOutput ( $active_id, $pass=null, $graphicalOutput=false, $result_output=false, $show_question_only=true, $show_feedback=false, $show_correct_solution=false, $show_manual_scoring=false, $show_question_text=true)
	Get the question solution output. More...
	getPreview ($show_question_only=false, $showInlineFeedback=false)
	getTestOutput ($active_id, $pass=null, $is_postponed=false, $use_post_solutions=false, $inlineFeedback=false)
	addSuggestedSolution ()
	getSpecificFeedbackOutput ($userSolution)
	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...
	isAnswerFreuqencyStatisticSupported ()
	getAnswersFrequency ($relevantAnswers, $questionIndex)
	populateCorrectionsFormProperties (ilPropertyFormGUI $form)
	saveCorrectionsFormProperties (ilPropertyFormGUI $form)
Public Member Functions inherited from assQuestionGUI
	__construct ()
	assQuestionGUI constructor More...
	hasInlineFeedback ()
	this method can be overwritten per question type More...
	addHeaderAction ()
	redrawHeaderAction ()
	getHeaderAction ()
	getNotesHTML ()
	executeCommand ()
	execute command More...
	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 (ilGlobalTemplateInterface $tpl)
	getPresentationJavascripts ()
	getQuestionTemplate ()
	get question template More...
	getILIASPage ($html="")
	Returns the ILIAS Page around a question. More...
	outQuestionPage ($a_temp_var, $a_postponed=false, $active_id="", $html="", $inlineFeedbackEnabled=false)
	output question page More...
	cancel ()
	cancel action More...
	originalSyncForm ($return_to="", $return_to_feedback='')
	sync ()
	cancelSync ()
	saveEdit ()
	save question More...
	save ()
	save question More...
	saveReturn ()
	save question More...
	apply ()
	apply changes More...
	getContextPath ($cont_obj, $a_endnode_id, $a_startnode_id=1)
	get context path in content object tree More...
	setSequenceNumber ($nr)
	getSequenceNumber ()
	setQuestionCount ($a_question_count)
	getQuestionCount ()
	getErrorMessage ()
	setErrorMessage ($errormessage)
	addErrorMessage ($errormessage)
	outAdditionalOutput ()
	getQuestionType ()
	Returns the question type string. More...
	getAsValueAttribute ($a_value)
	Returns a HTML value attribute. More...
	addNewIdListener (&$a_object, $a_method, $a_parameters="")
	Add a listener that is notified with the new question ID, when a new question is saved. More...
	callNewIdListeners ($a_new_id)
	Call the new id listeners. More...
	addQuestionFormCommandButtons ($form)
	Add the command buttons of a question properties form. More...
	addBasicQuestionFormProperties ($form)
	Add basic question form properties: assessment: title, author, description, question, working time. More...
	getAnswerFeedbackOutput ($active_id, $pass)
	Returns the answer generic feedback depending on the results of the question. More...
	getGenericFeedbackOutput ($active_id, $pass)
	Returns the answer specific feedback for the question. More...
	getGenericFeedbackOutputForCorrectSolution ()
	getGenericFeedbackOutputForIncorrectSolution ()
	getSpecificFeedbackOutput ($userSolution)
	Returns the answer specific feedback for the question. More...
	outQuestionType ()
	showSuggestedSolution ()
	suggestedsolution ()
	Allows to add suggested solutions for questions. More...
	outSolutionExplorer ()
	saveSuggestedSolution ()
	cancelExplorer ()
	outPageSelector ()
	outChapterSelector ()
	outGlossarySelector ()
	linkChilds ()
	addPG ()
	addST ()
	addGIT ()
	isSaveCommand ()
	setQuestionTabs ()
	addTab_SuggestedSolution (ilTabsGUI $tabs, $classname)
	getEditQuestionTabCommands ()
	getSolutionOutput ( $active_id, $pass=null, $graphicalOutput=false, $result_output=false, $show_question_only=true, $show_feedback=false, $show_correct_solution=false, $show_manual_scoring=false, $show_question_text=true)
	supportsIntermediateSolutionOutput ()
	Question type specific support of intermediate solution output The function getSolutionOutput respects getUseIntermediateSolution() More...
	hasIntermediateSolution ($activeId, $passIndex)
	Check if the question has an intermediate solution. More...
	setUseIntermediateSolution ($use)
	getUseIntermediateSolution ()
	Get if intermediate solution should be used for solution output. More...
	isAutosaveable ()
	getPreview ($show_question_only=false, $showInlineFeedback=false)
	outQuestionForTest ( $formaction, $active_id, $pass, $is_question_postponed=false, $user_post_solutions=false, $show_specific_inline_feedback=false)
	magicAfterTestOutput ()
	getTestOutput ( $active_id, $pass, $is_question_postponed, $user_post_solutions, $show_specific_inline_feedback)
	getFormEncodingType ()
	setPreviewSession ($previewSession)
	getPreviewSession ()
	showHints ()
	buildFocusAnchorHtml ()
	isAnswerFreuqencyStatisticSupported ()
	getSubQuestionsIndex ()
	getAnswersFrequency ($relevantAnswers, $questionIndex)
	getAnswerFrequencyTableGUI ($parentGui, $parentCmd, $relevantAnswers, $questionIndex)
	prepareReprintableCorrectionsForm (ilPropertyFormGUI $form)
	populateCorrectionsFormProperties (ilPropertyFormGUI $form)
	saveCorrectionsFormProperties (ilPropertyFormGUI $form)
Public Member Functions inherited from ilGuiQuestionScoringAdjustable
	populateQuestionSpecificFormPart (ilPropertyFormGUI $form)
	Adds the question specific forms parts to a question property form gui. More...
Public Member Functions inherited from ilGuiAnswerScoringAdjustable
	populateAnswerSpecificFormPart (ilPropertyFormGUI $form)
	Adds the answer specific form parts to a question property form gui. More...

Protected Member Functions
	writePostData ($always=false)
	{} More...
	getJsCode ()
Protected Member Functions inherited from assQuestionGUI
	hasSpecialQuestionCommands ()
	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)
	setDefaultTabs (ilTabsGUI $ilTabs)
	setQuestionSpecificTabs (ilTabsGUI $ilTabs)
	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_Question (ilTabsGUI $tabsGUI)
	hasCorrectSolution ($activeId, $passIndex)
	writeQuestionGenericPostData ()
	completeTestOutputFormAction ($formAction, $active_id, $pass)
	addBackTab (ilTabsGUI $ilTabs)
	buildBasicEditFormObject ()
	escapeTemplatePlaceholders (string $text)
	buildEditForm ()
	addSaveOnEnterOnLoadCode ()

Protected Attributes
	$tiny_mce_enabled
Protected Attributes inherited from assQuestionGUI
const	HAS_SPECIAL_QUESTION_COMMANDS = false
	$ctrl
	$editForm
	$use_intermediate_solution = false

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
	$request
	$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'

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$

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

References ILIAS\GlobalScreen\Provider\__construct().

    {
        $this->tiny_mce_enabled = (new ilSetting('advanced_editing'))->get('advanced_editing_javascript_editor')
            === 'tinymce' ? true : false;
        parent::__construct();
        include_once "./Modules/TestQuestionPool/classes/class.assTextQuestion.php";
        $this->object = new assTextQuestion();
        if ($id >= 0) {
            $this->object->loadFromDb($id);
        }
    }

Here is the call graph for this function:

Member Function Documentation

addSuggestedSolution()

assTextQuestionGUI::addSuggestedSolution

(

)

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

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

    {
        $_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();
    }

Here is the call graph for this function:

buildAnswerTextOnlyArray()

static assTextQuestionGUI::buildAnswerTextOnlyArray (   $answers )

staticprivate

Definition at line 108 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.

public

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

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

Referenced by addSuggestedSolution(), and writePostData().

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

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 700 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 714 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 727 of file class.assTextQuestionGUI.php.

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

getAnswersFrequency()

assTextQuestionGUI::getAnswersFrequency	(		$relevantAnswers,
			$questionIndex
	)

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

    {
    }

getBestAnswer()

assTextQuestionGUI::getBestAnswer (   $asHtml )

private

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

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

Referenced by getSolutionOutput().

    {
        $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 = '';
            if (in_array($this->object->getKeywordRelation(), assTextQuestion::getScoringModesWithPointsByKeyword())) {
                $keywordString .= $answer->getPoints() . ' ';
                if ($answer->getPoints() == '1' || $answer->getPoints() == '-1') {
                    $keywordString .= $this->lng->txt('point');
                } else {
                    $keywordString .= $this->lng->txt('points');
                }
                $keywordString .= ' ' . $this->lng->txt('for') . ' ';
            }
            $keywordString .= $answer->getAnswertext();

            $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();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getJsCode()

assTextQuestionGUI::getJsCode ( )

protected

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

References assQuestionGUI\$tpl.

Referenced by getPreview(), and getTestOutput().

    {
        $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("MAXCHARS", $this->object->getMaxNumOfChars());
            $tpl->parseCurrentBlock();
        }

        if ($this->object->isWordCounterEnabled()) {
            $tpl->setCurrentBlock('word_counter_js');
            $tpl->touchBlock('word_counter_js');
            $tpl->parseCurrentBlock();
        }

        $tpl->setCurrentBlock('counter_js');
        $tpl->setVariable("QID", $this->object->getId());
        $tpl->parseCurrentBlock();

        return $tpl->get();
    }

Here is the caller graph for this function:

getPreview()

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

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

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

    {
        // 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("qst_essay_chars_remaining"));
            $template->parseCurrentBlock();
        }

        if ($this->object->isWordCounterEnabled()) {
            $template->setCurrentBlock("word_counter");
            $template->setVariable("QID", $this->object->getId());
            $template->setVariable("WORDCOUNTER", $this->lng->txt("qst_essay_allready_written_words"));
            $template->parseCurrentBlock();
        }

        if (is_object($this->getPreviewSession())) {
            $template->setVariable("ESSAY", ilUtil::prepareFormOutput(
                $this->getPreviewSession()->getParticipantsSolution()
            ));
        }

        $template->setVariable("QUESTIONTEXT", $this->object->getQuestionForHTMLOutput());
        $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;
    }

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

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

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

      {
        // 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();

        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($solution);
            $template->setVariable("CHARACTER_INFO", '<b>' . $max_no_of_chars . '</b>' .
                $this->lng->txt('answer_characters') . ' <b>' . $act_no_of_chars . '</b>');
        }

        if ($this->object->isWordCounterEnabled()) {
            $template->setCurrentBlock('word_count');
            $template->setVariable(
                'WORD_COUNT',
                $this->lng->txt('qst_essay_written_words') .
                ' <b>' . $this->object->countWords($solution) . '</b>'
            );
            $template->parseCurrentBlock();
        }

        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->getQuestionForHTMLOutput());
        }
        $questionoutput = $template->get();

        $feedback = '';
        if ($show_feedback) {
            if (!$this->isTestPresentationContext()) {
                $fb = $this->getGenericFeedbackOutput($active_id, $pass);
                $feedback .= strlen($fb) ? $fb : '';
            }

            $fb = $this->getSpecificFeedbackOutput(
                array($user_solution => '')
            );

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

Here is the call graph for this function:

getSpecificFeedbackOutput()

assTextQuestionGUI::getSpecificFeedbackOutput

(

$userSolution

)

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

Referenced by getSolutionOutput().

    {
        $user_answer = key($userSolution);

        $feedback = '';

        foreach ($this->object->getAnswers() as $idx => $ans) {
            if ($this->object->isKeywordMatching($user_answer, htmlspecialchars($ans->getAnswertext()))) {
                $fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
                    $this->object->getId(),
                    0,
                    $idx
                );
                $feedback .= '<tr><td><b><i>' . $ans->getAnswertext() . '</i></b></td><td>';
                $feedback .= $fb . '</td> </tr>';
            }
        }

        if ($feedback === '') {
            return '';
        }

        $feedback = '<table><tbody>' . $feedback . '</tbody></table>';
        return $this->object->prepareTextareaOutput($feedback, true);
    }

Here is the caller graph for this function:

getTestOutput()

assTextQuestionGUI::getTestOutput	(		$active_id,
			$pass = null,
			$is_postponed = false,
			$use_post_solutions = false,
			$inlineFeedback = false
	)

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

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

    {
        // get the solution of the user for the active pass or from the last pass if allowed
        $user_solution = "";
        if ($active_id) {
            $solutions = null;

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

            if ($this->tiny_mce_enabled) {
                $user_solution = htmlentities($user_solution);
            }

            $user_solution = str_replace(['{', '}', '\\'], ['&#123', '&#125', '&#92'], $user_solution);
        }

        // 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("qst_essay_chars_remaining"));
            $template->parseCurrentBlock();
        }

        if ($this->object->isWordCounterEnabled()) {
            $template->setCurrentBlock("word_counter");
            $template->setVariable("QID", $this->object->getId());
            $template->setVariable("WORDCOUNTER", $this->lng->txt("qst_essay_allready_written_words"));
            $template->parseCurrentBlock();
        }

        $template->setVariable("QID", $this->object->getId());
        $template->setVariable("ESSAY", $user_solution);
        $template->setVariable("QUESTIONTEXT", $this->object->getQuestionForHTMLOutput());
        $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;
    }

Here is the call graph for this function:

getUserAnswer()

assTextQuestionGUI::getUserAnswer (   $active_id,   $pass  )

private

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

References $pass, and assQuestionGUI\getUseIntermediateSolution().

Referenced by getSolutionOutput().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isAnswerFreuqencyStatisticSupported()

assTextQuestionGUI::isAnswerFreuqencyStatisticSupported

(

)

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

    {
        return false;
    }

magicAfterTestOutput()

assTextQuestionGUI::magicAfterTestOutput

(

)

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

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

    {
        // 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?
    }

Here is the call graph for this function:

outAdditionalOutput()

assTextQuestionGUI::outAdditionalOutput

(

)

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

Referenced by magicAfterTestOutput().

    {
    }

Here is the caller graph for this function:

populateAnswerSpecificFormPart()

assTextQuestionGUI::populateAnswerSpecificFormPart

(

\ilPropertyFormGUI

$form

)

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

References ilPropertyFormGUI\addItem(), ilSubEnabledFormPropertyGUI\addSubItem(), ilRadioOption\addSubItem(), ilNumberInputGUI\allowDecimals(), ilFormPropertyGUI\setRequired(), and ilRadioOption\setValue().

Referenced by editQuestion(), and populateCorrectionsFormProperties().

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

Here is the call graph for this function:

Here is the caller graph for this function:

populateCorrectionsFormProperties()

assTextQuestionGUI::populateCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

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

References populateAnswerSpecificFormPart(), populateQuestionSpecificFormPart(), and ilPropertyFormGUI\removeItemByPostVar().

    {
        $this->populateQuestionSpecificFormPart($form);
        $this->populateAnswerSpecificFormPart($form);

        $form->removeItemByPostVar('maxchars');
    }

Here is the call graph for this function:

populateQuestionSpecificFormPart()

assTextQuestionGUI::populateQuestionSpecificFormPart

(

\ilPropertyFormGUI

$form

)

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

References ilPropertyFormGUI\addItem(), ilFormPropertyGUI\setInfo(), and ilNumberInputGUI\setSize().

Referenced by editQuestion(), and populateCorrectionsFormProperties().

    {
        // wordcounter
        $wordcounter = new ilCheckboxInputGUI($this->lng->txt('qst_essay_wordcounter_enabled'), 'wordcounter');
        $wordcounter->setInfo($this->lng->txt('qst_essay_wordcounter_enabled_info'));
        $wordcounter->setChecked($this->object->isWordCounterEnabled());
        $form->addItem($wordcounter);

        // maxchars
        $maxchars = new ilNumberInputGUI($this->lng->txt("maxchars"), "maxchars");
        $maxchars->setSize(5);
        $maxchars->setMinValue(1);
        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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveCorrectionsFormProperties()

assTextQuestionGUI::saveCorrectionsFormProperties

(

ilPropertyFormGUI

$form

)

Parameters

ilPropertyFormGUI

$form

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

References writeAnswerSpecificPostData(), and writeQuestionSpecificPostData().

    {
        $this->writeQuestionSpecificPostData($form);
        $this->writeAnswerSpecificPostData($form);
    }

Here is the call graph for this function:

supportsIntermediateSolutionOutput()

assTextQuestionGUI::supportsIntermediateSolutionOutput

(

)

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

Returns

bool

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

    {
        return true;
    }

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

References $_POST.

Referenced by saveCorrectionsFormProperties(), and writePostData().

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

Here is the caller graph for this function:

writePostData()

assTextQuestionGUI::writePostData (   $always = false )

protected

{}

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

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

Referenced by addSuggestedSolution().

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

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

References $_POST.

Referenced by saveCorrectionsFormProperties(), and writePostData().

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

Here is the caller graph for this function:

Field Documentation

$tiny_mce_enabled

assTextQuestionGUI::$tiny_mce_enabled

protected

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

---

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

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