assTextQuestionGUI Class Reference

Text question GUI representation. More...

Inheritance diagram for assTextQuestionGUI:

Collaboration diagram for assTextQuestionGUI:

Public Member Functions
	__construct ($id=-1)
	assTextQuestionGUI constructor
	writePostData ($always=false)
	Evaluates a posted edit form and writes the form data in the question object.
	editQuestion ($checkonly=FALSE)
	Creates an output of the edit form for the question.
	outAdditionalOutput ()
	outQuestionForTest ($formaction, $active_id, $pass=NULL, $is_postponed=FALSE, $use_post_solutions=FALSE)
	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.
	getPreview ($show_question_only=FALSE)
	getTestOutput ($active_id, $pass=NULL, $is_postponed=FALSE, $use_post_solutions=FALSE)
	addSuggestedSolution ()
	saveFeedback ()
	Saves the feedback for a single choice question.
	setQuestionTabs ()
	Sets the ILIAS tabs for this question type.
	getSpecificFeedbackOutput ($active_id, $pass)
	Returns the answer specific feedback for the question.
	feedback ($checkonly=false)
	Creates the output of the feedback page for a single choice question.
Public Member Functions inherited from assQuestionGUI
	__construct ()
	assQuestionGUI constructor
&	executeCommand ()
	execute command
	getCommand ($cmd)
	getType ()
	needed for page editor compliance
	writePostData ()
	Evaluates a posted edit form and writes the form data in the question object.
	assessment ()
	output assessment
&	_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.
	_getGUIClassNameForId ($a_q_id)
	_getClassNameForQType ($q_type)
&	createQuestionGUI ($question_type, $question_id=-1)
	Creates a question gui representation.
	getQuestionTemplate ()
	get question template
	getILIASPage ($html="")
	Returns the ILIAS Page around a question.
	outQuestionPage ($a_temp_var, $a_postponed=false, $active_id="", $html="")
	output question page
	cancel ()
	cancel action
	originalSyncForm ($return_to="")
	sync ()
	cancelSync ()
	saveEdit ()
	save question
	save ()
	save question
	saveReturn ()
	save question
	apply ()
	apply changes
	getContextPath ($cont_obj, $a_endnode_id, $a_startnode_id=1)
	get context path in content object tree
	setSequenceNumber ($nr)
	getSequenceNumber ()
	setQuestionCount ($a_question_count)
	getQuestionCount ()
	getErrorMessage ()
	setErrorMessage ($errormessage)
	addErrorMessage ($errormessage)
	getQuestionType ()
	Returns the question type string.
	getAsValueAttribute ($a_value)
	Returns a HTML value attribute.
	addNewIdListener (&$a_object, $a_method, $a_parameters="")
	Add a listener that is notified with the new question ID, when a new question is saved.
	callNewIdListeners ($a_new_id)
	Call the new id listeners.
	setSelfAssessmentEditingMode ($a_selfassessmenteditingmode)
	Set Self-Assessment Editing Mode.
	getSelfAssessmentEditingMode ()
	Get Self-Assessment Editing Mode.
	setPreventRteUsage ($a_val)
	Set prevent rte usage.
	getPreventRteUsage ()
	Get prevent rte usage.
	setDefaultNrOfTries ($a_defaultnroftries)
	Set Default Nr of Tries.
	getDefaultNrOfTries ()
	Get Default Nr of Tries.
	addQuestionFormCommandButtons ($form)
	Add the command buttons of a question properties form.
	addBasicQuestionFormProperties ($form)
	Add basic question form properties: assessment: title, author, description, question, working time.
	getSelfAssessmentTags ()
	Get tags allowed in question tags in self assessment mode.
	getAnswerFeedbackOutput ($active_id, $pass)
	Returns the answer generic feedback depending on the results of the question.
	getGenericFeedbackOutput ($active_id, $pass)
	Returns the answer specific feedback for the question.
	outQuestionType ()
	suggestedsolution ()
	Allows to add suggested solutions for questions.
	outSolutionExplorer ()
	saveSuggestedSolution ()
	cancelExplorer ()
	outPageSelector ()
	outChapterSelector ()
	outGlossarySelector ()
	linkChilds ()
	addPG ()
	addST ()
	addGIT ()
	isSaveCommand ()
	isAutosaveable ()
	showHints ()

Private Member Functions
	getBestAnswer ()
	getUserAnswer ($active_id, $pass)

Static Private Member Functions
static	buildAnswerTextOnlyArray ($answers)

