ILIAS  Release_4_1_x_branch Revision 61804
 All Data Structures Namespaces Files Functions Variables Groups Pages
assTextSubsetGUI Class Reference

Multiple choice question GUI representation. More...

+ Inheritance diagram for assTextSubsetGUI:
+ Collaboration diagram for assTextSubsetGUI:

Public Member Functions

 __construct ($id=-1)
 assTextSubsetGUI constructor
 getCommand ($cmd)
 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.
 addanswers ()
 Add a new answer.
 removeanswers ()
 Remove an answer.
 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)
 Get the question solution output.
 getPreview ($show_question_only=FALSE)
 getTestOutput ($active_id, $pass=NULL, $is_postponed=FALSE, $use_post_solutions=FALSE)
 saveFeedback ()
 Saves the feedback for a single choice question.
 setQuestionTabs ()
 Sets the ILIAS tabs for this question type.
- Public Member Functions inherited from assQuestionGUI
 __construct ()
 assQuestionGUI constructor
executeCommand ()
 execute command
 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
 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)
 outAdditionalOutput ()
 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.
 getAnswerFeedbackOutput ($active_id, $pass)
 Returns the answer specific feedback depending on the results of the question.
 feedback ($checkonly=false)
 Creates the output of the feedback page for the question.
 outQuestionType ()
 suggestedsolution ()
 Allows to add suggested solutions for questions.
 outSolutionExplorer ()
 saveSuggestedSolution ()
 cancelExplorer ()
 outPageSelector ()
 outChapterSelector ()
 outGlossarySelector ()
 linkChilds ()
 addPG ()
 addST ()
 addGIT ()

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

Detailed Description

Multiple choice question GUI representation.

The assTextSubsetGUI class encapsulates the GUI representation for multiple choice 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
Version
Id:
class.assTextSubsetGUI.php 33578 2012-03-07 10:15:18Z mbecker

Definition at line 37 of file class.assTextSubsetGUI.php.

Constructor & Destructor Documentation

assTextSubsetGUI::__construct (   $id = -1)

assTextSubsetGUI constructor

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

Parameters
integer$idThe database id of a text subset question object public

Definition at line 47 of file class.assTextSubsetGUI.php.

References assQuestionGUI\__construct().

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

+ Here is the call graph for this function:

Member Function Documentation

assTextSubsetGUI::addanswers ( )

Add a new answer.

Definition at line 189 of file class.assTextSubsetGUI.php.

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

{
$this->writePostData(true);
$position = key($_POST['cmd']['addanswers']);
$this->object->addAnswer("", 0, $position+1);
$this->editQuestion();
}

+ Here is the call graph for this function:

assTextSubsetGUI::editQuestion (   $checkonly = FALSE)

Creates an output of the edit form for the question.

public

Definition at line 110 of file class.assTextSubsetGUI.php.

References $errors, assQuestionGUI\addBasicQuestionFormProperties(), assQuestionGUI\addQuestionFormCommandButtons(), assQuestionGUI\getQuestionTemplate(), assQuestionGUI\outQuestionType(), ilNumberInputGUI\setMinValue(), and ilFormPropertyGUI\setRequired().

Referenced by addanswers(), removeanswers(), and writePostData().

