ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
assSingleChoiceGUI Class Reference

Single choice question GUI representation. More...

+ Inheritance diagram for assSingleChoiceGUI:
+ Collaboration diagram for assSingleChoiceGUI:

Public Member Functions

 __construct ($id=-1)
 assSingleChoiceGUI 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.
 uploadchoice ()
 Upload an image.
 removeimagechoice ()
 Remove an image.
 addchoice ()
 Add a new answer.
 removechoice ()
 Remove an answer.
 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, $showInlineFeedback=false)
 getTestOutput ($active_id, $pass=NULL, $is_postponed=FALSE, $use_post_solutions=FALSE, $show_feedback=FALSE)
 setQuestionTabs ()
 Sets the ILIAS tabs for this question type.
 getChoiceKeys ()
 getSpecificFeedbackOutput ($active_id, $pass)
 Returns the answer specific feedback for the question.
 writeQuestionSpecificPostData (ilPropertyFormGUI $form)
 Extracts the question specific values from $_POST and applies them to the data object.
 populateQuestionSpecificFormPart (\ilPropertyFormGUI $form)
 getAfterParticipationSuppressionQuestionPostVars ()
 Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment.
 writeAnswerSpecificPostData (ilPropertyFormGUI $form)
 Extracts the answer specific values from $_POST and applies them to the data object.
 populateAnswerSpecificFormPart (\ilPropertyFormGUI $form)
 getAfterParticipationSuppressionAnswerPostVars ()
 Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment.
 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.
 aggregateAnswers ($relevant_answers_chosen, $answers_defined_on_question)
 renderAggregateView ($aggregate)
- Public Member Functions inherited from assQuestionGUI
 __construct ()
 assQuestionGUI constructor
executeCommand ()
 execute command
 getCommand ($cmd)
 getType ()
 needed for page editor compliance
 setTaxonomyIds ($taxonomyIds)
 getTaxonomyIds ()
 setTargetGui ($linkTargetGui)
 setTargetGuiClass ($targetGuiClass)
 getTargetGuiClass ()
 setQuestionHeaderBlockBuilder ($questionHeaderBlockBuilder)
 setQuestionActionCmd ($questionActionCmd)
 getQuestionActionCmd ()
_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="", $return_to_feedback= '')
 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)
 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.
 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.
 getGenericFeedbackOutputForCorrectSolution ()
 getGenericFeedbackOutputForIncorrectSolution ()
 outQuestionType ()
 showSuggestedSolution ()
 suggestedsolution ()
 Allows to add suggested solutions for questions.
 outSolutionExplorer ()
 saveSuggestedSolution ()
 cancelExplorer ()
 outPageSelector ()
 outChapterSelector ()
 outGlossarySelector ()
 linkChilds ()
 addPG ()
 addST ()
 addGIT ()
 isSaveCommand ()
 addTab_SuggestedSolution (ilTabsGUI $tabs, $classname)
 getEditQuestionTabCommands ()
 isAutosaveable ()
 outQuestionForTest ($formaction, $active_id, $pass=NULL, $is_question_postponed=FALSE, $user_post_solutions=FALSE, $show_specific_inline_feedback=FALSE)
 setPreviewSession ($previewSession)
 getPreviewSession ()
 showHints ()
- Public Member Functions inherited from ilGuiQuestionScoringAdjustable
 populateQuestionSpecificFormPart (ilPropertyFormGUI $form)
 Adds the question specific forms parts to a question property form gui.
- Public Member Functions inherited from ilGuiAnswerScoringAdjustable
 populateAnswerSpecificFormPart (ilPropertyFormGUI $form)
 Adds the answer specific form parts to a question property form gui.

Data Fields

 $choiceKeys
- Data Fields inherited from assQuestionGUI
const FORM_MODE_EDIT = 'edit'
const FORM_MODE_ADJUST = 'adjust'
const FORM_ENCODING_URLENCODE = 'application/x-www-form-urlencoded'
const FORM_ENCODING_MULTIPART = 'multipart/form-data'
const SESSION_PREVIEW_DATA_BASE_INDEX = 'ilAssQuestionPreviewAnswers'
 $object
 $tpl
 $lng
 $error
 $errormessage
 $sequence_no
 sequence number in test
 $question_count
 question count in test