Additional Inherited Members
Data Fields inherited from assQuestionGUI
	$object
	$tpl
	$lng
	$error
	$errormessage
	$sequence_no
	sequence number in test
	$question_count
	question count in test
	$prevent_rte_usage = false
	do not use rte for editing
Protected Member Functions inherited from assQuestionGUI
	addTab_QuestionHints (ilTabsGUI $tabs)
	adds the hints tab to ilTabsGUI

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

Version

$Id$

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

Constructor & Destructor Documentation

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 public

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

References assQuestionGUI\__construct().

        {
                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

assTextQuestionGUI::addSuggestedSolution

(

)

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

References $_POST, $_SESSION, editQuestion(), assQuestionGUI\getErrorMessage(), assQuestionGUI\getQuestionTemplate(), ilUtil\sendInfo(), and assQuestionGUI\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:

static assTextQuestionGUI::buildAnswerTextOnlyArray (   $answers )

staticprivate

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

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

assTextQuestionGUI::editQuestion

(

$checkonly = FALSE

)

Creates an output of the edit form for the question.

public

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

References $errors, assQuestionGUI\addBasicQuestionFormProperties(), assQuestionGUI\addQuestionFormCommandButtons(), ilSubEnabledFormPropertyGUI\addSubItem(), ilRadioOption\addSubItem(), assQuestionGUI\getQuestionTemplate(), assQuestionGUI\getSelfAssessmentEditingMode(), assQuestionGUI\isSaveCommand(), assQuestionGUI\outQuestionType(), ilFormPropertyGUI\setRequired(), ilNumberInputGUI\setSize(), ilNumberInputGUI\setValue(), and ilRadioOption\setValue().

Referenced by addSuggestedSolution(), and writePostData().

        {
                $save = $this->isSaveCommand();
                $this->getQuestionTemplate();

                include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                $form->setFormAction($this->ctrl->getFormAction($this));
                $form->setTitle($this->outQuestionType());
                $form->setMultipart(TRUE);
                $form->setTableWidth("100%");
                $form->setId("asstextquestion");
                
                // title, author, description, question, working time (assessment mode)
                $this->addBasicQuestionFormProperties($form);

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

                if (!$this->getSelfAssessmentEditingMode())
                {       
                        if( $this->object->getAnswerCount() == 0 )
                        {
                                $this->object->addAnswer("", 1, 0, 0);
                        }

                        $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');
                        
                        require_once "./Modules/TestQuestionPool/classes/class.ilEssayKeywordWizardInputGUI.php";

                        // Without Keywords
                                $nonKeywordPoints = new ilNumberInputGUI($this->lng->txt("points"), "non_keyword_points");
                                $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->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->setValue($this->object->getPoints());
                                $oneKeywordPoints->setRequired(TRUE);
                                $oneKeywordPoints->setSize(3);
                                $oneKeywordPoints->setMinValue(0.0);
                                $oneKeywordPoints->setMinvalueShouldBeGreater(true);
                        $scoringOptionOneKeyword->addSubItem($oneKeywordPoints);

                        $form->addItem($scoringMode);
                }
                
                $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:

assTextQuestionGUI::feedback

(

$checkonly = false

)

Creates the output of the feedback page for a single choice question.

public

Reimplemented from assQuestionGUI.

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

References $_GET, $errors, ilObjAdvancedEditing\_getUsedHTMLTags(), assQuestionGUI\getPreventRteUsage(), assQuestionGUI\getSelfAssessmentEditingMode(), and ilTextAreaInputGUI\setValue().

Referenced by saveFeedback().

        {
                $save = (strcmp($this->ctrl->getCmd(), "saveFeedback") == 0) ? TRUE : FALSE;
                include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                $form->setFormAction($this->ctrl->getFormAction($this));
                $form->setTitle($this->lng->txt('feedback_answers'));
                $form->setTableWidth("98%");
                $form->setId("feedback");

                $complete = new ilTextAreaInputGUI($this->lng->txt("feedback_complete_solution"), "feedback_complete");
                $complete->setValue($this->object->prepareTextareaOutput($this->object->getFeedbackGeneric(1)));
                $complete->setRequired(false);
                $complete->setRows(10);
                $complete->setCols(80);
                if (!$this->getPreventRteUsage())
                {
                        $complete->setUseRte(true);
                }
                include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
                $complete->setRteTags(ilObjAdvancedEditing::_getUsedHTMLTags("assessment"));
                $complete->addPlugin("latex");
                $complete->addButton("latex");
                $complete->addButton("pastelatex");
                $complete->setRTESupport($this->object->getId(), "qpl", "assessment", null, false, '3.4.7');
                $form->addItem($complete);

                $incomplete = new ilTextAreaInputGUI($this->lng->txt("feedback_incomplete_solution"), "feedback_incomplete");
                $incomplete->setValue($this->object->prepareTextareaOutput($this->object->getFeedbackGeneric(0)));
                $incomplete->setRequired(false);
                $incomplete->setRows(10);
                $incomplete->setCols(80);
                if (!$this->getPreventRteUsage())
                {
                        $incomplete->setUseRte(true);
                }
                include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
                $incomplete->setRteTags(ilObjAdvancedEditing::_getUsedHTMLTags("assessment"));
                $incomplete->addPlugin("latex");
                $incomplete->addButton("latex");
                $incomplete->addButton("pastelatex");
                $incomplete->setRTESupport($this->object->getId(), "qpl", "assessment", null, false, '3.4.7');
                $form->addItem($incomplete);

                if (!$this->getSelfAssessmentEditingMode())
                {
                        foreach ($this->object->getAnswers() as $index => $answer)
                        {
                                $caption = $ordinal = $index+1;
                                $caption .= '. ' . $answer->getAnswertext();

                                $answerobj = new ilTextAreaInputGUI($this->object->prepareTextareaOutput($caption, true), "feedback_answer_$index");
                                $answerobj->setValue($this->object->prepareTextareaOutput($this->object->getFeedbackSingleAnswer($index)));
                                $answerobj->setRequired(false);
                                $answerobj->setRows(10);
                                $answerobj->setCols(80);
                                $answerobj->setUseRte(true);
                                include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
                                $answerobj->setRteTags(ilObjAdvancedEditing::_getUsedHTMLTags("assessment"));
                                $answerobj->addPlugin("latex");
                                $answerobj->addButton("latex");
                                $answerobj->addButton("pastelatex");
                                $answerobj->setRTESupport($this->object->getId(), "qpl", "assessment", null, false, '3.4.7');
                                $form->addItem($answerobj);
                        }
                }

                global $ilAccess;
                if ($ilAccess->checkAccess("write", "", $_GET['ref_id']) || $this->getSelfAssessmentEditingMode())
                {
                        $form->addCommandButton("saveFeedback", $this->lng->txt("save"));
                }
                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 (!$checkonly) $this->tpl->setVariable("ADM_CONTENT", $form->getHTML());
                return $errors;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

assTextQuestionGUI::getBestAnswer ( )

private

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

References assTextQuestion\getScoringModesWithPointsByKeyword().

Referenced by getSolutionOutput().

        {
                $answers = $this->object->getAnswers();
                if (count( $answers ))
                {
                        $user_solution = $this->lng->txt( "solution_contain_keywords" ) . "<ul>";
                        
                        foreach ($answers as $answer)
                        {
                                $user_solution .= '<li>'. $answer->getAnswertext();
                                
                                if( in_array($this->object->getKeywordRelation(), assTextQuestion::getScoringModesWithPointsByKeyword()) )
                                {
                                        $user_solution .= ' ' . $this->lng->txt('for') . ' ';
                                        $user_solution .= $answer->getPoints() . ' ' . $this->lng->txt('points') . '</li>';
                                }
                        }
                        $user_solution .= '</ul>';
                        
                        $user_solution .= $this->lng->txt('essay_scoring_mode') . ': ';
                        
                        switch( $this->object->getKeywordRelation() )
                        {
                                case 'any':
                                        $user_solution .= $this->lng->txt('essay_scoring_mode_keyword_relation_any');
                                        break;
                                case 'all':
                                        $user_solution .= $this->lng->txt('essay_scoring_mode_keyword_relation_all');
                                        break;
                                case 'one':
                                        $user_solution .= $this->lng->txt('essay_scoring_mode_keyword_relation_one');
                                        break;
                        }
                }
                return $user_solution;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

assTextQuestionGUI::getPreview

(

$show_question_only = FALSE

)

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

References assQuestionGUI\getILIASPage().

        {
                // 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("TEXTBOXSIZE", strlen($this->object->getMaxNumOfChars()));
                        $template->setVariable("CHARACTERS", $this->lng->txt("characters"));
                        $template->parseCurrentBlock();
                }
                $questiontext = $this->object->getQuestion();
                $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
                $questionoutput = $template->get();
                if (!$show_question_only)
                {
                        // get page object output
                        $questionoutput = $this->getILIASPage($questionoutput);
                }
                return $questionoutput;
        }

Here is the call graph for this function:

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

References $pass, getBestAnswer(), assQuestionGUI\getGenericFeedbackOutput(), ilUtil\getImagePath(), getSpecificFeedbackOutput(), and getUserAnswer().

        {
                // get the solution of the user for the active pass or from the last pass if allowed
                
                if (($active_id > 0) && (!$show_correct_solution))
                {
                        $solution = $this->getUserAnswer( $active_id, $pass );
                }
                else
                {
                        $solution = $this->getBestAnswer();
                }
                $user_solution = $this->getUserAnswer( $active_id, $pass );
                
                // 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);

                $template->setVariable("ESSAY", $this->object->prepareTextareaOutput($solution, TRUE));
                $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 = strlen(strip_tags($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.png"));
                                        $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.png"));
                                                $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.png"));
                                                $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)
                {
                        $fb = $this->getGenericFeedbackOutput($active_id, $pass);
                        $feedback .=  strlen($fb) ? $fb : '';
                        
                        $fb = $this->getSpecificFeedbackOutput($active_id, $pass);
                        $feedback .=  strlen($fb) ? $fb : '';
                }
                if (strlen($feedback)) $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 = '<div class="ilc_question_Standard">'.$solutionoutput."</div>";
                }
                return $solutionoutput;
        }

Here is the call graph for this function:

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 public

Reimplemented from assQuestionGUI.

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

Referenced by getSolutionOutput().

        {
                        $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() ))
                                {
                                        $feedback .= '<tr><td><b><i>' . $ans->getAnswertext() . '</i></b></td><td>';
                                        $feedback .= $this->object->getFeedbackSingleAnswer($idx) . '</td> </tr>';
                                }
                        }
                
                        $feedback .= '</tbody></table>';
                        return $this->object->prepareTextareaOutput($feedback, TRUE);
        }

