ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes
assImagemapQuestionGUI Class Reference
Modules/TestQuestionPool

Image map question GUI representation. More...

+ Inheritance diagram for assImagemapQuestionGUI:
+ Collaboration diagram for assImagemapQuestionGUI:

Public Member Functions

 __construct ($id=-1)
 assImagemapQuestionGUI constructor
 getCommand ($cmd)
 writePostData ($always=false)
 Evaluates a posted edit form and writes the form data in the question object.
 writeAnswerSpecificPostData (ilPropertyFormGUI $form)
 Extracts the answer specific values from $_POST and applies them to the data object.
 writeQuestionSpecificPostData (ilPropertyFormGUI $form)
 Extracts the question specific values from $_POST and applies them to the data object.
 editQuestion ($checkonly=FALSE)
 populateAnswerSpecificFormPart (\ilPropertyFormGUI $form)
 populateQuestionSpecificFormPart (\ilPropertyFormGUI $form)
 addRect ()
 addCircle ()
 addPoly ()
 saveShape ()
 Saves a shape of the area editor.
 areaEditor ($shape= '')
 removeArea ()
 back ()
 outQuestionForTest ($formaction, $active_id, $pass=NULL, $is_postponed=FALSE, $use_post_solutions=FALSE, $show_feedback=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, $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.
 getSpecificFeedbackOutput ($active_id, $pass)
 Returns the answer specific feedback for the question.
 getAfterParticipationSuppressionAnswerPostVars ()
 Returns a list of postvars which will be suppressed in the form output when used in scoring adjustment.
 getAfterParticipationSuppressionQuestionPostVars ()
 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.
- Public Member Functions inherited from assQuestionGUI
 __construct ()
 assQuestionGUI constructor
& executeCommand ()
 execute command
 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 ()
 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.

Protected Member Functions

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

Private Attributes

 $linecolor

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
- 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

Detailed Description

Image map question GUI representation.

The assImagemapQuestionGUI class encapsulates the GUI representation for image map 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.assImagemapQuestionGUI.php 61189 2015-10-22 13:35:11Z gitmgr

Definition at line 23 of file class.assImagemapQuestionGUI.php.

Constructor & Destructor Documentation

assImagemapQuestionGUI::__construct (   $id = -1)

assImagemapQuestionGUI constructor

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

Parameters
integer$idThe database id of a image map question object.
Returns

Definition at line 36 of file class.assImagemapQuestionGUI.php.

References assQuestionGUI\__construct().

{
parent::__construct();
include_once './Modules/TestQuestionPool/classes/class.assImagemapQuestion.php';
$this->object = new assImagemapQuestion();
if ($id >= 0)
{
$this->object->loadFromDb($id);
}
$assessmentSetting = new ilSetting("assessment");
$this->linecolor = (strlen($assessmentSetting->get("imap_line_color"))) ? "#" . $assessmentSetting->get("imap_line_color") : "#FF0000";
}

+ Here is the call graph for this function:

Member Function Documentation

assImagemapQuestionGUI::addCircle ( )

Definition at line 237 of file class.assImagemapQuestionGUI.php.

References areaEditor().

{
$this->areaEditor('circle');
}

+ Here is the call graph for this function:

assImagemapQuestionGUI::addPoly ( )

Definition at line 242 of file class.assImagemapQuestionGUI.php.

References areaEditor().

{
$this->areaEditor('poly');
}

+ Here is the call graph for this function:

assImagemapQuestionGUI::addRect ( )

Definition at line 232 of file class.assImagemapQuestionGUI.php.

References areaEditor().

{
$this->areaEditor('rect');
}

+ Here is the call graph for this function:

assImagemapQuestionGUI::areaEditor (   $shape = '')

Definition at line 276 of file class.assImagemapQuestionGUI.php.

References $_POST, $linecolor, $preview, assQuestionGUI\getQuestionTemplate(), and ilUtil\sendInfo().

Referenced by addCircle(), addPoly(), and addRect().

{
$shape = (strlen($shape)) ? $shape : $_POST['shape'];
include_once "./Modules/TestQuestionPool/classes/class.ilImagemapPreview.php";
$this->getQuestionTemplate();
$this->tpl->addBlockFile("QUESTION_DATA", "question_data", "tpl.il_as_qpl_imagemap_question.html", "Modules/TestQuestionPool");
$coords = array();
if (is_array($_POST['image']['mapcoords']))
{
foreach ($_POST['image']['mapcoords'] as $value)
{
array_push($coords, $value);
}
}
if (is_array($_POST['cmd']['areaEditor']['image']))
{
array_push($coords, $_POST['cmd']['areaEditor']['image'][0] . "," . $_POST['cmd']['areaEditor']['image'][1]);
}
foreach ($coords as $value)
{
$this->tpl->setCurrentBlock("hidden");
$this->tpl->setVariable("HIDDEN_NAME", 'image[mapcoords][]');
$this->tpl->setVariable("HIDDEN_VALUE", $value);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("hidden");
$this->tpl->setVariable("HIDDEN_NAME", 'shape');
$this->tpl->setVariable("HIDDEN_VALUE", $shape);
$this->tpl->parseCurrentBlock();
$preview = new ilImagemapPreview($this->object->getImagePath().$this->object->getImageFilename());
foreach ($this->object->answers as $index => $answer)
{
$preview->addArea($index, $answer->getArea(), $answer->getCoords(), $answer->getAnswertext(), "", "", true, $this->linecolor);
}
$hidearea = false;
$disabled_save = " disabled=\"disabled\"";
$c = "";
switch ($shape)
{
case "rect":
if (count($coords) == 0)
{
ilUtil::sendInfo($this->lng->txt("rectangle_click_tl_corner"));
}
else if (count($coords) == 1)
{
ilUtil::sendInfo($this->lng->txt("rectangle_click_br_corner"));
$preview->addPoint($preview->getAreaCount(), join($coords, ","), TRUE, "blue");
}
else if (count($coords) == 2)
{
$c = join($coords, ",");
$hidearea = true;
$disabled_save = "";
}
break;
case "circle":
if (count($coords) == 0)
{
ilUtil::sendInfo($this->lng->txt("circle_click_center"));
}
else if (count($coords) == 1)
{
ilUtil::sendInfo($this->lng->txt("circle_click_circle"));
$preview->addPoint($preview->getAreaCount(), join($coords, ","), TRUE, "blue");
}
else if (count($coords) == 2)
{
if (preg_match("/(\d+)\s*,\s*(\d+)\s+(\d+)\s*,\s*(\d+)/", $coords[0] . " " . $coords[1], $matches))
{
$c = "$matches[1],$matches[2]," . (int)sqrt((($matches[3]-$matches[1])*($matches[3]-$matches[1]))+(($matches[4]-$matches[2])*($matches[4]-$matches[2])));
}
$hidearea = true;
$disabled_save = "";
}
break;
case "poly":
if (count($coords) == 0)
{
ilUtil::sendInfo($this->lng->txt("polygon_click_starting_point"));
}
else if (count($coords) == 1)
{
ilUtil::sendInfo($this->lng->txt("polygon_click_next_point"));
$preview->addPoint($preview->getAreaCount(), join($coords, ","), TRUE, "blue");
}
else if (count($coords) > 1)
{
ilUtil::sendInfo($this->lng->txt("polygon_click_next_or_save"));
$disabled_save = "";
$c = join($coords, ",");
}
break;
}
if (strlen($c))
{
$preview->addArea($preview->getAreaCount(), $shape, $c, $_POST["shapetitle"], "", "", true, "blue");
}
$preview->createPreview();
$imagepath = $this->object->getImagePathWeb() . $preview->getPreviewFilename($this->object->getImagePath(), $this->object->getImageFilename()) . "?img=" . time();
if (!$hidearea)
{
$this->tpl->setCurrentBlock("maparea");
$this->tpl->setVariable("IMAGE_SOURCE", "$imagepath");
$this->tpl->setVariable("IMAGEMAP_NAME", "image");
$this->tpl->parseCurrentBlock();
}
else
{
$this->tpl->setCurrentBlock("imagearea");
$this->tpl->setVariable("IMAGE_SOURCE", "$imagepath");
$this->tpl->setVariable("ALT_IMAGE", $this->lng->txt("imagemap"));
$this->tpl->parseCurrentBlock();
}
if (strlen($_POST['shapetitle']))
{
$this->tpl->setCurrentBlock("shapetitle");
$this->tpl->setVariable("VALUE_SHAPETITLE", $_POST["shapetitle"]);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setVariable("TEXT_IMAGEMAP", $this->lng->txt("imagemap"));
$this->tpl->setVariable("TEXT_SHAPETITLE", $this->lng->txt("name"));
$this->tpl->setVariable("CANCEL", $this->lng->txt("cancel"));
$this->tpl->setVariable("SAVE", $this->lng->txt("save"));
$this->tpl->setVariable("DISABLED_SAVE", $disabled_save);
switch ($shape)
{
case "rect":
$this->tpl->setVariable("FORMACTION", $this->ctrl->getFormaction($this, 'addRect'));
break;
case 'circle':
$this->tpl->setVariable("FORMACTION", $this->ctrl->getFormaction($this, 'addCircle'));
break;
case 'poly':
$this->tpl->setVariable("FORMACTION", $this->ctrl->getFormaction($this, 'addPoly'));
break;
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assImagemapQuestionGUI::back ( )

Definition at line 427 of file class.assImagemapQuestionGUI.php.

References ilUtil\sendInfo().

{
ilUtil::sendInfo($this->lng->txt('msg_cancel'), true);
$this->ctrl->redirect($this, 'editQuestion');
}

+ Here is the call graph for this function:

assImagemapQuestionGUI::deleteImage ( )
protected

Definition at line 62 of file class.assImagemapQuestionGUI.php.

References assQuestionGUI\writePostData().

{
$this->writePostData(true);
$this->object->saveToDb();
$this->ctrl->redirect($this, 'editQuestion');
}

+ Here is the call graph for this function:

assImagemapQuestionGUI::editQuestion (   $checkonly = FALSE)

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

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

Referenced by removeArea(), 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("assimagemap");
$this->addBasicQuestionFormProperties( $form );
$this->populateQuestionSpecificFormPart( $form );
// $this->populateAnswerSpecificFormPart( $form ); Nothing to do here, this line FYI. See notes in method.
$this->populateTaxonomyFormSection($form);
$this->addQuestionFormCommandButtons($form);
$errors = false;
if ($save)
{
$form->setValuesByPost();
$errors = !$form->checkInput();
$form->setValuesByPost(); // again, because checkInput now performs the whole stripSlashes handling
// and we need this if we don't want to have duplication of backslashes
if ($errors) $checkonly = false;
}
if (!$checkonly) $this->tpl->setVariable("QUESTION_DATA", $form->getHTML());
return $errors;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assImagemapQuestionGUI::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 905 of file class.assImagemapQuestionGUI.php.

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

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

{
return ''; //print_r($relevant_answers,true);
}
assImagemapQuestionGUI::getCommand (   $cmd)

Reimplemented from assQuestionGUI.

Definition at line 49 of file class.assImagemapQuestionGUI.php.

References $_POST, and $cmd.

{
if (isset($_POST["imagemap"]) ||
isset($_POST["imagemap_x"]) ||
isset($_POST["imagemap_y"]))
{
$this->ctrl->setCmd("getCoords");
$cmd = "getCoords";
}
return $cmd;
}
assImagemapQuestionGUI::getPreview (   $show_question_only = FALSE,
  $showInlineFeedback = false 
)

Reimplemented from assQuestionGUI.

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

References $linecolor, $preview, assQuestionGUI\getILIASPage(), assQuestionGUI\getPreviewSession(), assQuestionGUI\getQuestionActionCmd(), assQuestionGUI\getTargetGuiClass(), and ilUtil\prepareFormOutput().

{
if( is_object($this->getPreviewSession()) )
{
$user_solution = array();
if( is_array($this->getPreviewSession()->getParticipantsSolution()) )
{
$user_solution = array_values($this->getPreviewSession()->getParticipantsSolution());
}
include_once "./Modules/TestQuestionPool/classes/class.ilImagemapPreview.php";
$preview = new ilImagemapPreview($this->object->getImagePath().$this->object->getImageFilename());
foreach ($user_solution as $idx => $solution_value)
{
if (strcmp($solution_value, "") != 0)
{
$preview->addArea($solution_value, $this->object->answers[$solution_value]->getArea(), $this->object->answers[$solution_value]->getCoords(), $this->object->answers[$solution_value]->getAnswertext(), "", "", true, $this->linecolor);
}
}
$preview->createPreview();
$imagepath = $this->object->getImagePathWeb() . $preview->getPreviewFilename($this->object->getImagePath(), $this->object->getImageFilename());
}
else
{
$user_solution = array();
$imagepath = $this->object->getImagePathWeb() . $this->object->getImageFilename();
}
// generate the question output
include_once "./Services/UICore/classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_as_qpl_imagemap_question_output.html", TRUE, TRUE, "Modules/TestQuestionPool");
if($this->getQuestionActionCmd())
{
$hrefArea = $this->ctrl->getLinkTargetByClass($this->getTargetGuiClass(), $this->getQuestionActionCmd());
}
else
{
$hrefArea = null;
}
foreach ($this->object->answers as $answer_id => $answer)
{
$parameter = "&selImage=$answer_id";
if(is_array($user_solution) && in_array($answer_id, $user_solution))
{
$parameter = "&remImage=$answer_id";
}
if($hrefArea)
{
$template->setCurrentBlock("imagemap_area_href");
$template->setVariable("HREF_AREA", $hrefArea . $parameter);
$template->parseCurrentBlock();
}
$template->setCurrentBlock("imagemap_area");
$template->setVariable("SHAPE", $answer->getArea());
$template->setVariable("COORDS", $answer->getCoords());
$template->setVariable("ALT", ilUtil::prepareFormOutput($answer->getAnswertext()));
$template->setVariable("TITLE", ilUtil::prepareFormOutput($answer->getAnswertext()));
$template->parseCurrentBlock();
}
$questiontext = $this->object->getQuestion();
$template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
$template->setVariable("IMG_SRC", "$imagepath");
$template->setVariable("IMG_ALT", $this->lng->txt("imagemap"));
$template->setVariable("IMG_TITLE", $this->lng->txt("imagemap"));
$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:

assImagemapQuestionGUI::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 476 of file class.assImagemapQuestionGUI.php.

References $linecolor, $pass, $preview, ilObjTest\_getPass(), ilObjTest\_getUsePreviousAnswers(), assQuestionGUI\getAnswerFeedbackOutput(), assQuestionGUI\getILIASPage(), and ilUtil\getImagePath().

{
$imagepath = $this->object->getImagePathWeb() . $this->object->getImageFilename();
$solutions = array();
if (($active_id > 0) && (!$show_correct_solution))
{
include_once "./Modules/Test/classes/class.ilObjTest.php";
if ((!$showsolution) && !ilObjTest::_getUsePreviousAnswers($active_id, true))
{
if (is_null($pass)) $pass = ilObjTest::_getPass($active_id);
}
$solutions =& $this->object->getSolutionValues($active_id, $pass);
}
else
{
if(!$this->object->getIsMultipleChoice())
{
$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;
}
}
array_push($solutions, array("value1" => $found_index));
}
else
{
// take the correct solution instead of the user solution
foreach($this->object->answers as $index => $answer)
{
$points_checked = $answer->getPoints();
$points_unchecked = $answer->getPointsUnchecked();
if($points_checked > $points_unchecked)
{
if($points_checked > 0)
{
array_push($solutions, array("value1" => $index));
}
}
}
}
}
$solution_id = -1;
if (is_array($solutions))
{
include_once "./Modules/TestQuestionPool/classes/class.ilImagemapPreview.php";
$preview = new ilImagemapPreview($this->object->getImagePath().$this->object->getImageFilename());
foreach ($solutions as $idx => $solution_value)
{
if (strcmp($solution_value["value1"], "") != 0)
{
$preview->addArea($solution_value["value1"], $this->object->answers[$solution_value["value1"]]->getArea(), $this->object->answers[$solution_value["value1"]]->getCoords(), $this->object->answers[$solution_value["value1"]]->getAnswertext(), "", "", true, $this->linecolor);
$solution_id = $solution_value["value1"];
}
}
$preview->createPreview();
$imagepath = $this->object->getImagePathWeb() . $preview->getPreviewFilename($this->object->getImagePath(), $this->object->getImageFilename());
}
// generate the question output
include_once "./Services/UICore/classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_as_qpl_imagemap_question_output_solution.html", TRUE, TRUE, "Modules/TestQuestionPool");
$solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html",TRUE, TRUE, "Modules/TestQuestionPool");
$questiontext = $this->object->getQuestion();
if ($show_question_text==true)
{
$template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
}
$template->setVariable("IMG_SRC", "$imagepath");
$template->setVariable("IMG_ALT", $this->lng->txt("imagemap"));
$template->setVariable("IMG_TITLE", $this->lng->txt("imagemap"));
if (($active_id > 0) && (!$show_correct_solution))
{
if ($graphicalOutput)
{
// output of ok/not ok icons for user entered solutions
$reached_points = $this->object->getReachedPoints($active_id, $pass);
if ($reached_points == $this->object->getMaximumPoints())
{
$template->setCurrentBlock("icon_ok");
$template->setVariable("ICON_OK", ilUtil::getImagePath("icon_ok.svg"));
$template->setVariable("TEXT_OK", $this->lng->txt("answer_is_right"));
$template->parseCurrentBlock();
}
else
{
$template->setCurrentBlock("icon_ok");
if ($reached_points > 0)
{
$template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_mostly_ok.svg"));
$template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_not_correct_but_positive"));
}
else
{
$template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_not_ok.svg"));
$template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_wrong"));
}
$template->parseCurrentBlock();
}
}
}
if ($show_feedback)
{
$fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
$this->object->getId(), $solution_id
);
if (strlen($fb))
{
$template->setCurrentBlock("feedback");
$template->setVariable("FEEDBACK", $fb);
$template->parseCurrentBlock();
}
}
$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:

assImagemapQuestionGUI::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 873 of file class.assImagemapQuestionGUI.php.

{
if( !$this->object->feedbackOBJ->specificAnswerFeedbackExists(array_values($this->object->getAnswers())) )
{
return '';
}
$output = '<table class="test_specific_feedback"><tbody>';
foreach($this->object->getAnswers() as $idx => $answer)
{
$feedback = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
$this->object->getId(), $idx
);
$output .= "<tr><td>{$answer->getAnswerText()}</td><td>{$feedback}</td></tr>";
}
$output .= '</tbody></table>';
return $this->object->prepareTextareaOutput($output, TRUE);
}
assImagemapQuestionGUI::getTestOutput (   $active_id,
  $pass = NULL,
  $is_postponed = FALSE,
  $use_post_solutions = FALSE,
  $show_feedback = FALSE 
)

Definition at line 698 of file class.assImagemapQuestionGUI.php.

References $linecolor, $pass, $preview, ilObjTest\_getPass(), ilObjTest\_getUsePreviousAnswers(), assQuestionGUI\getQuestionActionCmd(), assQuestionGUI\getTargetGuiClass(), 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($this->object->getIsMultipleChoice())
{
$user_solution = array();
}
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)
{
if($this->object->getIsMultipleChoice())
{
$user_solution[] = $solution_value["value1"];
}
else
{
$user_solution = $solution_value["value1"];
}
}
}
$imagepath = $this->object->getImagePathWeb() . $this->object->getImageFilename();
if ($active_id)
{
$solutions = NULL;
include_once "./Modules/Test/classes/class.ilObjTest.php";
if ((!$showsolution) && !ilObjTest::_getUsePreviousAnswers($active_id, true))
{
if (is_null($pass)) $pass = ilObjTest::_getPass($active_id);
}
$solutions =& $this->object->getSolutionValues($active_id, $pass);
include_once "./Modules/TestQuestionPool/classes/class.ilImagemapPreview.php";
$preview = new ilImagemapPreview($this->object->getImagePath().$this->object->getImageFilename());
foreach ($solutions as $idx => $solution_value)
{
if (strcmp($solution_value["value1"], "") != 0)
{
$preview->addArea($solution_value["value1"], $this->object->answers[$solution_value["value1"]]->getArea(), $this->object->answers[$solution_value["value1"]]->getCoords(), $this->object->answers[$solution_value["value1"]]->getAnswertext(), "", "", true, $this->linecolor);
}
}
$preview->createPreview();
$imagepath = $this->object->getImagePathWeb() . $preview->getPreviewFilename($this->object->getImagePath(), $this->object->getImageFilename());
}
// generate the question output
include_once "./Services/UICore/classes/class.ilTemplate.php";
$template = new ilTemplate("tpl.il_as_qpl_imagemap_question_output.html", TRUE, TRUE, "Modules/TestQuestionPool");
$this->ctrl->setParameterByClass($this->getTargetGuiClass(), "formtimestamp", time());
$hrefArea = $this->ctrl->getLinkTargetByClass($this->getTargetGuiClass(), $this->getQuestionActionCmd());
foreach ($this->object->answers as $answer_id => $answer)
{
$template->setCurrentBlock("imagemap_area");
$parameter = "&amp;selImage=$answer_id";
if(is_array($user_solution) && in_array($answer_id, $user_solution))
{
$parameter = "&amp;remImage=$answer_id";
}
$template->setVariable("HREF_AREA", $hrefArea . $parameter);
$template->setVariable("SHAPE", $answer->getArea());
$template->setVariable("COORDS", $answer->getCoords());
$template->setVariable("ALT", ilUtil::prepareFormOutput($answer->getAnswertext()));
$template->setVariable("TITLE", ilUtil::prepareFormOutput($answer->getAnswertext()));
$template->parseCurrentBlock();
if ($show_feedback)
{
if(!$this->object->getIsMultipleChoice() && strlen($user_solution) && $user_solution == $answer_id)
{
$feedback = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
$this->object->getId(), $answer_id
);
if (strlen($feedback))
{
$template->setCurrentBlock("feedback");
$template->setVariable("FEEDBACK", $feedback);
$template->parseCurrentBlock();
}
}
}
}
$questiontext = $this->object->getQuestion();
$template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($questiontext, TRUE));
$template->setVariable("IMG_SRC", "$imagepath");
$template->setVariable("IMG_ALT", $this->lng->txt("imagemap"));
$template->setVariable("IMG_TITLE", $this->lng->txt("imagemap"));
$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:

assImagemapQuestionGUI::outQuestionForTest (   $formaction,
  $active_id,
  $pass = NULL,
  $is_question_postponed = FALSE,
  $user_post_solutions = FALSE,
  $show_specific_inline_feedback = FALSE 
)
Parameters
string$formaction
integer$active_id
integer | null$pass
bool$is_question_postponed
bool$user_post_solutions
bool$show_specific_inline_feedback

Reimplemented from assQuestionGUI.

Definition at line 433 of file class.assImagemapQuestionGUI.php.

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

{
// TODO - BEGIN: what exactly is done here? cant we use the parent method?
require_once './Modules/Test/classes/class.ilObjTest.php';
if (!ilObjTest::_getUsePreviousAnswers($active_id, true))
{
$pass = ilObjTest::_getPass($active_id);
$info =& $this->object->getSolutionValues($active_id, $pass);
}
else
{
$info =& $this->object->getSolutionValues($active_id, NULL);
}
if (count($info))
{
if (strcmp($info[0]["value1"], "") != 0)
{
$formaction .= "&selImage=" . $info[0]["value1"];
}
}
$test_output = $this->getTestOutput($active_id, $pass, $is_postponed, $use_post_solutions, $show_feedback);
$this->tpl->setVariable("QUESTION_OUTPUT", $test_output);
$this->tpl->setVariable("FORMACTION", $formaction);
// TODO - END: what exactly is done here? cant we use the parent method?
}