{
$save = ((strcmp($this->ctrl->getCmd(), "save") == 0) || (strcmp($this->ctrl->getCmd(), "saveEdit") == 0)) ? TRUE : FALSE;
include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
$form = new ilPropertyFormGUI();
$form->setFormAction($this->ctrl->getFormAction($this));
$form->setTitle($this->outQuestionType());
$form->setMultipart(FALSE);
$form->setTableWidth("100%");
$form->setId("asstextsubset");
// number of requested answers
$correctanswers = new ilNumberInputGUI($this->lng->txt("nr_of_correct_answers"), "correctanswers");
$correctanswers->setMinValue(1);
$correctanswers->setDecimals(0);
$correctanswers->setSize(3);
$correctanswers->setValue($this->object->getCorrectAnswers());
$correctanswers->setRequired(true);
$form->addItem($correctanswers);
// maximum available points
$points = new ilNumberInputGUI($this->lng->txt("maximum_points"), "points");
$points->setMinValue(0.25);
$points->setSize(6);
$points->setDisabled(true);
$points->setValue($this->object->getMaximumPoints());
$points->setRequired(false);
$form->addItem($points);
// 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);
// Choices
include_once "./Modules/TestQuestionPool/classes/class.ilAnswerWizardInputGUI.php";
$choices = new ilAnswerWizardInputGUI($this->lng->txt("answers"), "answers");
$choices->setRequired(true);
$choices->setQuestionObject($this->object);
$choices->setSingleline(true);
$choices->setAllowMove(false);
if ($this->object->getAnswerCount() == 0) $this->object->addAnswer("", 0, 0);
$choices->setValues($this->object->getAnswers());
$form->addItem($choices);
$errors = false;
if ($save)
{
$form->setValuesByPost();
$points->setValue($this->object->getMaximumPoints());
$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:

assTextSubsetGUI::getCommand (   $cmd)

Reimplemented from assQuestionGUI.

Definition at line 58 of file class.assTextSubsetGUI.php.

References $cmd.

{
return $cmd;
}
assTextSubsetGUI::getPreview (   $show_question_only = FALSE)

Definition at line 334 of file class.assTextSubsetGUI.php.

References assQuestionGUI\getILIASPage().

{
// generate the question output
include_once "./classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_as_qpl_textsubset_output.html", TRUE, TRUE, "Modules/TestQuestionPool");
$width = $this->object->getMaxTextboxWidth();
for ($i = 0; $i < $this->object->getCorrectAnswers(); $i++)
{
$template->setCurrentBlock("textsubset_row");
$template->setVariable("COUNTER", $i+1);
$template->setVariable("TEXTFIELD_ID", sprintf("%02d", $i+1));
$template->setVariable("TEXTFIELD_SIZE", $width);
$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:

assTextSubsetGUI::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 
)

Get the question solution output.

Parameters
integer$active_idThe active user id
integer$passThe test pass
boolean$graphicalOutputShow visual feedback for right/wrong answers
boolean$result_outputShow the reached points for parts of the question
boolean$show_question_onlyShow the question without the ILIAS content around
boolean$show_feedbackShow the question feedback
boolean$show_correct_solutionShow the correct solution instead of the user solution
boolean$show_manual_scoringShow specific information for the manual scoring output
Returns
The solution output of the question as HTML code

Definition at line 228 of file class.assTextSubsetGUI.php.

References $pass, assQuestionGUI\getAnswerFeedbackOutput(), assQuestionGUI\getILIASPage(), and ilUtil\getImagePath().

{
// get the solution of the user for the active pass or from the last pass if allowed
$solutions = array();
if (($active_id > 0) && (!$show_correct_solution))
{
$solutions =& $this->object->getSolutionValues($active_id, $pass);
}
else
{
$rank = array();
foreach ($this->object->answers as $answer)
{
if ($answer->getPoints() > 0)
{
if (!is_array($rank[$answer->getPoints()]))
{
$rank[$answer->getPoints()] = array();
}
array_push($rank[$answer->getPoints()], $answer->getAnswertext());
}
}
krsort($rank, SORT_NUMERIC);
foreach ($rank as $index => $bestsolutions)
{
array_push($solutions, array("value1" => join(",", $bestsolutions), "points" => $index));
}
}
// generate the question output
include_once "./classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_as_qpl_textsubset_output_solution.html", TRUE, TRUE, "Modules/TestQuestionPool");
$solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", TRUE, TRUE, "Modules/TestQuestionPool");
$available_answers =& $this->object->getAvailableAnswers();
for ($i = 0; $i < $this->object->getCorrectAnswers(); $i++)
{
if ((!$test_id) && (strcmp($solutions[$i]["value1"], "") == 0))
{
}
else
{
if (($active_id > 0) && (!$show_correct_solution))
{
if ($graphicalOutput)
{
// output of ok/not ok icons for user entered solutions
$index = $this->object->isAnswerCorrect($available_answers, $solutions[$i]["value1"]);
$correct = FALSE;
if ($index !== FALSE)
{
unset($available_answers[$index]);
$correct = TRUE;
}
if ($correct)
{
$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");
$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->setCurrentBlock("textsubset_row");
$template->setVariable("SOLUTION", $solutions[$i]["value1"]);
$template->setVariable("COUNTER", $i+1);
if ($result_output)
{
$points = $solutions[$i]["points"];
$resulttext = ($points == 1) ? "(%s " . $this->lng->txt("point") . ")" : "(%s " . $this->lng->txt("points") . ")";
$template->setVariable("RESULT_OUTPUT", sprintf($resulttext, $points));
}
$template->parseCurrentBlock();
}
}
$questiontext = $this->object->getQuestion();
$template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
$questionoutput = $template->get();
$feedback = ($show_feedback) ? $this->getAnswerFeedbackOutput($active_id, $pass) : "";
if (strlen($feedback)) $solutiontemplate->setVariable("FEEDBACK", $feedback);
$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:

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

Definition at line 359 of file class.assTextSubsetGUI.php.

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

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);
}
// generate the question output
include_once "./classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_as_qpl_textsubset_output.html", TRUE, TRUE, "Modules/TestQuestionPool");
$width = $this->object->getMaxTextboxWidth();
for ($i = 0; $i < $this->object->getCorrectAnswers(); $i++)
{
$template->setCurrentBlock("textsubset_row");
foreach ($solutions as $idx => $solution_value)
{
if ($idx == $i)
{
$template->setVariable("TEXTFIELD_VALUE", " value=\"" . $solution_value["value1"]."\"");
}
}
$template->setVariable("COUNTER", $i+1);
$template->setVariable("TEXTFIELD_ID", sprintf("%02d", $i+1));
$template->setVariable("TEXTFIELD_SIZE", $width);
$template->parseCurrentBlock();
}
$questiontext = $this->object->getQuestion();
$template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
$questionoutput = $template->get();
$pageoutput = $this->outQuestionPage("", $is_postponed, $active_id, $questionoutput);
return $pageoutput;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Definition at line 208 of file class.assTextSubsetGUI.php.

References $pass, and getTestOutput().

{
$test_output = $this->getTestOutput($active_id, $pass, $is_postponed, $use_post_solutions);
$this->tpl->setVariable("QUESTION_OUTPUT", $test_output);
$this->tpl->setVariable("FORMACTION", $formaction);
}

+ Here is the call graph for this function:

assTextSubsetGUI::removeanswers ( )

Remove an answer.

Definition at line 200 of file class.assTextSubsetGUI.php.

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

{
$this->writePostData(true);
$position = key($_POST['cmd']['removeanswers']);
$this->object->deleteAnswer($position);
$this->editQuestion();
}

+ Here is the call graph for this function:

assTextSubsetGUI::saveFeedback ( )

Saves the feedback for a single choice question.

public

Reimplemented from assQuestionGUI.

Definition at line 405 of file class.assTextSubsetGUI.php.

References $_POST, $errors, and assQuestionGUI\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"]);
$this->object->cleanupMediaObjectUsage();
}

+ Here is the call graph for this function:

assTextSubsetGUI::setQuestionTabs ( )

Sets the ILIAS tabs for this question type.

public

Definition at line 420 of file class.assTextSubsetGUI.php.

References $_GET, and $ref_id.

{
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_content",
$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_properties",
$url,
array("editQuestion", "save", "saveEdit", "addanswers", "removeanswers", "originalSyncForm"),
$classname, "", $force_active);
}
if ($_GET["q_id"])
{
$ilTabs->addTarget("feedback",
$this->ctrl->getLinkTargetByClass($classname, "feedback"),
array("feedback", "saveFeedback"),
$classname, "");
}
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"];
$ilTabs->setBackTarget($this->lng->txt("backtocallingtest"), "ilias.php?baseClass=ilObjTestGUI&cmd=questions&ref_id=$ref_id");
}
else
{
$ilTabs->setBackTarget($this->lng->txt("qpl"), $this->ctrl->getLinkTargetByClass("ilobjquestionpoolgui", "questions"));
}
}
assTextSubsetGUI::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 69 of file class.assTextSubsetGUI.php.

References $_POST, and editQuestion().

{
$hasErrors = (!$always) ? $this->editQuestion(true) : false;
if (!$hasErrors)
{
$this->object->setTitle($_POST["title"]);
$this->object->setAuthor($_POST["author"]);
$this->object->setComment($_POST["comment"]);
// mbecker: fix for 8407
$this->object->setEstimatedWorkingTime(
$_POST["Estimated"]["hh"],
$_POST["Estimated"]["mm"],
$_POST["Estimated"]["ss"]
);
include_once "./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php";
$questiontext = $_POST["question"];
$this->object->setQuestion($questiontext);
$this->object->setCorrectAnswers($_POST["correctanswers"]);
$this->object->setTextRating($_POST["text_rating"]);
// Delete all existing answers and create new answers from the form data
$this->object->flushAnswers();
foreach ($_POST['answers']['answer'] as $index => $answer)
{
$answertext = $answer;
$this->object->addAnswer($answertext, $_POST['answers']['points'][$index], $index);
}
return 0;
}
else
{
return 1;
}
}

+ Here is the call graph for this function:


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