ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
class.ilPCQuestion.php
Go to the documentation of this file.
1<?php
2
3/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */
4
5
6require_once("./Services/COPage/classes/class.ilPageContent.php");
7
19{
23 protected $lng;
24
28 protected $ctrl;
29
33 protected $user;
34
35 public $dom;
36 public $q_node; // node of Paragraph element
37
38 protected static $initial_done; // [bool]
39
43 public function init()
44 {
45 global $DIC;
46
47 $this->lng = $DIC->language();
48 $this->ctrl = $DIC->ctrl();
49 $this->user = $DIC->user();
50 $this->setType("pcqst");
51 }
52
56 public function setNode($a_node)
57 {
58 parent::setNode($a_node); // this is the PageContent node
59 $this->q_node = $a_node->first_child(); //... and this the Question
60 }
61
67 public function setQuestionReference($a_questionreference)
68 {
69 if (is_object($this->q_node)) {
70 $this->q_node->set_attribute("QRef", $a_questionreference);
71 }
72 }
73
79 public function getQuestionReference()
80 {
81 if (is_object($this->q_node)) {
82 return $this->q_node->get_attribute("QRef", $a_questionreference);
83 }
84 return false;
85 }
86
90 public function create(&$a_pg_obj, $a_hier_id)
91 {
92 $this->createPageContentNode();
93 $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER);
94 $this->q_node = $this->dom->create_element("Question");
95 $this->q_node = $this->node->append_child($this->q_node);
96 $this->q_node->set_attribute("QRef", "");
97 }
98
105 public function copyPoolQuestionIntoPage($a_q_id, $a_hier_id)
106 {
107 include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
108 include_once "./Modules/TestQuestionPool/classes/class.assQuestionGUI.php";
109 $question = assQuestion::_instanciateQuestion($a_q_id);
110 $duplicate_id = $question->copyObject(0, $question->getTitle());
111 $duplicate = assQuestion::_instanciateQuestion($duplicate_id);
112 $duplicate->setObjId(0);
113
114 /* PATCH-BEGIN: moved cleanup code to central place ilAssSelfAssessmentQuestionFormatter */
115 /*
116 // we remove everything not supported by the non-tiny self
117 // assessment question editor
118 $q = $duplicate->getQuestion();
119
120 // we try to save all latex tags
121 $try = true;
122 $ls = '<span class="latex">';
123 $le = '</span>';
124 while ($try)
125 {
126 // search position of start tag
127 $pos1 = strpos($q, $ls);
128 if (is_int($pos1))
129 {
130 $pos2 = strpos($q, $le, $pos1);
131 if (is_int($pos2))
132 {
133 // both found: replace end tag
134 $q = substr($q, 0, $pos2)."[/tex]".substr($q, $pos2+7);
135 $q = substr($q, 0, $pos1)."[tex]".substr($q, $pos1+20);
136 }
137 else
138 {
139 $try = false;
140 }
141 }
142 else
143 {
144 $try = false;
145 }
146 }
147
148 $tags = assQuestionGUI::getSelfAssessmentTags();
149 $tstr = "";
150 foreach ($tags as $t)
151 {
152 $tstr.="<".$t.">";
153 }
154 $q = ilUtil::secureString($q, true, $tstr);
155 // self assessment uses nl2br, not p
156 $duplicate->setQuestion($q);
157
158 $duplicate->saveQuestionDataToDb();
159 */
160
161 require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssSelfAssessmentQuestionFormatter.php';
163
164 /* PATCH-END: moved cleanup code to central place ilAssSelfAssessmentQuestionFormatter */
165
166 $this->q_node->set_attribute("QRef", "il__qst_" . $duplicate_id);
167 }
168
173 public static function getLangVars()
174 {
175 return array("ed_insert_pcqst", "empty_question", "pc_qst");
176 }
177
186 public static function afterPageUpdate($a_page, DOMDocument $a_domdoc, $a_xml, $a_creation)
187 {
188 global $DIC;
189
190 $ilDB = $DIC->database();
191
192 include_once("./Services/Link/classes/class.ilInternalLink.php");
193
194 $ilDB->manipulateF(
195 "DELETE FROM page_question WHERE page_parent_type = %s " .
196 " AND page_id = %s AND page_lang = %s",
197 array("text", "integer", "text"),
198 array($a_page->getParentType(), $a_page->getId(), $a_page->getLanguage())
199 );
200
201 $xpath = new DOMXPath($a_domdoc);
202 $nodes = $xpath->query('//Question');
203 $q_ids = array();
204 foreach ($nodes as $node) {
205 $q_ref = $node->getAttribute("QRef");
206
207 $inst_id = ilInternalLink::_extractInstOfTarget($q_ref);
208 if (!($inst_id > 0)) {
210 if ($q_id > 0) {
211 $q_ids[$q_id] = $q_id;
212 }
213 }
214 }
215 foreach ($q_ids as $qid) {
216 $ilDB->manipulateF(
217 "INSERT INTO page_question (page_parent_type, page_id, page_lang, question_id)" .
218 " VALUES (%s,%s,%s,%s)",
219 array("text", "integer", "text", "integer"),
220 array($a_page->getParentType(), $a_page->getId(), $a_page->getLanguage(), $qid)
221 );
222 }
223 }
224
230 public static function beforePageDelete($a_page)
231 {
232 global $DIC;
233
234 $ilDB = $DIC->database();
235
236 $ilDB->manipulateF(
237 "DELETE FROM page_question WHERE page_parent_type = %s " .
238 " AND page_id = %s AND page_lang = %s",
239 array("text", "integer", "text"),
240 array($a_page->getParentType(), $a_page->getId(), $a_page->getLanguage())
241 );
242 }
243
247 public static function _getQuestionIdsForPage($a_parent_type, $a_page_id, $a_lang = "-")
248 {
249 global $DIC;
250
251 $ilDB = $DIC->database();
252
253 $res = $ilDB->queryF(
254 "SELECT * FROM page_question WHERE page_parent_type = %s " .
255 " AND page_id = %s AND page_lang = %s",
256 array("text", "integer", "text"),
257 array($a_parent_type, $a_page_id, $a_lang)
258 );
259 $q_ids = array();
260 while ($rec = $ilDB->fetchAssoc($res)) {
261 $q_ids[] = $rec["question_id"];
262 }
263
264 return $q_ids;
265 }
266
273 public static function _getPageForQuestionId($a_q_id, $a_parent_type = "")
274 {
275 global $DIC;
276
277 $ilDB = $DIC->database();
278
279 $set = $ilDB->query(
280 "SELECT * FROM page_question " .
281 " WHERE question_id = " . $ilDB->quote($a_q_id, "integer")
282 );
283 while ($rec = $ilDB->fetchAssoc($set)) {
284 if ($a_parent_type == "" || $rec["page_parent_type"] == $a_parent_type) {
285 return array("page_id" => $rec["page_id"], "parent_type" => $rec["page_parent_type"]);
286 }
287 }
288 return false;
289 }
290
294 public function modifyPageContentPostXsl($a_output, $a_mode, $a_abstract_only = false)
295 {
297
298 $qhtml = "";
299
300 if ($this->getPage()->getPageConfig()->getEnableSelfAssessment()) {
301 // #14154
302 $q_ids = $this->getPage()->getQuestionIds();
303 if (sizeof($q_ids)) {
304 include_once "./Modules/TestQuestionPool/classes/class.assQuestionGUI.php";
305 foreach ($q_ids as $q_id) {
306 $q_gui = assQuestionGUI::_getQuestionGUI("", $q_id);
307 // object check due to #16557
308 if (is_object($q_gui->object) && !$q_gui->object->isComplete()) {
309 $a_output = str_replace(
310 "{{{{{Question;il__qst_" . $q_id . "}}}}}",
311 "<i>" . $lng->txt("cont_empty_question") . "</i>",
312 $a_output
313 );
314 }
315 }
316
317 // this exports the questions which is needed below
318 $qhtml = $this->getQuestionJsOfPage(($a_mode == "edit") ? true : false, $a_mode);
319
320 require_once './Modules/Scorm2004/classes/class.ilQuestionExporter.php';
321 $a_output = "<script>" . ilQuestionExporter::questionsJS($q_ids) . "</script>" . $a_output;
322 if (!self::$initial_done) {
323 $a_output = "<script>var ScormApi=null; var questions = new Array();</script>" . $a_output;
324 self::$initial_done = true;
325 }
326 }
327 } else {
328 // set by T&A components
329 $qhtml = $this->getPage()->getPageConfig()->getQuestionHTML();
330
331 // address #19788
332 if (!is_array($qhtml) || count($qhtml) == 0) {
333 // #14154
334 $q_ids = $this->getPage()->getQuestionIds();
335 if (sizeof($q_ids)) {
336 foreach ($q_ids as $k) {
337 $a_output = str_replace("{{{{{Question;il__qst_$k" . "}}}}}", " " . $lng->txt("copg_questions_not_supported_here"), $a_output);
338 }
339 }
340 }
341 }
342
343 if (is_array($qhtml)) {
344 foreach ($qhtml as $k => $h) {
345 $a_output = str_replace("{{{{{Question;il__qst_$k" . "}}}}}", " " . $h, $a_output);
346 }
347 }
348
349 return $a_output;
350 }
351
355 public static function resetInitialState()
356 {
357 self::$initial_done = false;
358 }
359
363 public function getJavascriptFiles($a_mode)
364 {
365 $js_files = array();
366
367 if ($this->getPage()->getPageConfig()->getEnableSelfAssessment()) {
368 $js_files[] = "./Modules/Scorm2004/scripts/questions/pure.js";
369 $js_files[] = "./Modules/Scorm2004/scripts/questions/question_handling.js";
370 $js_files[] = 'Modules/TestQuestionPool/js/ilAssMultipleChoice.js';
371 $js_files[] = "Modules/TestQuestionPool/js/ilMatchingQuestion.js";
372
373 foreach ($this->getPage()->getQuestionIds() as $qId) {
374 $qstGui = assQuestionGUI::_getQuestionGUI('', $qId);
375 $js_files = array_merge($js_files, $qstGui->getPresentationJavascripts());
376 }
377 }
378
379 if (!$this->getPage()->getPageConfig()->getEnableSelfAssessmentScorm() && $a_mode != ilPageObjectGUI::PREVIEW
380 && $a_mode != "offline") {
381 $js_files[] = "./Services/COPage/js/ilCOPageQuestionHandler.js";
382 }
383
384 return $js_files;
385 }
386
390 public function getCssFiles($a_mode)
391 {
392 if ($this->getPage()->getPageConfig()->getEnableSelfAssessment()) {
393 return array("./Modules/Scorm2004/templates/default/question_handling.css",
394 "Modules/TestQuestionPool/templates/default/test_javascript.css",
395 'Modules/Test/templates/default/ta.css');
396 }
397 return array();
398 }
399
403 public function getOnloadCode($a_mode)
404 {
407
408 $code = array();
409
410 if ($this->getPage()->getPageConfig()->getEnableSelfAssessment()) {
411 if (!$this->getPage()->getPageConfig()->getEnableSelfAssessmentScorm() && $a_mode != ilPageObjectGUI::PREVIEW
412 && $a_mode != "offline") {
413 $ilCtrl->setParameterByClass(strtolower(get_class($this->getPage())) . "gui", "page_id", $this->getPage()->getId());
414 $url = $ilCtrl->getLinkTargetByClass(strtolower(get_class($this->getPage())) . "gui", "processAnswer", "", true, false);
415 $code[] = "ilCOPageQuestionHandler.initCallback('" . $url . "');";
416 }
417
418 if ($this->getPage()->getPageConfig()->getDisableDefaultQuestionFeedback()) {
419 $code[] = "ilias.questions.default_feedback = false;";
420 }
421
422 $code[] = self::getJSTextInitCode($this->getPage()->getPageConfig()->getLocalizationLanguage()) . ' il.COPagePres.updateQuestionOverviews();';
423 }
424
425 $get_stored_tries = $this->getPage()->getPageConfig()->getUseStoredQuestionTries();
426 if ($get_stored_tries) {
427 $q_ids = $this->getPage()->getQuestionIds();
428 if (count($q_ids) > 0) {
429 foreach ($q_ids as $q_id) {
430 include_once("./Services/COPage/classes/class.ilPageQuestionProcessor.php");
432 $code[] = "ilias.questions.initAnswer(" . $q_id . ", " . (int) $as["try"] . ", " . ($as["passed"] ? "true" : "null") . ");";
433 }
434 }
435 }
436 return $code;
437 }
438
445 public static function getJSTextInitCode($a_lang)
446 {
447 global $DIC;
448
449 $lng = $DIC->language();
450 $ilUser = $DIC->user();
451
452 if ($a_lang == "") {
453 $a_lang = $ilUser->getLanguage();
454 }
455
456 return
457 '
458 ilias.questions.txt.wrong_answers = "' . $lng->txtlng("content", "cont_wrong_answers", $a_lang) . '";
459 ilias.questions.txt.wrong_answers_single = "' . $lng->txtlng("content", "cont_wrong_answers_single", $a_lang) . '";
460 ilias.questions.txt.tries_remaining = "' . $lng->txtlng("content", "cont_tries_remaining", $a_lang) . '";
461 ilias.questions.txt.please_try_again = "' . $lng->txtlng("content", "cont_please_try_again", $a_lang) . '";
462 ilias.questions.txt.all_answers_correct = "' . $lng->txtlng("content", "cont_all_answers_correct", $a_lang) . '";
463 ilias.questions.txt.enough_answers_correct = "' . $lng->txtlng("content", "cont_enough_answers_correct", $a_lang) . '";
464 ilias.questions.txt.nr_of_tries_exceeded = "' . $lng->txtlng("content", "cont_nr_of_tries_exceeded", $a_lang) . '";
465 ilias.questions.txt.correct_answers_separator = "' . $lng->txtlng("assessment", "or", $a_lang) . '";
466 ilias.questions.txt.correct_answers_shown = "' . $lng->txtlng("content", "cont_correct_answers_shown", $a_lang) . '";
467 ilias.questions.txt.correct_answers_also = "' . $lng->txtlng("content", "cont_correct_answers_also", $a_lang) . '";
468 ilias.questions.txt.correct_answer_also = "' . $lng->txtlng("content", "cont_correct_answer_also", $a_lang) . '";
469 ilias.questions.txt.ov_all_correct = "' . $lng->txtlng("content", "cont_ov_all_correct", $a_lang) . '";
470 ilias.questions.txt.ov_some_correct = "' . $lng->txtlng("content", "cont_ov_some_correct", $a_lang) . '";
471 ilias.questions.txt.ov_wrong_answered = "' . $lng->txtlng("content", "cont_ov_wrong_answered", $a_lang) . '";
472 ilias.questions.txt.please_select = "' . $lng->txtlng("content", "cont_please_select", $a_lang) . '";
473 ilias.questions.txt.ov_preview = "' . $lng->txtlng("content", "cont_ov_preview", $a_lang) . '";
474 ilias.questions.txt.submit_answers = "' . $lng->txtlng("content", "cont_submit_answers", $a_lang) . '";
475 ilias.questions.refresh_lang();
476 ';
477 }
478
482 public function getQuestionJsOfPage($a_no_interaction, $a_mode)
483 {
484 require_once './Modules/Scorm2004/classes/class.ilQuestionExporter.php';
485 $q_ids = $this->getPage()->getQuestionIds();
486 $js = array();
487 if (count($q_ids) > 0) {
488 foreach ($q_ids as $q_id) {
489 $q_exporter = new ilQuestionExporter($a_no_interaction);
490 $image_path = null;
491 if ($a_mode == "offline") {
492 if ($this->getPage()->getParentType() == "sahs") {
493 $image_path = "./objects/";
494 }
495 if ($this->getPage()->getParentType() == "lm") {
496 $image_path = "./assessment/0/" . $q_id . "/images/";
497 }
498 }
499
500 $js[$q_id] = $q_exporter->exportQuestion($q_id, $image_path, $a_mode);
501 }
502 }
503 return $js;
504 }
505}
user()
Definition: user.php:4
An exception for terminatinating execution or to throw for unit testing.
const IL_INSERT_AFTER
static _getQuestionGUI($question_type, $question_id=-1)
Creates a question gui representation and returns the alias to the question gui note: please do not u...
static _instanciateQuestion($question_id)
Creates an instance of a question with a given question id.
Class ilPCQuestion.
static _getPageForQuestionId($a_q_id, $a_parent_type="")
Get page for question id.
getQuestionJsOfPage($a_no_interaction, $a_mode)
Get question js.
setNode($a_node)
Set node.
static beforePageDelete($a_page)
Before page is being deleted.
getOnloadCode($a_mode)
Get on load code.
init()
Init page content component.
getCssFiles($a_mode)
Get css files.
getJavascriptFiles($a_mode)
Get Javascript files.
static getJSTextInitCode($a_lang)
Get js txt init code.
static resetInitialState()
Reset initial state (for exports)
static getLangVars()
Get lang vars needed for editing.
getQuestionReference()
Get Question Reference.
copyPoolQuestionIntoPage($a_q_id, $a_hier_id)
Copy question from pool into page.
modifyPageContentPostXsl($a_output, $a_mode, $a_abstract_only=false)
@inheritDoc
setQuestionReference($a_questionreference)
Set Question Reference.
static _getQuestionIdsForPage($a_parent_type, $a_page_id, $a_lang="-")
Get all questions of a page.
create(&$a_pg_obj, $a_hier_id)
Create Question Element.
static afterPageUpdate($a_page, DOMDocument $a_domdoc, $a_xml, $a_creation)
After page has been updated (or created)
Class ilPageContent.
createPageContentNode($a_set_this_node=true)
Create page content node (always use this method first when adding a new element)
setType($a_type)
Set Type.
static getAnswerStatus($a_q_id, $a_user_id=0)
Get statistics for question.
Scorm 2004 Question Exporter.
static questionsJS(array $a_qids=null)
global $ilCtrl
Definition: ilias.php:18
$url
foreach($_POST as $key=> $value) $res
global $ilDB
$ilUser
Definition: imgupload.php:18
$DIC
Definition: xapitoken.php:46