Text question GUI representation. More...
Inheritance diagram for assTextQuestionGUI:
Collaboration diagram for assTextQuestionGUI:
Public Member Functions | |
| assTextQuestionGUI ($id=-1) | |
| assTextQuestionGUI constructor | |
| getQuestionType () | |
| Returns the question type string. | |
| editQuestion () | |
| Creates an output of the edit form for the question. | |
| checkInput () | |
| check input fields | |
| writePostData () | |
| Evaluates a posted edit form and writes the form data in the question object. | |
| 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) | |
| getPreview () | |
| getTestOutput ($active_id, $pass=NULL, $is_postponed=FALSE, $use_post_solutions=FALSE) | |
| addSuggestedSolution () | |
| Handler for cmd[addSuggestedSolution] to add a suggested solution for the question. | |
Detailed Description
Text question GUI representation.
The assTextQuestionGUI class encapsulates the GUI representation for text questions.
- Version:
- Id:
- class.assTextQuestionGUI.php 14114 2007-06-12 14:41:49Z hschottm
class.assTextQuestionGUI.php assessment
Definition at line 38 of file class.assTextQuestionGUI.php.
Member Function Documentation
| assTextQuestionGUI::addSuggestedSolution | ( | ) |
Handler for cmd[addSuggestedSolution] to add a suggested solution for the question.
Handler for cmd[addSuggestedSolution] to add a suggested solution for the question
public
Reimplemented from assQuestionGUI.
Definition at line 412 of file class.assTextQuestionGUI.php.
References $_GET, $_POST, $_SESSION, checkInput(), editQuestion(), assQuestionGUI::getErrorMessage(), assQuestionGUI::getQuestionTemplate(), sendInfo(), and writePostData().
{
$_SESSION["subquestion_index"] = 0;
if ($_POST["cmd"]["addSuggestedSolution"])
{
if ($this->writePostData())
{
sendInfo($this->getErrorMessage());
$this->editQuestion();
return;
}
if (!$this->checkInput())
{
sendInfo($this->lng->txt("fill_out_all_required_fields_add_answer"));
$this->editQuestion();
return;
}
}
$this->object->saveToDb();
$_GET["q_id"] = $this->object->getId();
$this->tpl->setVariable("HEADER", $this->object->getTitle());
$this->getQuestionTemplate();
parent::addSuggestedSolution();
}
Here is the call graph for this function:
| assTextQuestionGUI::assTextQuestionGUI | ( | $ | 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 $id, and assQuestionGUI::assQuestionGUI().
{
$this->assQuestionGUI();
include_once "./assessment/classes/class.assTextQuestion.php";
$this->object = new assTextQuestion();
if ($id >= 0)
{
$this->object->loadFromDb($id);
}
}
Here is the call graph for this function:
| assTextQuestionGUI::checkInput | ( | ) |
check input fields
Definition at line 198 of file class.assTextQuestionGUI.php.
Referenced by addSuggestedSolution().
{
$cmd = $this->ctrl->getCmd();
if ((!$_POST["title"]) or (!$_POST["author"]) or (!$_POST["question"]) or (strlen($_POST["points"]) == 0))
{
return false;
}
return true;
}
Here is the caller graph for this function:
| assTextQuestionGUI::editQuestion | ( | ) |
Creates an output of the edit form for the question.
Creates an output of the edit form for the question
public
Definition at line 81 of file class.assTextQuestionGUI.php.
References $_GET, $key, $keywords, $obj_id, assQuestion::_getInternalLinkHref(), ilRTE::_getRTEClassname(), ilObject::_lookupType(), assQuestionGUI::getQuestionTemplate(), assQuestionGUI::outOtherQuestionData(), and ilUtil::prepareFormOutput().
Referenced by addSuggestedSolution().
{
$javascript = "<script type=\"text/javascript\">function initialSelect() {\n%s\n}</script>";
// single response
$this->getQuestionTemplate();
$this->tpl->addBlockFile("QUESTION_DATA", "question_data", "tpl.il_as_qpl_text_question.html", true);
// call to other question data i.e. estimated working time block
$this->outOtherQuestionData();
$internallinks = array(
"lm" => $this->lng->txt("obj_lm"),
"st" => $this->lng->txt("obj_st"),
"pg" => $this->lng->txt("obj_pg"),
"glo" => $this->lng->txt("glossary_term")
);
foreach ($internallinks as $key => $value)
{
$this->tpl->setCurrentBlock("internallink");
$this->tpl->setVariable("TYPE_INTERNAL_LINK", $key);
$this->tpl->setVariable("TEXT_INTERNAL_LINK", $value);
$this->tpl->parseCurrentBlock();
}
// Add text rating options
$text_options = array(
array("ci", $this->lng->txt("cloze_textgap_case_insensitive")),
array("cs", $this->lng->txt("cloze_textgap_case_sensitive")),
array("l1", sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "1")),
array("l2", sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "2")),
array("l3", sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "3")),
array("l4", sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "4")),
array("l5", sprintf($this->lng->txt("cloze_textgap_levenshtein_of"), "5"))
);
$text_rating = $this->object->getTextRating();
foreach ($text_options as $text_option)
{
$this->tpl->setCurrentBlock("text_rating");
$this->tpl->setVariable("RATING_VALUE", $text_option[0]);
$this->tpl->setVariable("RATING_TEXT", $text_option[1]);
if (strcmp($text_rating, $text_option[0]) == 0)
{
$this->tpl->setVariable("SELECTED_RATING_VALUE", " selected=\"selected\"");
}
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("HeadContent");
$this->tpl->setVariable("CONTENT_BLOCK", sprintf($javascript, "document.frm_text_question.title.focus();"));
$this->tpl->parseCurrentBlock();
$this->tpl->setCurrentBlock("question_data");
$this->tpl->setVariable("TEXT_QUESTION_ID", $this->object->getId());
$this->tpl->setVariable("VALUE_TEXT_QUESTION_TITLE", ilUtil::prepareFormOutput($this->object->getTitle()));
$this->tpl->setVariable("VALUE_TEXT_QUESTION_COMMENT", ilUtil::prepareFormOutput($this->object->getComment()));
$this->tpl->setVariable("VALUE_TEXT_QUESTION_AUTHOR", ilUtil::prepareFormOutput($this->object->getAuthor()));
$questiontext = $this->object->getQuestion();
$this->tpl->setVariable("VALUE_QUESTION", ilUtil::prepareFormOutput($this->object->prepareTextareaOutput($questiontext)));
$keywords = $this->object->getKeywords();
$this->tpl->setVariable("VALUE_KEYWORDS", ilUtil::prepareFormOutput($keywords));
$this->tpl->setVariable("VALUE_POINTS", ilUtil::prepareFormOutput($this->object->getPoints()));
if ($this->object->getMaxNumOfChars())
{
$this->tpl->setVariable("VALUE_MAXCHARS", ilUtil::prepareFormOutput($this->object->getMaxNumOfChars()));
}
$this->tpl->setVariable("TEXT_TITLE", $this->lng->txt("title"));
$this->tpl->setVariable("TEXT_AUTHOR", $this->lng->txt("author"));
$this->tpl->setVariable("TEXT_COMMENT", $this->lng->txt("description"));
$this->tpl->setVariable("TEXT_RATING", $this->lng->txt("text_rating"));
$this->tpl->setVariable("TEXT_QUESTION", $this->lng->txt("question"));
$this->tpl->setVariable("TEXT_MAXCHARS", $this->lng->txt("maxchars"));
$this->tpl->setVariable("TEXT_POINTS", $this->lng->txt("points"));
$this->tpl->setVariable("OPTIONAL_KEYWORDS", $this->lng->txt("optional_keywords"));
$this->tpl->setVariable("TEXT_KEYWORDS", $this->lng->txt("keywords"));
$this->tpl->setVariable("DESCRIPTION_MAXCHARS", $this->lng->txt("description_maxchars"));
$this->tpl->setVariable("TEXT_SOLUTION_HINT", $this->lng->txt("solution_hint"));
$this->tpl->setVariable("TEXT_KEYWORDS_HINT", $this->lng->txt("keywords_hint"));
if (count($this->object->suggested_solutions))
{
$solution_array = $this->object->getSuggestedSolution(0);
include_once "./assessment/classes/class.assQuestion.php";
$href = assQuestion::_getInternalLinkHref($solution_array["internal_link"]);
$this->tpl->setVariable("TEXT_VALUE_SOLUTION_HINT", " <a href=\"$href\" target=\"content\">" . $this->lng->txt("solution_hint"). "</a> ");
$this->tpl->setVariable("BUTTON_REMOVE_SOLUTION", $this->lng->txt("remove"));
$this->tpl->setVariable("BUTTON_ADD_SOLUTION", $this->lng->txt("change"));
$this->tpl->setVariable("VALUE_SOLUTION_HINT", $solution_array["internal_link"]);
}
else
{
$this->tpl->setVariable("BUTTON_ADD_SOLUTION", $this->lng->txt("add"));
}
$this->tpl->setVariable("SAVE",$this->lng->txt("save"));
$this->tpl->setVariable("SAVE_EDIT", $this->lng->txt("save_edit"));
$this->tpl->setVariable("CANCEL",$this->lng->txt("cancel"));
$this->tpl->setVariable("TXT_REQUIRED_FLD", $this->lng->txt("required_field"));
$this->ctrl->setParameter($this, "sel_question_types", "assTextQuestion");
$this->tpl->setVariable("TEXT_QUESTION_TYPE", $this->lng->txt("assTextQuestion"));
$this->tpl->setVariable("ACTION_TEXT_QUESTION", $this->ctrl->getFormAction($this));
$this->tpl->parseCurrentBlock();
include_once "./Services/RTE/classes/class.ilRTE.php";
$rtestring = ilRTE::_getRTEClassname();
include_once "./Services/RTE/classes/class.$rtestring.php";
$rte = new $rtestring();
$rte->addPlugin("latex");
$rte->addButton("latex");
include_once "./classes/class.ilObject.php";
$obj_id = $_GET["q_id"];
$obj_type = ilObject::_lookupType($_GET["ref_id"], TRUE);
$rte->addRTESupport($obj_id, $obj_type, "assessment");
$this->tpl->setCurrentBlock("adm_content");
$this->tpl->setVariable("BODY_ATTRIBUTES", " onload=\"initialSelect();\"");
$this->tpl->parseCurrentBlock();
}
Here is the call graph for this function:
Here is the caller graph for this function:
| assTextQuestionGUI::getPreview | ( | ) |
Definition at line 343 of file class.assTextQuestionGUI.php.
{
// generate the question output
include_once "./classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_as_qpl_text_question_output.html", TRUE, TRUE, TRUE);
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();
$template->setCurrentBlock("has_maxchars");
$template->setVariable("MAXCHARS", $this->object->getMaxNumOfChars());
$template->parseCurrentBlock();
$template->setCurrentBlock("maxchars_counter");
$template->setVariable("MAXCHARS", $this->object->getMaxNumOfChars());
$template->parseCurrentBlock();
}
$questiontext = $this->object->getQuestion();
$template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
$questionoutput = $template->get();
$questionoutput = preg_replace("/<div[^>]*?>(.*)<\/div>/is", "\\1", $questionoutput);
return $questionoutput;
}
| assTextQuestionGUI::getQuestionType | ( | ) |
Returns the question type string.
Returns the question type string
- Returns:
- string The question type string public
Reimplemented from assQuestionGUI.
Definition at line 69 of file class.assTextQuestionGUI.php.
{
return "assTextQuestion";
}
| assTextQuestionGUI::getSolutionOutput | ( | $ | active_id, | |
| $ | pass = NULL, |
|||
| $ | graphicalOutput = FALSE, |
|||
| $ | result_output = FALSE, |
|||
| $ | show_question_only = TRUE | |||
| ) |
Definition at line 272 of file class.assTextQuestionGUI.php.
References $idx, $keywords, assQuestionGUI::getILIASPage(), ilUtil::getImagePath(), and ilUtil::prepareFormOutput().
{
// get the solution of the user for the active pass or from the last pass if allowed
$user_solution = "";
if ($active_id)
{
$solutions =& $this->object->getSolutionValues($active_id, $pass);
foreach ($solutions as $idx => $solution_value)
{
$user_solution = $solution_value["value1"];
}
}
else
{
$keywords = $this->object->getKeywordList();
if (count($keywords))
{
$user_solution = $this->lng->txt("solution_may_contain_keywords") . ": " . join(",", $keywords);
}
}
// generate the question output
include_once "./classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_as_qpl_text_question_output_solution.html", TRUE, TRUE, TRUE);
$solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", TRUE, TRUE, TRUE);
$template->setVariable("ESSAY", ilUtil::prepareFormOutput($user_solution));
$questiontext = $this->object->getQuestion();
if ($active_id)
{
if ($graphicalOutput)
{
// output of ok/not ok icons for user entered solutions
$reached_points = $this->object->getReachedPoints($active_id);
if ($reached_points == $this->object->getMaximumPoints())
{
$template->setCurrentBlock("icon_ok");
$template->setVariable("ICON_OK", ilUtil::getImagePath("icon_ok.gif"));
$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.gif"));
$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.gif"));
$template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_wrong"));
}
$template->parseCurrentBlock();
}
}
}
$template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
$questionoutput = $template->get();
$solutiontemplate->setVariable("SOLUTION_OUTPUT", $questionoutput);
$solutionoutput = $solutiontemplate->get();
if (!$show_question_only)
{
// get page object output
$pageoutput = $this->getILIASPage();
$solutionoutput = preg_replace("/(<div( xmlns:xhtml\=\"http:\/\/www.w3.org\/1999\/xhtml\"){0,1} class\=\"ilc_Question\"><\/div>)/ims", $solutionoutput, $pageoutput);
}
return $solutionoutput;
}
Here is the call graph for this function:
| assTextQuestionGUI::getTestOutput | ( | $ | active_id, | |
| $ | pass = NULL, |
|||
| $ | is_postponed = FALSE, |
|||
| $ | use_post_solutions = FALSE | |||
| ) |
Definition at line 367 of file class.assTextQuestionGUI.php.
References $idx, ilObjTest::_getHidePreviousResults(), ilObjTest::_getPass(), assQuestionGUI::outQuestionPage(), and ilUtil::prepareFormOutput().
Referenced by outQuestionForTest().
{
// get page object output
$pageoutput = $this->outQuestionPage("", $is_postponed, $active_id);
// 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 "./assessment/classes/class.ilObjTest.php";
if (ilObjTest::_getHidePreviousResults($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 "./classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_as_qpl_text_question_output.html", TRUE, TRUE, TRUE);
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();
$template->setCurrentBlock("has_maxchars");
$template->setVariable("MAXCHARS", $this->object->getMaxNumOfChars());
$template->parseCurrentBlock();
$template->setCurrentBlock("maxchars_counter");
$template->setVariable("MAXCHARS", $this->object->getMaxNumOfChars());
$template->parseCurrentBlock();
}
$template->setVariable("ESSAY", ilUtil::prepareFormOutput($user_solution));
$questiontext = $this->object->getQuestion();
$template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
$questionoutput = $template->get();
$questionoutput = preg_replace("/(<div( xmlns:xhtml\=\"http:\/\/www.w3.org\/1999\/xhtml\"){0,1} class\=\"ilc_Question\"><\/div>)/ims", $questionoutput, $pageoutput);
return $questionoutput;
}
Here is the call graph for this function:
Here is the caller graph for this function:
| assTextQuestionGUI::outAdditionalOutput | ( | ) |
Reimplemented from assQuestionGUI.
Definition at line 253 of file class.assTextQuestionGUI.php.
Referenced by outQuestionForTest().
{
if ($this->object->getMaxNumOfChars() > 0)
{
$this->tpl->addBlockFile("CONTENT_BLOCK", "charcounter", "tpl.charcounter.html", true);
$this->tpl->setCurrentBlock("charcounter");
$this->tpl->setVariable("CHARACTERS", $this->lng->txt("characters"));
$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 264 of file class.assTextQuestionGUI.php.
References 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);
$this->outAdditionalOutput();
}
Here is the call graph for this function:
| assTextQuestionGUI::writePostData | ( | ) |
Evaluates a posted edit form and writes the form data in the question object.
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
Reimplemented from assQuestionGUI.
Definition at line 217 of file class.assTextQuestionGUI.php.
References $_POST, $result, ilObjAdvancedEditing::_getUsedHTMLTagsAsString(), assQuestionGUI::setErrorMessage(), ilUtil::stripSlashes(), and assQuestionGUI::writeOtherPostData().
Referenced by addSuggestedSolution().
{
$result = 0;
if ((!$_POST["title"]) or (!$_POST["author"]) or (!$_POST["question"]) or (strlen($_POST["points"]) == 0))
{
$result = 1;
}
$this->object->setTitle(ilUtil::stripSlashes($_POST["title"]));
$this->object->setAuthor(ilUtil::stripSlashes($_POST["author"]));
$this->object->setComment(ilUtil::stripSlashes($_POST["comment"]));
include_once "./classes/class.ilObjAdvancedEditing.php";
$questiontext = ilUtil::stripSlashes($_POST["question"], false, ilObjAdvancedEditing::_getUsedHTMLTagsAsString("assessment"));
$this->object->setQuestion($questiontext);
$this->object->setPoints($_POST["points"]);
if ($_POST["points"] < 0)
{
$result = 1;
$this->setErrorMessage($this->lng->txt("negative_points_not_allowed"));
}
$this->object->setSuggestedSolution($_POST["solution_hint"], 0);
$this->object->setMaxNumOfChars($_POST["maxchars"]);
$this->object->setKeywords(ilUtil::stripSlashes($_POST["keywords"], false, ilObjAdvancedEditing::_getUsedHTMLTagsAsString("assessment")));
$this->object->setTextRating($_POST["text_rating"]);
$saved = $this->writeOtherPostData($result);
// Set the question id from a hidden form parameter
if ($_POST["text_question_id"] > 0)
{
$this->object->setId($_POST["text_question_id"]);
}
return $result;
}
Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following file:
- assessment/classes/class.assTextQuestionGUI.php
