ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
class.assErrorTextGUI.php
Go to the documentation of this file.
1<?php
2/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */
3
4require_once './Modules/TestQuestionPool/classes/class.assQuestionGUI.php';
5require_once './Modules/TestQuestionPool/interfaces/interface.ilGuiQuestionScoringAdjustable.php';
6require_once './Modules/TestQuestionPool/interfaces/interface.ilGuiAnswerScoringAdjustable.php';
7
8require_once './Modules/Test/classes/inc.AssessmentConstants.php';
9
25{
34 public function __construct($id = -1)
35 {
36 parent::__construct();
37 include_once "./Modules/TestQuestionPool/classes/class.assErrorText.php";
38 $this->object = new assErrorText();
39 $this->setErrorMessage($this->lng->txt("msg_form_save_error"));
40 if ($id >= 0) {
41 $this->object->loadFromDb($id);
42 }
43 }
44
48 protected function writePostData($always = false)
49 {
50 $hasErrors = (!$always) ? $this->editQuestion(true) : false;
51 if (!$hasErrors) {
52 require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
57 return 0;
58 }
59 return 1;
60 }
61
63 {
64 if (is_array($_POST['errordata']['key'])) {
65 $this->object->flushErrorData();
66 foreach ($_POST['errordata']['key'] as $idx => $val) {
67 $this->object->addErrorData(
68 $val,
69 $_POST['errordata']['value'][$idx],
70 $_POST['errordata']['points'][$idx]
71 );
72 }
73 }
74 }
75
77 {
78 $questiontext = $_POST["question"];
79 $this->object->setQuestion($questiontext);
80 $this->object->setErrorText($_POST["errortext"]);
81 $points_wrong = str_replace(",", ".", $_POST["points_wrong"]);
82 if (strlen($points_wrong) == 0) {
83 $points_wrong = -1.0;
84 }
85 $this->object->setPointsWrong($points_wrong);
86
87 if (!$this->object->getSelfAssessmentEditingMode()) {
88 $this->object->setTextSize($_POST["textsize"]);
89 }
90 }
91
99 public function editQuestion($checkonly = false)
100 {
101 $save = $this->isSaveCommand();
102 $this->getQuestionTemplate();
103
104 include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
105 $form = new ilPropertyFormGUI();
106 $this->editForm = $form;
107
108 $form->setFormAction($this->ctrl->getFormAction($this));
109 $form->setTitle($this->outQuestionType());
110 $form->setMultipart(false);
111 $form->setTableWidth("100%");
112 $form->setId("orderinghorizontal");
113
115
117
118 if (count($this->object->getErrorData()) || $checkonly) {
120 }
121
123
124 $form->addCommandButton("analyze", $this->lng->txt('analyze_errortext'));
126
127 $errors = false;
128
129 if ($save) {
130 $form->setValuesByPost();
131 $errors = !$form->checkInput();
132 $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
133 if ($errors) {
134 $checkonly = false;
135 }
136 }
137
138 if (!$checkonly) {
139 $this->tpl->setVariable("QUESTION_DATA", $form->getHTML());
140 }
141 return $errors;
142 }
143
149 {
151 $header->setTitle($this->lng->txt("errors_section"));
152 $form->addItem($header);
153
154 include_once "./Modules/TestQuestionPool/classes/class.ilErrorTextWizardInputGUI.php";
155 $errordata = new ilErrorTextWizardInputGUI($this->lng->txt("errors"), "errordata");
156 $errordata->setKeyName($this->lng->txt('text_wrong'));
157 $errordata->setValueName($this->lng->txt('text_correct'));
158 $errordata->setValues($this->object->getErrorData());
159 $form->addItem($errordata);
160
161 // points for wrong selection
162 $points_wrong = new ilNumberInputGUI($this->lng->txt("points_wrong"), "points_wrong");
163 $points_wrong->allowDecimals(true);
164 $points_wrong->setMaxValue(0);
165 $points_wrong->setMaxvalueShouldBeLess(true);
166 $points_wrong->setValue($this->object->getPointsWrong());
167 $points_wrong->setInfo($this->lng->txt("points_wrong_info"));
168 $points_wrong->setSize(6);
169 $points_wrong->setRequired(true);
170 $form->addItem($points_wrong);
171 return $form;
172 }
173
179 {
180 // errortext
181 $errortext = new ilTextAreaInputGUI($this->lng->txt("errortext"), "errortext");
182 $errortext->setValue($this->object->getErrorText());
183 $errortext->setRequired(true);
184 $errortext->setInfo($this->lng->txt("errortext_info"));
185 $errortext->setRows(10);
186 $errortext->setCols(80);
187 $form->addItem($errortext);
188
189 if (!$this->object->getSelfAssessmentEditingMode()) {
190 // textsize
191 $textsize = new ilNumberInputGUI($this->lng->txt("textsize"), "textsize");
192 $textsize->setValue(strlen($this->object->getTextSize()) ? $this->object->getTextSize() : 100.0);
193 $textsize->setInfo($this->lng->txt("textsize_errortext_info"));
194 $textsize->setSize(6);
195 $textsize->setSuffix("%");
196 $textsize->setMinValue(10);
197 $textsize->setRequired(true);
198 $form->addItem($textsize);
199 }
200 }
201
205 public function analyze()
206 {
207 $this->writePostData(true);
208 $this->object->setErrorData($this->object->getErrorsFromText($_POST['errortext']));
209 $this->editQuestion();
210 }
211
230 public function getSolutionOutput(
231 $active_id,
232 $pass = null,
233 $graphicalOutput = false,
234 $result_output = false,
235 $show_question_only = true,
236 $show_feedback = false,
237 $show_correct_solution = false,
238 $show_manual_scoring = false,
239 $show_question_text = true
240 ) {
241 // get the solution of the user for the active pass or from the last pass if allowed
242 $template = new ilTemplate("tpl.il_as_qpl_errortext_output_solution.html", true, true, "Modules/TestQuestionPool");
243
244 $selections = array();
245 if (($active_id > 0) && (!$show_correct_solution)) {
246
247 /* Retrieve tst_solutions entries. */
248 $reached_points = $this->object->getReachedPoints($active_id, $pass);
249 $solutions =&$this->object->getSolutionValues($active_id, $pass);
250 if (is_array($solutions)) {
251 foreach ($solutions as $solution) {
252 array_push($selections, (int) $solution['value1']);
253 }
254 $errortext_value = join(",", $selections);
255 }
256 } else {
257 $selections = $this->object->getBestSelection();
258 $reached_points = $this->object->getPoints();
259 }
260
261 if ($result_output) {
262 $resulttext = ($reached_points == 1) ? "(%s " . $this->lng->txt("point") . ")" : "(%s " . $this->lng->txt("points") . ")";
263 $template->setVariable("RESULT_OUTPUT", sprintf($resulttext, $reached_points));
264 }
265
266 if ($this->object->getTextSize() >= 10) {
267 $template->setVariable("STYLE", " style=\"font-size: " . $this->object->getTextSize() . "%;\"");
268 }
269
270 if ($show_question_text==true) {
271 $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($this->object->getQuestion(), true));
272 }
273
274 $errortext = $this->object->createErrorTextOutput($selections, $graphicalOutput, $show_correct_solution, false);
275
276 $template->setVariable("ERRORTEXT", $errortext);
277 $questionoutput = $template->get();
278
279 $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html", true, true, "Modules/TestQuestionPool");
280
281 $feedback = '';
282 if ($show_feedback) {
283 if (!$this->isTestPresentationContext()) {
284 $fb = $this->getGenericFeedbackOutput($active_id, $pass);
285 $feedback .= strlen($fb) ? $fb : '';
286 }
287
288 $fb = $this->getSpecificFeedbackOutput($active_id, $pass);
289 $feedback .= strlen($fb) ? $fb : '';
290 }
291 if (strlen($feedback)) {
292 $cssClass = (
293 $this->hasCorrectSolution($active_id, $pass) ?
295 );
296
297 $solutiontemplate->setVariable("ILC_FB_CSS_CLASS", $cssClass);
298 $solutiontemplate->setVariable("FEEDBACK", $this->object->prepareTextareaOutput($feedback, true));
299 }
300
301 $solutiontemplate->setVariable("SOLUTION_OUTPUT", $questionoutput);
302
303 $solutionoutput = $solutiontemplate->get();
304 if (!$show_question_only) {
305 // get page object output
306 $solutionoutput = $this->getILIASPage($solutionoutput);
307 }
308 return $solutionoutput;
309 }
310
311 public function getPreview($show_question_only = false, $showInlineFeedback = false)
312 {
313 $selections = is_object($this->getPreviewSession()) ? (array) $this->getPreviewSession()->getParticipantsSolution() : array();
314
315 $template = new ilTemplate("tpl.il_as_qpl_errortext_output.html", true, true, "Modules/TestQuestionPool");
316 if ($this->object->getTextSize() >= 10) {
317 $template->setVariable("STYLE", " style=\"font-size: " . $this->object->getTextSize() . "%;\"");
318 }
319 $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($this->object->getQuestion(), true));
320 $errortext = $this->object->createErrorTextOutput($selections);
321 $template->setVariable("ERRORTEXT", $errortext);
322 $template->setVariable("ERRORTEXT_ID", "qst_" . $this->object->getId());
323 $questionoutput = $template->get();
324 if (!$show_question_only) {
325 // get page object output
326 $questionoutput = $this->getILIASPage($questionoutput);
327 }
328 $this->tpl->addJavascript("./Modules/TestQuestionPool/templates/default/errortext.js");
329 return $questionoutput;
330 }
331
332 public function getTestOutput(
333 $active_id,
334 // hey: prevPassSolutions - will be always available from now on
335 $pass,
336 // hey.
337 $is_postponed = false,
338 $use_post_solutions = false,
339 $show_feedback = false
340 ) {
341 // generate the question output
342 $template = new ilTemplate("tpl.il_as_qpl_errortext_output.html", true, true, "Modules/TestQuestionPool");
343 if ($active_id) {
344 // hey: prevPassSolutions - obsolete due to central check
345 #$solutions = NULL;
346 #include_once "./Modules/Test/classes/class.ilObjTest.php";
347 #if (!ilObjTest::_getUsePreviousAnswers($active_id, true))
348 #{
349 # if (is_null($pass)) $pass = ilObjTest::_getPass($active_id);
350 #}
351 $solutions = $this->object->getTestOutputSolutions($active_id, $pass);
352 // hey.
353 }
354 $errortext_value = "";
355 $selections = array();
356 if (is_array($solutions)) {
357 foreach ($solutions as $solution) {
358 array_push($selections, $solution['value1']);
359 }
360 $errortext_value = join(",", $selections);
361 }
362 if ($this->object->getTextSize() >= 10) {
363 $template->setVariable("STYLE", " style=\"font-size: " . $this->object->getTextSize() . "%;\"");
364 }
365 $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($this->object->getQuestion(), true));
366 $errortext = $this->object->createErrorTextOutput($selections);
367 $this->ctrl->setParameterByClass($this->getTargetGuiClass(), 'errorvalue', '');
368 $template->setVariable("ERRORTEXT", $errortext);
369 $template->setVariable("ERRORTEXT_ID", "qst_" . $this->object->getId());
370 $template->setVariable("ERRORTEXT_VALUE", $errortext_value);
371
372 $questionoutput = $template->get();
373 if (!$show_question_only) {
374 // get page object output
375 $questionoutput = $this->getILIASPage($questionoutput);
376 }
377 $this->tpl->addJavascript("./Modules/TestQuestionPool/templates/default/errortext.js");
378 $questionoutput = $template->get();
379 $pageoutput = $this->outQuestionPage("", $is_postponed, $active_id, $questionoutput);
380 return $pageoutput;
381 }
382
390 public function setQuestionTabs()
391 {
392 global $rbacsystem, $ilTabs;
393
394 $ilTabs->clearTargets();
395
396 $this->ctrl->setParameterByClass("ilAssQuestionPageGUI", "q_id", $_GET["q_id"]);
397 include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
398 $q_type = $this->object->getQuestionType();
399
400 if (strlen($q_type)) {
401 $classname = $q_type . "GUI";
402 $this->ctrl->setParameterByClass(strtolower($classname), "sel_question_types", $q_type);
403 $this->ctrl->setParameterByClass(strtolower($classname), "q_id", $_GET["q_id"]);
404 }
405
406 if ($_GET["q_id"]) {
407 if ($rbacsystem->checkAccess('write', $_GET["ref_id"])) {
408 // edit page
409 $ilTabs->addTarget(
410 "edit_page",
411 $this->ctrl->getLinkTargetByClass("ilAssQuestionPageGUI", "edit"),
412 array("edit", "insert", "exec_pg"),
413 "",
414 "",
415 $force_active
416 );
417 }
418
419 $this->addTab_QuestionPreview($ilTabs);
420 }
421
422 $force_active = false;
423 if ($rbacsystem->checkAccess('write', $_GET["ref_id"])) {
424 $url = "";
425 if ($classname) {
426 $url = $this->ctrl->getLinkTargetByClass($classname, "editQuestion");
427 }
428 // edit question properties
429 $ilTabs->addTarget(
430 "edit_question",
431 $url,
432 array("editQuestion", "save", "saveEdit", "analyze", "originalSyncForm"),
433 $classname,
434 "",
435 $force_active
436 );
437 }
438
439 // add tab for question feedback within common class assQuestionGUI
440 $this->addTab_QuestionFeedback($ilTabs);
441
442 // add tab for question hint within common class assQuestionGUI
443 $this->addTab_QuestionHints($ilTabs);
444
445 // add tab for question's suggested solution within common class assQuestionGUI
446 $this->addTab_SuggestedSolution($ilTabs, $classname);
447
448 // Assessment of questions sub menu entry
449 if ($_GET["q_id"]) {
450 $ilTabs->addTarget(
451 "statistics",
452 $this->ctrl->getLinkTargetByClass($classname, "assessment"),
453 array("assessment"),
454 $classname,
455 ""
456 );
457 }
458
459 $this->addBackTab($ilTabs);
460 }
461
462 public function getSpecificFeedbackOutput($active_id, $pass)
463 {
464 $selection = $this->object->getBestSelection(false);
465
466 if (!$this->object->feedbackOBJ->specificAnswerFeedbackExists(array_keys($selection))) {
467 return '';
468 }
469
470 $feedback = '<table class="test_specific_feedback"><tbody>';
471
472 $elements = array();
473 foreach (preg_split("/[\n\r]+/", $this->object->errortext) as $line) {
474 $elements = array_merge($elements, preg_split("/\s+/", $line));
475 }
476
477 $matchedIndexes = array();
478
479 $i = 0;
480 foreach ($selection as $index => $answer) {
481 $element = array();
482 foreach ($answer as $answerPartIndex) {
483 $element[] = $elements[$answerPartIndex];
484 }
485
486 $element = implode(' ', $element);
487 $element = str_replace(array('((', '))', '#'), array('', '', ''), $element);
488
489 $ordinal = $index + 1;
490
491 $feedback .= '<tr>';
492
493 $feedback .= '<td class="text-nowrap">' . $ordinal . '. ' . $element . ':</td>';
494
495 foreach ($this->object->getErrorData() as $idx => $ans) {
496 if (isset($matchedIndexes[$idx])) {
497 continue;
498 }
499
500 if (preg_match('/' . preg_quote($ans->text_wrong, '/') . '/', $element)) {
501 $fb = $this->object->feedbackOBJ->getSpecificAnswerFeedbackTestPresentation(
502 $this->object->getId(),
503 $idx
504 );
505
506 $feedback .= '<td>' . $fb . '</td>';
507
508 $matchedIndexes[$idx] = $idx;
509
510 break;
511 }
512 }
513
514 $feedback .= '</tr>';
515 }
516
517 $feedback .= '</tbody></table>';
518
519 return $this->object->prepareTextareaOutput($feedback, true);
520 }
521
532 {
533 return array();
534 }
535
546 {
547 return array();
548 }
549
558 public function getAggregatedAnswersView($relevant_answers)
559 {
560 $errortext = $this->object->getErrorText();
561
562 $passdata = array(); // Regroup answers into units of passes.
563 foreach ($relevant_answers as $answer_chosen) {
564 $passdata[$answer_chosen['active_fi'] . '-' . $answer_chosen['pass']][$answer_chosen['value2']][] = $answer_chosen['value1'];
565 }
566
567 $html = '';
568 foreach ($passdata as $key => $pass) {
569 $passdata[$key] = $this->object->createErrorTextOutput($pass);
570 $html .= $passdata[$key] . '<hr /><br />';
571 }
572
573 return $html;
574 }
575}
sprintf('%.4f', $callTime)
$_GET["client_id"]
$_POST["username"]
An exception for terminatinating execution or to throw for unit testing.
The assErrorTextGUI class encapsulates the GUI representation for error text questions.
setQuestionTabs()
Sets the ILIAS tabs for this question type.
getPreview($show_question_only=false, $showInlineFeedback=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.
getAggregatedAnswersView($relevant_answers)
Returns an html string containing a question specific representation of the answers so far given in t...
editQuestion($checkonly=false)
Creates an output of the edit form for the question.
getAfterParticipationSuppressionQuestionPostVars()
Returns a list of postvars which will be suppressed in the form output when used in scoring adjustmen...
populateQuestionSpecificFormPart(ilPropertyFormGUI $form)
writeQuestionSpecificPostData(ilPropertyFormGUI $form)
Extracts the question specific values from $_POST and applies them to the data object.
writeAnswerSpecificPostData(ilPropertyFormGUI $form)
Extracts the answer specific values from $_POST and applies them to the data object.
getAfterParticipationSuppressionAnswerPostVars()
Returns a list of postvars which will be suppressed in the form output when used in scoring adjustmen...
populateAnswerSpecificFormPart(ilPropertyFormGUI $form)
writePostData($always=false)
{Evaluates a posted edit form and writes the form data in the question object.integer A positive valu...
__construct($id=-1)
assErrorTextGUI constructor
getTestOutput( $active_id, $pass, $is_postponed=false, $use_post_solutions=false, $show_feedback=false)
getSpecificFeedbackOutput($active_id, $pass)
Returns the answer specific feedback for the question.
analyze()
Parse the error text.
Class for error text questions.
Basic GUI class for assessment questions.
populateTaxonomyFormSection(ilPropertyFormGUI $form)
setErrorMessage($errormessage)
addTab_QuestionHints(ilTabsGUI $tabs)
adds the hints tab to ilTabsGUI
addQuestionFormCommandButtons($form)
Add the command buttons of a question properties form.
getILIASPage($html="")
Returns the ILIAS Page around a question.
getQuestionTemplate()
get question template
addTab_SuggestedSolution(ilTabsGUI $tabs, $classname)
outQuestionPage($a_temp_var, $a_postponed=false, $active_id="", $html="")
output question page
addBackTab(ilTabsGUI $ilTabs)
hasCorrectSolution($activeId, $passIndex)
addTab_QuestionFeedback(ilTabsGUI $tabs)
adds the feedback tab to ilTabsGUI
addBasicQuestionFormProperties($form)
Add basic question form properties: assessment: title, author, description, question,...
addTab_QuestionPreview(ilTabsGUI $tabsGUI)
getGenericFeedbackOutput($active_id, $pass)
Returns the answer specific feedback for the question.
This class represents a key value pair wizard property in a property form.
This class represents a section header in a property form.
This class represents a number property in a property form.
This class represents a property form user interface.
special template class to simplify handling of ITX/PEAR
This class represents a text area property in a property form.
$template
$key
Definition: croninfo.php:18
$i
Definition: disco.tpl.php:19
$html
Definition: example_001.php:87
if(!array_key_exists('StateId', $_REQUEST)) $id
Interface ilGuiAnswerScoringAdjustable.
Interface ilGuiQuestionScoringAdjustable.
$index
Definition: metadata.php:60
$errors
Definition: index.php:6
$url
if(isset($_POST['submit'])) $form