+ Here is the call graph for this function:

assImagemapQuestionGUI::populateAnswerSpecificFormPart ( \ilPropertyFormGUI  $form)

Definition at line 185 of file class.assImagemapQuestionGUI.php.

{
return $form; // Nothing to do here since selectable areas are handled in question-specific-form part
// due to their immediate dependency to the image. I decide to not break up the interfaces
// more just to support this very rare case. tl;dr: See the issue, ignore it.
}
assImagemapQuestionGUI::populateQuestionSpecificFormPart ( \ilPropertyFormGUI  $form)

Definition at line 192 of file class.assImagemapQuestionGUI.php.

References $linecolor, ilPropertyFormGUI\addItem(), assImagemapQuestion\MODE_MULTIPLE_CHOICE, assImagemapQuestion\MODE_SINGLE_CHOICE, ilImagemapFileInputGUI\setPointsUncheckedFieldEnabled(), ilFormPropertyGUI\setRequired(), and ilRadioGroupInputGUI\setValue().

Referenced by editQuestion().

{
// is MultipleChoice?
$radioGroup = new ilRadioGroupInputGUI($this->lng->txt( 'tst_imap_qst_mode' ), 'is_multiple_choice');
$radioGroup->setValue( $this->object->getIsMultipleChoice() );
$modeSingleChoice = new ilRadioOption($this->lng->txt( 'tst_imap_qst_mode_sc'),
assImagemapQuestion::MODE_SINGLE_CHOICE);
$modeMultipleChoice = new ilRadioOption($this->lng->txt( 'tst_imap_qst_mode_mc'),
assImagemapQuestion::MODE_MULTIPLE_CHOICE);
$radioGroup->addOption( $modeSingleChoice );
$radioGroup->addOption( $modeMultipleChoice );
$form->addItem( $radioGroup );
// image
include_once "./Modules/TestQuestionPool/classes/class.ilImagemapFileInputGUI.php";
$image = new ilImagemapFileInputGUI($this->lng->txt( 'image' ), 'image');
$image->setPointsUncheckedFieldEnabled( $this->object->getIsMultipleChoice() );
$image->setRequired( true );
if (strlen( $this->object->getImageFilename() ))
{
$image->setImage( $this->object->getImagePathWeb() . $this->object->getImageFilename() );
$image->setValue( $this->object->getImageFilename() );
$image->setAreas( $this->object->getAnswers() );
$assessmentSetting = new ilSetting("assessment");
$linecolor = (strlen( $assessmentSetting->get( "imap_line_color" )
)) ? "\"#" . $assessmentSetting->get( "imap_line_color" ) . "\"" : "\"#FF0000\"";
$image->setLineColor( $linecolor );
$image->setImagePath( $this->object->getImagePath() );
$image->setImagePathWeb( $this->object->getImagePathWeb() );
}
$form->addItem( $image );
// imagemapfile
$imagemapfile = new ilFileInputGUI($this->lng->txt( 'add_imagemap' ), 'imagemapfile');
$imagemapfile->setRequired( false );
$form->addItem( $imagemapfile );
return $form;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

assImagemapQuestionGUI::removeArea ( )

Definition at line 419 of file class.assImagemapQuestionGUI.php.

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

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

+ Here is the call graph for this function:

assImagemapQuestionGUI::saveShape ( )

Saves a shape of the area editor.

Definition at line 250 of file class.assImagemapQuestionGUI.php.

References $_POST, and ilUtil\sendSuccess().

{
$coords = "";
switch ($_POST["shape"])
{
case "rect":
$coords = join($_POST['image']['mapcoords'], ",");
ilUtil::sendSuccess($this->lng->txt('msg_rect_added'), true);
break;
case "circle":
if (preg_match("/(\d+)\s*,\s*(\d+)\s+(\d+)\s*,\s*(\d+)/", $_POST['image']['mapcoords'][0] . " " . $_POST['image']['mapcoords'][1], $matches))
{
$coords = "$matches[1],$matches[2]," . (int)sqrt((($matches[3]-$matches[1])*($matches[3]-$matches[1]))+(($matches[4]-$matches[2])*($matches[4]-$matches[2])));
}
ilUtil::sendSuccess($this->lng->txt('msg_circle_added'), true);
break;
case "poly":
$coords = join($_POST['image']['mapcoords'], ",");
ilUtil::sendSuccess($this->lng->txt('msg_poly_added'), true);
break;
}
$this->object->addAnswer($_POST["shapetitle"], 0, count($this->object->getAnswers()), $coords, $_POST["shape"]);
$this->object->saveToDb();
$this->ctrl->redirect($this, 'editQuestion');
}

+ Here is the call graph for this function:

assImagemapQuestionGUI::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 803 of file class.assImagemapQuestionGUI.php.

References $_GET, $_POST, 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");
if (array_key_exists("imagemap_x", $_POST))
{
$force_active = true;
}
// edit question properties
$ilTabs->addTarget("edit_question",
$url,
array("editQuestion", "save", "addArea", "addRect", "addCircle", "addPoly",
"uploadingImage", "uploadingImagemap", "areaEditor",
"removeArea", "saveShape", "saveEdit", "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:

assImagemapQuestionGUI::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 91 of file class.assImagemapQuestionGUI.php.

References $_POST.

Referenced by writePostData().

{
if ($this->ctrl->getCmd() != 'deleteImage')
{
$this->object->flushAnswers();
if (is_array( $_POST['image']['coords']['name'] ))
{
foreach ($_POST['image']['coords']['name'] as $idx => $name)
{
if( $this->object->getIsMultipleChoice() && isset($_POST['image']['coords']['points_unchecked']) )
{
$pointsUnchecked = $_POST['image']['coords']['points_unchecked'][$idx];
}
else
{
$pointsUnchecked = 0.0;
}
$this->object->addAnswer(
$name,
$_POST['image']['coords']['points'][$idx],
$idx,
$_POST['image']['coords']['coords'][$idx],
$_POST['image']['coords']['shape'][$idx],
$pointsUnchecked
);
}
}
if (strlen( $_FILES['imagemapfile']['tmp_name'] ))
{
if ($this->object->getSelfAssessmentEditingMode() && $this->object->getId() < 1)
$this->object->createNewQuestion();
$this->object->uploadImagemap( $_FILES['imagemapfile']['tmp_name'] );
}
}
}

+ Here is the caller graph for this function:

assImagemapQuestionGUI::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 76 of file class.assImagemapQuestionGUI.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';
$this->writeQuestionGenericPostData();
$this->writeQuestionSpecificPostData(new ilPropertyFormGUI());
$this->writeAnswerSpecificPostData(new ilPropertyFormGUI());
$this->saveTaxonomyAssignments();
return 0;
}
return 1;
}

+ Here is the call graph for this function:

assImagemapQuestionGUI::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 128 of file class.assImagemapQuestionGUI.php.

References $_POST, and assImagemapQuestion\MODE_MULTIPLE_CHOICE.

Referenced by writePostData().

{
if ($this->ctrl->getCmd() == 'deleteImage')
{
$this->object->deleteImage();
}
else
{
if (strlen( $_FILES['image']['tmp_name'] ) == 0)
{
$this->object->setImageFilename( $_POST["image_name"] );
}
}
if (strlen( $_FILES['image']['tmp_name'] ))
{
if ($this->object->getSelfAssessmentEditingMode() && $this->object->getId() < 1)
$this->object->createNewQuestion();
$this->object->setImageFilename( $_FILES['image']['name'], $_FILES['image']['tmp_name'] );
}
$this->object->setIsMultipleChoice($_POST['is_multiple_choice'] == assImagemapQuestion::MODE_MULTIPLE_CHOICE);
}

+ Here is the caller graph for this function:

Field Documentation

assImagemapQuestionGUI::$linecolor
private

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

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

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