Here is the caller graph for this function:

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

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

References $pass, ilObjTest\_getPass(), ilObjTest\_getUsePreviousAnswers(), ilYuiUtil\initDomEvent(), assQuestionGUI\outQuestionPage(), and ilUtil\prepareFormOutput().

Referenced by outQuestionForTest().

        {
                // get the solution of the user for the active pass or from the last pass if allowed
                $user_solution = "";
                if ($active_id)
                {
                        $solutions = NULL;
                        include_once "./Modules/Test/classes/class.ilObjTest.php";
                        if (!ilObjTest::_getUsePreviousAnswers($active_id, true))
                        {
                                if (is_null($pass)) $pass = ilObjTest::_getPass($active_id);
                        }
                        $solutions =& $this->object->getSolutionValues($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("TEXTBOXSIZE", strlen($this->object->getMaxNumOfChars()));
                        $template->setVariable("CHARACTERS", $this->lng->txt("characters"));
                        $template->parseCurrentBlock();
                }
                $template->setVariable("ESSAY", ilUtil::prepareFormOutput($user_solution));
                $questiontext = $this->object->getQuestion();
                $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
                $questionoutput = $template->get();
                $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:

Here is the caller graph for this function:

assTextQuestionGUI::getUserAnswer (   $active_id,   $pass  )

private

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

References $pass.

Referenced by getSolutionOutput().

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

Here is the caller graph for this function:

assTextQuestionGUI::outAdditionalOutput

(

)

Reimplemented from assQuestionGUI.

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

Referenced by outQuestionForTest().

        {
                if ($this->object->getMaxNumOfChars() > 0)
                {
                        $this->tpl->addBlockFile("CONTENT_BLOCK", "charcounter", "tpl.charcounter.html", "Modules/TestQuestionPool");
                        $this->tpl->setCurrentBlock("charcounter");
                        $this->tpl->setVariable("MAXCHARS", $this->object->getMaxNumOfChars());
                        $this->tpl->parseCurrentBlock();
                }
        }

Here is the caller graph for this function:

assTextQuestionGUI::outQuestionForTest	(		$formaction,
			$active_id,
			$pass = NULL,
			$is_postponed = FALSE,
			$use_post_solutions = FALSE
	)

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

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

        {
                $test_output = $this->getTestOutput($active_id, $pass, $is_postponed, $use_post_solutions); 
                $this->tpl->setVariable("QUESTION_OUTPUT", $test_output);
                $this->tpl->setVariable("FORMACTION", $formaction);
                include_once "./Services/RTE/classes/class.ilRTE.php";
                $rtestring = ilRTE::_getRTEClassname();
                include_once "./Services/RTE/classes/class.$rtestring.php";
                $rte = new $rtestring('3.4.7');
                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();
        }

Here is the call graph for this function:

assTextQuestionGUI::saveFeedback

(

)

Saves the feedback for a single choice question.

public

Reimplemented from assQuestionGUI.

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

References $_POST, $errors, and feedback().

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

Here is the call graph for this function:

assTextQuestionGUI::setQuestionTabs

(

)

Sets the ILIAS tabs for this question type.

public

Todo:

: MOVE THIS STEPS TO COMMON QUESTION CLASS assQuestionGUI

Reimplemented from assQuestionGUI.

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

References $_GET, $ref_id, assQuestionGUI\addTab_QuestionHints(), and ilTestExpressPage\getReturnToPageLink().

        {
                global $rbacsystem, $ilTabs;
                
                $this->ctrl->setParameterByClass("ilpageobjectgui", "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("ilPageObjectGUI", "edit"),
                                        array("edit", "insert", "exec_pg"),
                                        "", "", $force_active);
                        }
        
                        // edit page
                        $ilTabs->addTarget("preview",
                                $this->ctrl->getLinkTargetByClass("ilPageObjectGUI", "preview"),
                                array("preview"),
                                "ilPageObjectGUI", "", $force_active);
                }

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

                if ($_GET["q_id"])
                {
                        $ilTabs->addTarget("feedback",
                                $this->ctrl->getLinkTargetByClass($classname, "feedback"),
                                array("feedback", "saveFeedback"),
                                $classname, "");
                }

                // add tab for question hint within common class assQuestionGUI
                $this->addTab_QuestionHints($ilTabs);
                
                if ($_GET["q_id"])
                {
                        $ilTabs->addTarget("solution_hint",
                                $this->ctrl->getLinkTargetByClass($classname, "suggestedsolution"),
                                array("suggestedsolution", "saveSuggestedSolution", "outSolutionExplorer", "cancel", 
                                "addSuggestedSolution","cancelExplorer", "linkChilds", "removeSuggestedSolution"
                                ),
                                $classname, 
                                ""
                        );
                }

                // Assessment of questions sub menu entry
                if ($_GET["q_id"])
                {
                        $ilTabs->addTarget("statistics",
                                $this->ctrl->getLinkTargetByClass($classname, "assessment"),
                                array("assessment"),
                                $classname, "");
                }
                
                if (($_GET["calling_test"] > 0) || ($_GET["test_ref_id"] > 0))
                {
                        $ref_id = $_GET["calling_test"];
                        if (strlen($ref_id) == 0) $ref_id = $_GET["test_ref_id"];

                        global $___test_express_mode;

                        if (!$_GET['test_express_mode'] && !$___test_express_mode) {
                            $ilTabs->setBackTarget($this->lng->txt("backtocallingtest"), "ilias.php?baseClass=ilObjTestGUI&cmd=questions&ref_id=$ref_id");
                        }
                        else {
                            $link = ilTestExpressPage::getReturnToPageLink();
                            $ilTabs->setBackTarget($this->lng->txt("backtocallingtest"), $link);
                        }
                }
                else
                {
                        $ilTabs->setBackTarget($this->lng->txt("qpl"), $this->ctrl->getLinkTargetByClass("ilobjquestionpoolgui", "questions"));
                }
        }

Here is the call graph for this function:

assTextQuestionGUI::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 private

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

References $_POST, editQuestion(), and assQuestionGUI\getSelfAssessmentEditingMode().

        {
                $hasErrors = (!$always) ? $this->editQuestion(true) : false;
                if (!$hasErrors)
                {
                        $this->object->setTitle($_POST["title"]);
                        $this->object->setAuthor($_POST["author"]);
                        $this->object->setComment($_POST["comment"]);
                        include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
                        $questiontext = $_POST["question"];
                        $this->object->setQuestion($questiontext);
                        $this->object->setMaxNumOfChars($_POST["maxchars"]);
                        $this->object->setTextRating($_POST["text_rating"]);
                        if ($this->getSelfAssessmentEditingMode())
                        {
                                $this->object->setNrOfTries($_POST['nr_of_tries']);
                        }
                        $this->object->setEstimatedWorkingTime(
                                $_POST["Estimated"]["hh"],
                                $_POST["Estimated"]["mm"],
                                $_POST["Estimated"]["ss"]
                        );
                        $this->object->setKeywordRelation($_POST['scoring_mode']);
                        
                        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;
                        }
                        
                        return 0;
                }
                else
                {
                        return 1;
                }
        }

Here is the call graph for this function:

---

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

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