Private Member Functions

 populateInlineFeedback ($template, $answer_id, $user_solution)

Additional Inherited Members

- Static Public Member Functions inherited from assQuestionGUI
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
- Protected Member Functions inherited from assQuestionGUI
 writePostData ()
 Evaluates a posted edit form and writes the form data in the question object.
 saveTaxonomyAssignments ()
 populateTaxonomyFormSection (ilPropertyFormGUI $form)
 getBasicEditQuestionTabCommands ()
 getAdditionalEditQuestionCommands ()
 addTab_QuestionFeedback (ilTabsGUI $tabs)
 adds the feedback tab to ilTabsGUI
 addTab_QuestionHints (ilTabsGUI $tabs)
 adds the hints tab to ilTabsGUI
 addTab_QuestionPreview (ilTabsGUI $tabsGUI)
 writeQuestionGenericPostData ()
 getFormEncodingType ()
 addBackTab (ilTabsGUI $ilTabs)
 buildBasicEditFormObject ()

Detailed Description

Single choice question GUI representation.

The assSingleChoiceGUI class encapsulates the GUI representation for single 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
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:
class.assSingleChoiceGUI.php 61463 2015-12-14 14:16:36Z gitmgr

Definition at line 22 of file class.assSingleChoiceGUI.php.

Constructor & Destructor Documentation

assSingleChoiceGUI::__construct (   $id = -1)

assSingleChoiceGUI constructor

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

Parameters
integer$idThe database id of a single choice question object

Definition at line 33 of file class.assSingleChoiceGUI.php.

References assQuestionGUI\__construct().

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

+ Here is the call graph for this function:

Member Function Documentation

assSingleChoiceGUI::addchoice ( )

Add a new answer.

Definition at line 140 of file class.assSingleChoiceGUI.php.

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

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

+ Here is the call graph for this function:

assSingleChoiceGUI::aggregateAnswers (   $relevant_answers_chosen,
  $answers_defined_on_question 
)

Definition at line 796 of file class.assSingleChoiceGUI.php.

Referenced by getAggregatedAnswersView().

{
$aggregate = array();
foreach ($answers_defined_on_question as $answer)
{
$aggregated_info_for_answer = array();
$aggregated_info_for_answer['answertext'] = $answer->getAnswerText();
$aggregated_info_for_answer['count_checked'] = 0;
foreach ($relevant_answers_chosen as $relevant_answer)
{
if ($relevant_answer['value1'] == $answer->getOrder())
{
$aggregated_info_for_answer['count_checked']++;
}
}
$aggregated_info_for_answer['count_unchecked'] =
ceil(count($relevant_answers_chosen) / count($answers_defined_on_question))
- $aggregated_info_for_answer['count_checked'];
$aggregate[] = $aggregated_info_for_answer;
}
return $aggregate;
}

+ Here is the caller graph for this function:

assSingleChoiceGUI::editQuestion (   $checkonly = FALSE)

Creates an output of the edit form for the question.

Definition at line 70 of file class.assSingleChoiceGUI.php.

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

Referenced by addchoice(), removechoice(), removeimagechoice(), uploadchoice(), and writePostData().

{
$save = $this->isSaveCommand();
include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
$form = new ilPropertyFormGUI();
$form->setFormAction($this->ctrl->getFormAction($this));
$form->setTitle($this->outQuestionType());
$isSingleline = ($this->object->lastChange == 0 && !array_key_exists('types', $_POST)) ? (($this->object->getMultilineAnswerSetting()) ? false : true) : $this->object->isSingleline;
if ($checkonly) $isSingleline = ($_POST['types'] == 0) ? true : false;
if ($isSingleline)
{
$form->setMultipart(TRUE);
}
else
{
$form->setMultipart(FALSE);
}
$form->setTableWidth("100%");
$form->setId("asssinglechoice");
$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:

assSingleChoiceGUI::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 777 of file class.assSingleChoiceGUI.php.

{
return array();
}
assSingleChoiceGUI::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 699 of file class.assSingleChoiceGUI.php.

{
return array();
}
assSingleChoiceGUI::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 790 of file class.assSingleChoiceGUI.php.

References aggregateAnswers(), and renderAggregateView().

{
return $this->renderAggregateView(
$this->aggregateAnswers( $relevant_answers, $this->object->getAnswers() ) )->get();
}

+ Here is the call graph for this function:

assSingleChoiceGUI::getChoiceKeys ( )

Definition at line 602 of file class.assSingleChoiceGUI.php.

References $_GET, $_SESSION, and $choiceKeys.

Referenced by getPreview(), getSolutionOutput(), and getTestOutput().

{
if (strcmp($_GET["activecommand"], "directfeedback") == 0)
{
if (is_array($_SESSION["choicekeys"])) $this->choiceKeys = $_SESSION["choicekeys"];
}
if (!is_array($this->choiceKeys))
{
$this->choiceKeys = array_keys($this->object->answers);
if ($this->object->getShuffle())
{
$this->choiceKeys = $this->object->pcArrayShuffle($this->choiceKeys);
}
}
$_SESSION["choicekeys"] = $this->choiceKeys;
}

+ Here is the caller graph for this function:

assSingleChoiceGUI::getPreview (   $show_question_only = FALSE,
  $showInlineFeedback = false 
)

Reimplemented from assQuestionGUI.

Definition at line 330 of file class.assSingleChoiceGUI.php.

References getChoiceKeys(), assQuestionGUI\getILIASPage(), ilUtil\getImagePath(), assQuestionGUI\getPreviewSession(), populateInlineFeedback(), and ilUtil\prepareFormOutput().

{
$keys = $this->getChoiceKeys();
// generate the question output
include_once "./Services/UICore/classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_as_qpl_mc_sr_output.html", TRUE, TRUE, "Modules/TestQuestionPool");
foreach ($keys as $answer_id)
{
$answer = $this->object->answers[$answer_id];
if (strlen($answer->getImage()))
{
if ($this->object->getThumbSize())
{
$template->setCurrentBlock("preview");
$template->setVariable("URL_PREVIEW", $this->object->getImagePathWeb() . $answer->getImage());
$template->setVariable("TEXT_PREVIEW", $this->lng->txt('preview'));
$template->setVariable("IMG_PREVIEW", ilUtil::getImagePath('enlarge.svg'));
$template->setVariable("ANSWER_IMAGE_URL", $this->object->getImagePathWeb() . $this->object->getThumbPrefix() . $answer->getImage());
list($width, $height, $type, $attr) = getimagesize($this->object->getImagePath() . $answer->getImage());
$alt = $answer->getImage();
if (strlen($answer->getAnswertext()))
{
$alt = $answer->getAnswertext();
}
$alt = preg_replace("/<[^>]*?>/", "", $alt);
$template->setVariable("ANSWER_IMAGE_ALT", ilUtil::prepareFormOutput($alt));
$template->setVariable("ANSWER_IMAGE_TITLE", ilUtil::prepareFormOutput($alt));
$template->parseCurrentBlock();
}
else
{
$template->setCurrentBlock("answer_image");
$template->setVariable("ANSWER_IMAGE_URL", $this->object->getImagePathWeb() . $answer->getImage());
list($width, $height, $type, $attr) = getimagesize($this->object->getImagePath() . $answer->getImage());
$alt = $answer->getImage();
if (strlen($answer->getAnswertext()))
{
$alt = $answer->getAnswertext();
}
$alt = preg_replace("/<[^>]*?>/", "", $alt);
$template->setVariable("ATTR", $attr);
$template->setVariable("ANSWER_IMAGE_ALT", ilUtil::prepareFormOutput($alt));
$template->setVariable("ANSWER_IMAGE_TITLE", ilUtil::prepareFormOutput($alt));
$template->parseCurrentBlock();
}
}
if( $showInlineFeedback && is_object($this->getPreviewSession()) )
{
$this->populateInlineFeedback($template, $answer_id, $this->getPreviewSession()->getParticipantsSolution());
}
$template->setCurrentBlock("answer_row");
$template->setVariable("QID", $this->object->getId().'ID');
$template->setVariable("ANSWER_ID", $answer_id);
$template->setVariable("ANSWER_TEXT", $this->object->prepareTextareaOutput($answer->getAnswertext(), TRUE));
if( is_object($this->getPreviewSession()) )
{
$user_solution = $this->getPreviewSession()->getParticipantsSolution();
if (strcmp($user_solution, $answer_id) == 0)
{
$template->setVariable("CHECKED_ANSWER", " checked=\"checked\"");
}
}
$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:

assSingleChoiceGUI::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_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

Reimplemented from assQuestionGUI.

Definition at line 172 of file class.assSingleChoiceGUI.php.

References $ok, $pass, assQuestionGUI\getAnswerFeedbackOutput(), getChoiceKeys(), ilUtil\getHtmlPath(), assQuestionGUI\getILIASPage(), ilUtil\getImagePath(), populateInlineFeedback(), and ilUtil\prepareFormOutput().

{
// shuffle output
$keys = $this->getChoiceKeys();
// get the solution of the user for the active pass or from the last pass if allowed
$user_solution = "";
if (($active_id > 0) && (!$show_correct_solution))
{
$solutions =& $this->object->getSolutionValues($active_id, $pass);
foreach ($solutions as $idx => $solution_value)
{
$user_solution = $solution_value["value1"];
}
}
else
{
$found_index = -1;
$max_points = 0;
foreach ($this->object->answers as $index => $answer)
{
if ($answer->getPoints() > $max_points)
{
$max_points = $answer->getPoints();
$found_index = $index;
}
}
$user_solution = $found_index;
}
// generate the question output
include_once "./Services/UICore/classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_as_qpl_mc_sr_output_solution.html", TRUE, TRUE, "Modules/TestQuestionPool");
$solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html",TRUE, TRUE, "Modules/TestQuestionPool");
foreach ($keys as $answer_id)
{
$answer = $this->object->answers[$answer_id];
if (($active_id > 0) && (!$show_correct_solution))
{
if ($graphicalOutput)
{
// output of ok/not ok icons for user entered solutions
$ok = FALSE;
if (strcmp($user_solution, $answer_id) == 0)
{
if ($answer->getPoints() == $this->object->getMaximumPoints())
{
$ok = TRUE;
}
else
{
$ok = FALSE;
}
if ($ok)
{
$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_not_ok");
if ($answer->getPoints() > 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 (strlen($user_solution) == 0)
{
$template->setCurrentBlock("icon_not_ok");
$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 (strlen($answer->getImage()))
{
$template->setCurrentBlock("answer_image");
if ($this->object->getThumbSize())
{
$template->setVariable("ANSWER_IMAGE_URL", $this->object->getImagePathWeb() . $this->object->getThumbPrefix() . $answer->getImage());
}
else
{
$template->setVariable("ANSWER_IMAGE_URL", $this->object->getImagePathWeb() . $answer->getImage());
}
$alt = $answer->getImage();
if (strlen($answer->getAnswertext()))
{
$alt = $answer->getAnswertext();
}
$alt = preg_replace("/<[^>]*?>/", "", $alt);
$template->setVariable("ANSWER_IMAGE_ALT", ilUtil::prepareFormOutput($alt));
$template->setVariable("ANSWER_IMAGE_TITLE", ilUtil::prepareFormOutput($alt));
$template->parseCurrentBlock();
}
if ($show_feedback)
{
$this->populateInlineFeedback($template, $answer_id, $user_solution);
}
$template->setCurrentBlock("answer_row");
$template->setVariable("ANSWER_TEXT", $this->object->prepareTextareaOutput($answer->getAnswertext(), TRUE));
if (strcmp($user_solution, $answer_id) == 0)
{
$template->setVariable("SOLUTION_IMAGE", ilUtil::getHtmlPath(ilUtil::getImagePath("radiobutton_checked.png")));
$template->setVariable("SOLUTION_ALT", $this->lng->txt("checked"));
}
else
{
$template->setVariable("SOLUTION_IMAGE", ilUtil::getHtmlPath(ilUtil::getImagePath("radiobutton_unchecked.png")));
$template->setVariable("SOLUTION_ALT", $this->lng->txt("unchecked"));
}
if ($result_output)
{
$points = $this->object->answers[$answer_id]->getPoints();
$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();
if ($show_question_text==true)
{
$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", $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:

assSingleChoiceGUI::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_idActive ID of the user
integer$passActive pass
Returns
string HTML Code with the answer specific feedback public

Reimplemented from assQuestionGUI.

Definition at line 620 of file class.assSingleChoiceGUI.php.

{
// No return value, this question type supports inline specific feedback.
$output = "";
return $this->object->prepareTextareaOutput($output, TRUE);
}
assSingleChoiceGUI::getTestOutput (   $active_id,
  $pass = NULL,
  $is_postponed = FALSE,
  $use_post_solutions = FALSE,
  $show_feedback = FALSE 
)

Definition at line 408 of file class.assSingleChoiceGUI.php.

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

{
$keys = $this->getChoiceKeys();
// 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_mc_sr_output.html", TRUE, TRUE, "Modules/TestQuestionPool");
foreach ($keys as $answer_id)
{
$answer = $this->object->answers[$answer_id];
if (strlen($answer->getImage()))
{
if ($this->object->getThumbSize())
{
$template->setCurrentBlock("preview");
$template->setVariable("URL_PREVIEW", $this->object->getImagePathWeb() . $answer->getImage());
$template->setVariable("TEXT_PREVIEW", $this->lng->txt('preview'));
$template->setVariable("IMG_PREVIEW", ilUtil::getImagePath('enlarge.svg'));
$template->setVariable("ANSWER_IMAGE_URL", $this->object->getImagePathWeb() . $this->object->getThumbPrefix() . $answer->getImage());
list($width, $height, $type, $attr) = getimagesize($this->object->getImagePath() . $answer->getImage());
$alt = $answer->getImage();
if (strlen($answer->getAnswertext()))
{
$alt = $answer->getAnswertext();
}
$alt = preg_replace("/<[^>]*?>/", "", $alt);
$template->setVariable("ANSWER_IMAGE_ALT", ilUtil::prepareFormOutput($alt));
$template->setVariable("ANSWER_IMAGE_TITLE", ilUtil::prepareFormOutput($alt));
$template->parseCurrentBlock();
}
else
{
$template->setCurrentBlock("answer_image");
$template->setVariable("ANSWER_IMAGE_URL", $this->object->getImagePathWeb() . $answer->getImage());
list($width, $height, $type, $attr) = getimagesize($this->object->getImagePath() . $answer->getImage());
$alt = $answer->getImage();
if (strlen($answer->getAnswertext()))
{
$alt = $answer->getAnswertext();
}
$alt = preg_replace("/<[^>]*?>/", "", $alt);
$template->setVariable("ATTR", $attr);
$template->setVariable("ANSWER_IMAGE_ALT", ilUtil::prepareFormOutput($alt));
$template->setVariable("ANSWER_IMAGE_TITLE", ilUtil::prepareFormOutput($alt));
$template->parseCurrentBlock();
}
}
if ($show_feedback)
{
$feedbackOutputRequired = false;
switch( $this->object->getSpecificFeedbackSetting() )
{
case 1:
$feedbackOutputRequired = true;
break;
case 2:
if (strcmp($user_solution, $answer_id) == 0)
{
$feedbackOutputRequired = true;
}
break;
case 3:
if ($this->object->getAnswer($answer_id)->getPoints() > 0)
{
$feedbackOutputRequired = true;
}
break;
}
if($feedbackOutputRequired)
{
$fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
$this->object->getId(), $answer_id
);
if (strlen($fb))
{
$template->setCurrentBlock("feedback");
$template->setVariable("FEEDBACK", $this->object->prepareTextareaOutput( $fb, true ));
$template->parseCurrentBlock();
}
}
}
$template->setCurrentBlock("answer_row");
$template->setVariable("ANSWER_ID", $answer_id);
$template->setVariable("ANSWER_TEXT", $this->object->prepareTextareaOutput($answer->getAnswertext(), TRUE));
if (strcmp($user_solution, $answer_id) == 0)
{
$template->setVariable("CHECKED_ANSWER", " checked=\"checked\"");
}
$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:

assSingleChoiceGUI::populateAnswerSpecificFormPart ( \ilPropertyFormGUI  $form)

Definition at line 746 of file class.assSingleChoiceGUI.php.

References $_POST, ilPropertyFormGUI\addItem(), and ilFormPropertyGUI\setRequired().

Referenced by editQuestion().

{
$isSingleline = ($this->object->lastChange == 0 && !array_key_exists('types', $_POST)) ? (($this->object->getMultilineAnswerSetting()) ? false : true) : $this->object->isSingleline;
// Choices
include_once "./Modules/TestQuestionPool/classes/class.ilSingleChoiceWizardInputGUI.php";
$choices = new ilSingleChoiceWizardInputGUI($this->lng->txt( "answers" ), "choice");
$choices->setRequired( true );
$choices->setQuestionObject( $this->object );
$choices->setSingleline( $isSingleline );
$choices->setAllowMove( false );
if ($this->object->getSelfAssessmentEditingMode())
{
$choices->setSize( 40 );
$choices->setMaxLength( 800 );
}
if ($this->object->getAnswerCount() == 0)
$this->object->addAnswer( "", 0, 0 );
$choices->setValues( $this->object->getAnswers() );
$form->addItem( $choices );
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assSingleChoiceGUI::populateInlineFeedback (   $template,
  $answer_id,
  $user_solution 
)
private

Definition at line 840 of file class.assSingleChoiceGUI.php.

Referenced by getPreview(), and getSolutionOutput().

{
$feedbackOutputRequired = false;
switch($this->object->getSpecificFeedbackSetting())
{
case 1:
$feedbackOutputRequired = true;
break;
case 2:
if(strcmp($user_solution, $answer_id) == 0)
{
$feedbackOutputRequired = true;
}
break;
case 3:
if($this->object->getAnswer($answer_id)->getPoints() > 0)
{
$feedbackOutputRequired = true;
}
break;
}
if($feedbackOutputRequired)
{
$fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation($this->object->getId(), $answer_id);
if(strlen($fb))
{
$template->setCurrentBlock("feedback");
$template->setVariable("FEEDBACK", $this->object->prepareTextareaOutput($fb, true));
$template->parseCurrentBlock();
}
}
}

+ Here is the caller graph for this function:

assSingleChoiceGUI::populateQuestionSpecificFormPart ( \ilPropertyFormGUI  $form)

Definition at line 643 of file class.assSingleChoiceGUI.php.

References $_POST, ilPropertyFormGUI\addItem(), ilFormPropertyGUI\setRequired(), ilNumberInputGUI\setSuffix(), and ilCheckboxInputGUI\setValue().

Referenced by editQuestion().

{
$isSingleline = ($this->object->lastChange == 0 && !array_key_exists( 'types',$_POST)) ? (($this->object->getMultilineAnswerSetting()) ? false : true) : $this->object->isSingleline;
// shuffle
$shuffle = new ilCheckboxInputGUI($this->lng->txt( "shuffle_answers" ), "shuffle");
$shuffle->setValue( 1 );
$shuffle->setChecked( $this->object->getShuffle() );
$shuffle->setRequired( FALSE );
$form->addItem( $shuffle );
if ($this->object->getId())
{
$hidden = new ilHiddenInputGUI("", "ID");
$hidden->setValue( $this->object->getId() );
$form->addItem( $hidden );
}
if (!$this->object->getSelfAssessmentEditingMode())
{
// Answer types
$types = new ilSelectInputGUI($this->lng->txt( "answer_types" ), "types");
$types->setRequired( false );
$types->setValue( ($isSingleline) ? 0 : 1 );
$types->setOptions( array(
0 => $this->lng->txt( 'answers_singleline' ),
1 => $this->lng->txt( 'answers_multiline' ),
)
);
$form->addItem( $types );
}
if ($isSingleline)
{
// thumb size
$thumb_size = new ilNumberInputGUI($this->lng->txt( "thumb_size" ), "thumb_size");
$thumb_size->setSuffix($this->lng->txt("thumb_size_unit_pixel"));
$thumb_size->setMinValue( 20 );
$thumb_size->setDecimals( 0 );
$thumb_size->setSize( 6 );
$thumb_size->setInfo( $this->lng->txt( 'thumb_size_info' ) );
$thumb_size->setValue( $this->object->getThumbSize() );
$thumb_size->setRequired( false );
$form->addItem( $thumb_size );
}
return $form;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assSingleChoiceGUI::removechoice ( )

Remove an answer.

Definition at line 151 of file class.assSingleChoiceGUI.php.

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

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

+ Here is the call graph for this function:

assSingleChoiceGUI::removeimagechoice ( )

Remove an image.

Definition at line 128 of file class.assSingleChoiceGUI.php.

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

{
$this->writePostData(true);
$position = key($_POST['cmd']['removeimagechoice']);
$filename = $_POST['choice']['imagename'][$position];
$this->object->removeAnswerImage($position);
$this->editQuestion();
}

+ Here is the call graph for this function:

assSingleChoiceGUI::renderAggregateView (   $aggregate)
Parameters
$aggregate
Returns
ilTemplate

Definition at line 826 of file class.assSingleChoiceGUI.php.

References assQuestionGUI\$tpl.

Referenced by getAggregatedAnswersView().

{
$tpl = new ilTemplate('tpl.il_as_aggregated_answers_table.html', true, true, "Modules/TestQuestionPool");
foreach ($aggregate as $line_data)
{
$tpl->setCurrentBlock( 'aggregaterow' );
$tpl->setVariable( 'OPTION', $line_data['answertext'] );
$tpl->setVariable( 'COUNT', $line_data['count_checked'] );
$tpl->parseCurrentBlock();
}
return $tpl;
}

+ Here is the caller graph for this function:

assSingleChoiceGUI::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 533 of file class.assSingleChoiceGUI.php.

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

{
global $rbacsystem, $ilTabs;
$ilTabs->clearTargets();
$this->ctrl->setParameterByClass("ilAssQuestionPageGUI", "q_id", $_GET["q_id"]);
include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
$q_type = $this->object->getQuestionType();
if (strlen($q_type))
{
$classname = $q_type . "GUI";
$this->ctrl->setParameterByClass(strtolower($classname), "sel_question_types", $q_type);
$this->ctrl->setParameterByClass(strtolower($classname), "q_id", $_GET["q_id"]);
}
if ($_GET["q_id"])
{
if ($rbacsystem->checkAccess('write', $_GET["ref_id"]))
{
// edit page
$ilTabs->addTarget("edit_page",
$this->ctrl->getLinkTargetByClass("ilAssQuestionPageGUI", "edit"),
array("edit", "insert", "exec_pg"),
"", "", $force_active);
}
$this->addTab_QuestionPreview($ilTabs);
}
$force_active = false;
if ($rbacsystem->checkAccess('write', $_GET["ref_id"]))
{
$url = "";
if ($classname) $url = $this->ctrl->getLinkTargetByClass($classname, "editQuestion");
// edit question properties
$ilTabs->addTarget("edit_question",
$url,
array("editQuestion", "save", "saveEdit", "addchoice", "removechoice", "removeimagechoice", "uploadchoice", "originalSyncForm"),
$classname, "", $force_active);
}
// add tab for question feedback within common class assQuestionGUI
$this->addTab_QuestionFeedback($ilTabs);
// add tab for question hint within common class assQuestionGUI
$this->addTab_QuestionHints($ilTabs);
// add tab for question's suggested solution within common class assQuestionGUI
$this->addTab_SuggestedSolution($ilTabs, $classname);
// Assessment of questions sub menu entry
if ($_GET["q_id"])
{
$ilTabs->addTarget("statistics",
$this->ctrl->getLinkTargetByClass($classname, "assessment"),
array("assessment"),
$classname, "");
}
$this->addBackTab($ilTabs);
}

+ Here is the call graph for this function:

assSingleChoiceGUI::uploadchoice ( )

Upload an image.

Definition at line 118 of file class.assSingleChoiceGUI.php.

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

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

+ Here is the call graph for this function:

assSingleChoiceGUI::writeAnswerSpecificPostData ( ilPropertyFormGUI  $form)

Extracts the answer specific values from $_POST and applies them to the data object.

Parameters
bool$alwaysIf true, a check for form validity is omitted.
Returns
void

Implements ilGuiAnswerScoringAdjustable.

Definition at line 704 of file class.assSingleChoiceGUI.php.

References $_POST, $filename, and ilUtil\secureString().

Referenced by writePostData().

{
// Delete all existing answers and create new answers from the form data
$this->object->flushAnswers();
if ($this->object->isSingleline)
{
foreach ($_POST['choice']['answer'] as $index => $answertext)
{
$answertext = ilUtil::secureString($answertext);
$picturefile = $_POST['choice']['imagename'][$index];
$file_org_name = $_FILES['choice']['name']['image'][$index];
$file_temp_name = $_FILES['choice']['tmp_name']['image'][$index];
if (strlen( $file_temp_name ))
{
// check suffix
$suffix = strtolower( array_pop( explode( ".", $file_org_name ) ) );
if (in_array( $suffix, array( "jpg", "jpeg", "png", "gif" ) ))
{
// upload image
$filename = $this->object->createNewImageFileName( $file_org_name );
if ($this->object->setImageFile( $filename, $file_temp_name ) == 0)
{
$picturefile = $filename;
}
}
}
$this->object->addAnswer( $answertext, $_POST['choice']['points'][$index], $index, $picturefile );
}
}
else
{
foreach ($_POST['choice']['answer'] as $index => $answer)
{
$answertext = $answer;
$this->object->addAnswer( $answertext, $_POST['choice']['points'][$index], $index );
}
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assSingleChoiceGUI::writePostData (   $always = false)

Evaluates a posted edit form and writes the form data in the question object.

Parameters
bool$always
Returns
integer A positive value, if one of the required fields wasn't set, else 0

Definition at line 51 of file class.assSingleChoiceGUI.php.

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

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

+ Here is the call graph for this function:

assSingleChoiceGUI::writeQuestionSpecificPostData ( ilPropertyFormGUI  $form)

Extracts the question specific values from $_POST and applies them to the data object.

Parameters
bool$alwaysIf true, a check for form validity is omitted.
Returns
void

Implements ilGuiQuestionScoringAdjustable.

Definition at line 627 of file class.assSingleChoiceGUI.php.

References $_POST, and ilUtil\sendInfo().

Referenced by writePostData().

{
$this->object->setShuffle( $_POST["shuffle"] );
$this->object->setMultilineAnswerSetting( $_POST["types"] );
if (is_array( $_POST['choice']['imagename'] ) && $_POST["types"] == 1)
{
$this->object->isSingleline = true;
ilUtil::sendInfo( $this->lng->txt( 'info_answer_type_change' ), true );
}
else
{
$this->object->isSingleline = ($_POST["types"] == 0) ? true : false;
}
$this->object->setThumbSize( (strlen( $_POST["thumb_size"] )) ? $_POST["thumb_size"] : "" );
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Field Documentation

assSingleChoiceGUI::$choiceKeys

Definition at line 24 of file class.assSingleChoiceGUI.php.

Referenced by getChoiceKeys().


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