ILIAS  Release_4_4_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
class.assTextQuestion.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */
3 
4 require_once './Modules/TestQuestionPool/classes/class.assQuestion.php';
5 require_once './Modules/Test/classes/inc.AssessmentConstants.php';
6 require_once './Modules/TestQuestionPool/interfaces/interface.ilObjQuestionScoringAdjustable.php';
7 require_once './Modules/TestQuestionPool/interfaces/interface.ilObjAnswerScoringAdjustable.php';
8 
22 class assTextQuestion extends assQuestion //implements ilObjQuestionScoringAdjustable, ilObjAnswerScoringAdjustable
23 {
32 
41  var $keywords;
42 
43  var $answers;
44 
51 
52  /* method for automatic string matching */
53  private $matchcondition;
54 
56 
69  public function __construct(
70  $title = "",
71  $comment = "",
72  $author = "",
73  $owner = -1,
74  $question = ""
75  )
76  {
78  $this->maxNumOfChars = 0;
79  $this->points = 1;
80  $this->answers = array();
81  $this->matchcondition = 0;
82  }
83 
89  public function isComplete()
90  {
91  if (strlen($this->title)
92  && $this->author
93  && $this->question
94  && $this->getMaximumPoints() > 0
95  )
96  {
97  return true;
98  }
99  return false;
100  }
101 
107  public function saveToDb($original_id = "")
108  {
110  $this->saveAdditionalQuestionDataToDb();
111  $this->saveAnswerSpecificDataToDb();
113  }
114 
122  function loadFromDb($question_id)
123  {
124  global $ilDB;
125 
126  $result = $ilDB->queryF("SELECT qpl_questions.*, " . $this->getAdditionalTableName() . ".* FROM qpl_questions LEFT JOIN " . $this->getAdditionalTableName() . " ON " . $this->getAdditionalTableName() . ".question_fi = qpl_questions.question_id WHERE qpl_questions.question_id = %s",
127  array("integer"),
128  array($question_id)
129  );
130  if ($ilDB->numRows($result) == 1)
131  {
132  $data = $ilDB->fetchAssoc($result);
133  $this->setId($question_id);
134  $this->setObjId($data["obj_fi"]);
135  $this->setTitle($data["title"]);
136  $this->setComment($data["description"]);
137  $this->setOriginalId($data["original_id"]);
138  $this->setNrOfTries($data['nr_of_tries']);
139  $this->setAuthor($data["author"]);
140  $this->setPoints((float) $data["points"]);
141  $this->setOwner($data["owner"]);
142  include_once("./Services/RTE/classes/class.ilRTE.php");
143  $this->setQuestion(ilRTE::_replaceMediaObjectImageSrc($data["question_text"], 1));
144  $this->setShuffle($data["shuffle"]);
145  $this->setMaxNumOfChars($data["maxnumofchars"]);
146  $this->setTextRating($this->isValidTextRating($data["textgap_rating"]) ? $data["textgap_rating"] : TEXTGAP_RATING_CASEINSENSITIVE);
147  $this->matchcondition = (strlen($data['matchcondition'])) ? $data['matchcondition'] : 0;
148  $this->setEstimatedWorkingTime(substr($data["working_time"], 0, 2), substr($data["working_time"], 3, 2), substr($data["working_time"], 6, 2));
149  $this->setKeywordRelation(($data['keyword_relation']));
150 
151  try
152  {
153  $this->setAdditionalContentEditingMode($data['add_cont_edit_mode']);
154  }
156  {
157  }
158  }
159 
160  $result = $ilDB->queryF("SELECT * FROM qpl_a_essay WHERE question_fi = %s",
161  array("integer"),
162  array($this->getId())
163  );
164 
165  $this->flushAnswers();
166  while ($row = $ilDB->fetchAssoc($result))
167  {
168  $this->addAnswer($row['answertext'], $row['points']);
169  }
170 
171  parent::loadFromDb($question_id);
172  }
173 
179  function duplicate($for_test = true, $title = "", $author = "", $owner = "", $testObjId = null)
180  {
181  if ($this->id <= 0)
182  {
183  // The question has not been saved. It cannot be duplicated
184  return;
185  }
186  // duplicate the question in database
187  $this_id = $this->getId();
188  $thisObjId = $this->getObjId();
189 
190  $clone = $this;
191  include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
193  $clone->id = -1;
194 
195  if( (int)$testObjId > 0 )
196  {
197  $clone->setObjId($testObjId);
198  }
199 
200  if ($title)
201  {
202  $clone->setTitle($title);
203  }
204 
205  if ($author)
206  {
207  $clone->setAuthor($author);
208  }
209  if ($owner)
210  {
211  $clone->setOwner($owner);
212  }
213 
214  if ($for_test)
215  {
216  $clone->saveToDb($original_id);
217  }
218  else
219  {
220  $clone->saveToDb();
221  }
222 
223  // copy question page content
224  $clone->copyPageOfQuestion($this_id);
225  // copy XHTML media objects
226  $clone->copyXHTMLMediaObjectsOfQuestion($this_id);
227  #$clone->duplicateAnswers($this_id);
228 
229  $clone->onDuplicate($thisObjId, $this_id, $clone->getObjId(), $clone->getId());
230 
231  return $clone->id;
232  }
233 
239  function copyObject($target_questionpool_id, $title = "")
240  {
241  if ($this->id <= 0)
242  {
243  // The question has not been saved. It cannot be duplicated
244  return;
245  }
246  // duplicate the question in database
247  $clone = $this;
248  include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
250  $clone->id = -1;
251  $source_questionpool_id = $this->getObjId();
252  $clone->setObjId($target_questionpool_id);
253  if ($title)
254  {
255  $clone->setTitle($title);
256  }
257  $clone->saveToDb();
258  // copy question page content
259  $clone->copyPageOfQuestion($original_id);
260  // copy XHTML media objects
261  $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
262  // duplicate answers
263  #$clone->duplicateAnswers($original_id);
264 
265  $clone->onCopy($source_questionpool_id, $original_id, $clone->getObjId(), $clone->getId());
266 
267  return $clone->id;
268  }
269 
270  public function createNewOriginalFromThisDuplicate($targetParentId, $targetQuestionTitle = "")
271  {
272  if ($this->id <= 0)
273  {
274  // The question has not been saved. It cannot be duplicated
275  return;
276  }
277 
278  include_once ("./Modules/TestQuestionPool/classes/class.assQuestion.php");
279 
280  $sourceQuestionId = $this->id;
281  $sourceParentId = $this->getObjId();
282 
283  // duplicate the question in database
284  $clone = $this;
285  $clone->id = -1;
286 
287  $clone->setObjId($targetParentId);
288 
289  if ($targetQuestionTitle)
290  {
291  $clone->setTitle($targetQuestionTitle);
292  }
293 
294  $clone->saveToDb();
295  // copy question page content
296  $clone->copyPageOfQuestion($sourceQuestionId);
297  // copy XHTML media objects
298  $clone->copyXHTMLMediaObjectsOfQuestion($sourceQuestionId);
299  // duplicate answers
300  #$clone->duplicateAnswers($sourceQuestionId);
301 
302  $clone->onCopy($sourceParentId, $sourceQuestionId, $clone->getObjId(), $clone->getId());
303 
304  return $clone->id;
305  }
306 
314  function getMaxNumOfChars()
315  {
316  if (strcmp($this->maxNumOfChars, "") == 0)
317  {
318  return 0;
319  }
320  else
321  {
322  return $this->maxNumOfChars;
323  }
324  }
325 
333  function setMaxNumOfChars($maxchars = 0)
334  {
335  $this->maxNumOfChars = $maxchars;
336  }
337 
344  function getMaximumPoints()
345  {
346  if( in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion()) )
347  {
348  return parent::getPoints();
349  }
350 
351  $points = 0;
352 
353  foreach ($this->answers as $answer)
354  {
355  if ($answer->getPoints() > 0)
356  {
357  $points = $points + $answer->getPoints();
358  }
359  }
360 
361  return $points;
362  }
363 
364  function getMinimumPoints()
365  {
366  if( in_array($this->getKeywordRelation(), self::getScoringModesWithPointsByQuestion()) )
367  {
368  return 0;
369  }
370 
371  $points = 0;
372 
373  foreach ($this->answers as $answer)
374  {
375  if ($answer->getPoints() < 0)
376  {
377  $points = $points + $answer->getPoints();
378  }
379  }
380 
381  return $points;
382  }
392  function setReachedPoints($active_id, $points, $pass = NULL)
393  {
394  global $ilDB;
395 
396  if (($points > 0) && ($points <= $this->getPoints()))
397  {
398  if (is_null($pass))
399  {
400  $pass = $this->getSolutionMaxPass($active_id);
401  }
402  $affectedRows = $ilDB->manipulateF("UPDATE tst_test_result SET points = %s WHERE active_fi = %s AND question_fi = %s AND pass = %s",
403  array('float','integer','integer','integer'),
404  array($points, $active_id, $this->getId(), $pass)
405  );
406  $this->_updateTestPassResults($active_id, $pass);
407  return TRUE;
408  }
409  else
410  {
411  return TRUE;
412  }
413  }
414 
415  private function isValidTextRating($textRating)
416  {
417  switch($textRating)
418  {
426  return true;
427  }
428 
429  return false;
430  }
431 
440  function isKeywordMatching($answertext, $a_keyword)
441  {
442  $result = FALSE;
443  $textrating = $this->getTextRating();
444  include_once "./Services/Utilities/classes/class.ilStr.php";
445  switch ($textrating)
446  {
448  if (ilStr::strPos(ilStr::strToLower($answertext), ilStr::strToLower($a_keyword)) !== false) return TRUE;
449  break;
451  if (ilStr::strPos($answertext, $a_keyword) !== false) return TRUE;
452  break;
453  }
454 
455  // "<p>red</p>" would not match "red" even with distance of 5
456  $answertext = strip_tags($answertext);
457 
458  $answerwords = array();
459  if (preg_match_all("/([^\s.]+)/", $answertext, $matches))
460  {
461  foreach ($matches[1] as $answerword)
462  {
463  array_push($answerwords, trim($answerword));
464  }
465  }
466  foreach ($answerwords as $a_original)
467  {
468  switch ($textrating)
469  {
471  if (levenshtein($a_original, $a_keyword) <= 1) return TRUE;
472  break;
474  if (levenshtein($a_original, $a_keyword) <= 2) return TRUE;
475  break;
477  if (levenshtein($a_original, $a_keyword) <= 3) return TRUE;
478  break;
480  if (levenshtein($a_original, $a_keyword) <= 4) return TRUE;
481  break;
483  if (levenshtein($a_original, $a_keyword) <= 5) return TRUE;
484  break;
485  }
486  }
487  return $result;
488  }
489 
500  public function calculateReachedPoints($active_id, $pass = NULL, $returndetails = FALSE)
501  {
502  if( $returndetails )
503  {
504  throw new ilTestException('return details not implemented for '.__METHOD__);
505  }
506 
507  global $ilDB;
508 
509  $points = 0;
510  if (is_null($pass))
511  {
512  $pass = $this->getSolutionMaxPass($active_id);
513  }
514 
515  $result = $ilDB->queryF("SELECT * FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
516  array('integer','integer','integer'),
517  array($active_id, $this->getId(), $pass)
518  );
519 
520  // Return min points when no answer was given.
521  if ($ilDB->numRows($result) == 0)
522  {
523  return $this->getMinimumPoints();
524  }
525 
526  // Return points of points are already on the row.
527  $row = $ilDB->fetchAssoc($result);
528  if ($row["points"] != NULL)
529  {
530  return $row["points"];
531  }
532 
533  // Return min points when keyword relation is NON KEYWORDS
534  if( $this->getKeywordRelation() == 'non' )
535  {
536  return $this->getMinimumPoints();
537  }
538 
539  // Return min points if there are no answers present.
540  $answers = $this->getAnswers();
541 
542  if (count($answers) == 0)
543  {
544  return $this->getMinimumPoints();
545  }
546 
547  switch( $this->getKeywordRelation() )
548  {
549  case 'any':
550 
551  $points = 0;
552 
553  foreach ($answers as $answer)
554  {
555  $qst_answer = $answer->getAnswertext();
556  $user_answer = ' '.$row['value1'];
557 
558  if( $this->isKeywordMatching( $user_answer, $qst_answer ) )
559  {
560  $points += $answer->getPoints();
561  }
562  }
563 
564  break;
565 
566  case 'all':
567 
568  $points = $this->getMaximumPoints();
569 
570  foreach ($answers as $answer)
571  {
572  $qst_answer = $answer->getAnswertext();
573  $user_answer = ' '.$row['value1'];
574 
575  if( !$this->isKeywordMatching( $user_answer, $qst_answer ) )
576  {
577  $points = 0;
578  break;
579  }
580  }
581 
582  break;
583 
584  case 'one':
585 
586  $points = 0;
587 
588  foreach ($answers as $answer)
589  {
590  $qst_answer = $answer->getAnswertext();
591  $user_answer = ' '.$row['value1'];
592 
593  if( $this->isKeywordMatching( $user_answer, $qst_answer ) )
594  {
595  $points = $this->getMaximumPoints();
596  break;
597  }
598  }
599 
600  break;
601  }
602 
603  return $points;
604 
605  }
606 
615  public function saveWorkingData($active_id, $pass = NULL)
616  {
617  global $ilDB;
618  global $ilUser;
619 
620  include_once "./Services/Utilities/classes/class.ilStr.php";
621  if (is_null($pass))
622  {
623  include_once "./Modules/Test/classes/class.ilObjTest.php";
624  $pass = ilObjTest::_getPass($active_id);
625  }
626 
627  $this->getProcessLocker()->requestUserSolutionUpdateLock();
628 
629  $affectedRows = $ilDB->manipulateF("DELETE FROM tst_solutions WHERE active_fi = %s AND question_fi = %s AND pass = %s",
630  array('integer','integer','integer'),
631  array($active_id, $this->getId(), $pass)
632  );
633  $text = ilUtil::stripSlashes($_POST["TEXT"], FALSE);
634  if ($this->getMaxNumOfChars())
635  {
636  include_once "./Services/Utilities/classes/class.ilStr.php";
637  $text_without_tags = preg_replace("/<[^>*?]>/is", "", $text);
638  $len_with_tags = ilStr::strLen($text);
639  $len_without_tags = ilStr::strLen($text_without_tags);
640  if ($this->getMaxNumOfChars() < $len_without_tags)
641  {
642  if (!$this->isHTML($text))
643  {
644  $text = ilStr::subStr($text, 0, $this->getMaxNumOfChars());
645  }
646  }
647  }
648  if ($this->isHTML($text))
649  {
650  $text = preg_replace("/<[^>]*$/ims", "", $text);
651  }
652  else
653  {
654  //$text = htmlentities($text, ENT_QUOTES, "UTF-8");
655  }
656  $entered_values = 0;
657  if (strlen($text))
658  {
659  $next_id = $ilDB->nextId('tst_solutions');
660  $affectedRows = $ilDB->insert("tst_solutions", array(
661  "solution_id" => array("integer", $next_id),
662  "active_fi" => array("integer", $active_id),
663  "question_fi" => array("integer", $this->getId()),
664  "value1" => array("clob", trim($text)),
665  "value2" => array("clob", null),
666  "pass" => array("integer", $pass),
667  "tstamp" => array("integer", time())
668  ));
669  $entered_values++;
670  }
671 
672  $this->getProcessLocker()->releaseUserSolutionUpdateLock();
673 
674  if ($entered_values)
675  {
676  include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
678  {
679  $this->logAction($this->lng->txtlng("assessment", "log_user_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
680  }
681  }
682  else
683  {
684  include_once ("./Modules/Test/classes/class.ilObjAssessmentFolder.php");
686  {
687  $this->logAction($this->lng->txtlng("assessment", "log_user_not_entered_values", ilObjAssessmentFolder::_getLogLanguage()), $active_id, $this->getId());
688  }
689  }
690 
691  return true;
692  }
693 
694  public function saveAdditionalQuestionDataToDb()
695  {
697  global $ilDB;
698  $ilDB->manipulateF( "DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
699  array( "integer" ),
700  array( $this->getId()
701  )
702  );
703 
704  $ilDB->manipulateF( "INSERT INTO " . $this->getAdditionalTableName() . " (question_fi, maxnumofchars, keywords,
705  textgap_rating, matchcondition, keyword_relation) VALUES (%s, %s, %s, %s, %s, %s)",
706  array( "integer", "integer", "text", "text", 'integer', 'text' ),
707  array(
708  $this->getId(),
709  $this->getMaxNumOfChars(),
710  NULL,
711  $this->getTextRating(),
712  $this->matchcondition,
713  $this->getKeywordRelation()
714  )
715  );
716  }
717 
718  public function saveAnswerSpecificDataToDb()
719  {
721  global $ilDB;
722 
723  $ilDB->manipulateF( "DELETE FROM qpl_a_essay WHERE question_fi = %s",
724  array( "integer" ),
725  array( $this->getId() )
726  );
727 
728  foreach ($this->answers as $answer)
729  {
731  $nextID = $ilDB->nextId( 'qpl_a_essay' );
732  $ilDB->manipulateF( "INSERT INTO qpl_a_essay (answer_id, question_fi, answertext, points) VALUES (%s, %s, %s, %s)",
733  array( "integer", "integer", "text", 'float' ),
734  array(
735  $nextID,
736  $this->getId(),
737  $answer->getAnswertext(),
738  $answer->getPoints()
739  )
740  );
741  }
742  }
743 
752  protected function reworkWorkingData($active_id, $pass, $obligationsAnswered)
753  {
754  // nothing to rework!
755  }
756 
757  function createRandomSolution($test_id, $user_id)
758  {
759  }
760 
767  function getQuestionType()
768  {
769  return "assTextQuestion";
770  }
771 
779  function getTextRating()
780  {
781  return $this->text_rating;
782  }
783 
791  function setTextRating($a_text_rating)
792  {
793  switch ($a_text_rating)
794  {
802  $this->text_rating = $a_text_rating;
803  break;
804  default:
805  $this->text_rating = TEXTGAP_RATING_CASEINSENSITIVE;
806  break;
807  }
808  }
809 
817  {
818  return "qpl_qst_essay";
819  }
820 
826  {
828  }
829 
842  public function setExportDetailsXLS(&$worksheet, $startrow, $active_id, $pass, &$format_title, &$format_bold)
843  {
844  include_once ("./Services/Excel/classes/class.ilExcelUtils.php");
845  $solutions = $this->getSolutionValues($active_id, $pass);
846  $worksheet->writeString($startrow, 0, ilExcelUtils::_convert_text($this->lng->txt($this->getQuestionType())), $format_title);
847  $worksheet->writeString($startrow, 1, ilExcelUtils::_convert_text($this->getTitle()), $format_title);
848  $i = 1;
849  $worksheet->writeString($startrow + $i, 0, ilExcelUtils::_convert_text($this->lng->txt("result")), $format_bold);
850  if (strlen($solutions[0]["value1"]))
851  {
852  $worksheet->write($startrow + $i, 1, ilExcelUtils::_convert_text($solutions[0]["value1"]));
853  }
854  $i++;
855  return $startrow + $i + 1;
856  }
857 
861  public function toJSON()
862  {
863  include_once("./Services/RTE/classes/class.ilRTE.php");
864  $result = array();
865  $result['id'] = (int) $this->getId();
866  $result['type'] = (string) $this->getQuestionType();
867  $result['title'] = (string) $this->getTitle();
868  $result['question'] = $this->formatSAQuestion($this->getQuestion());
869  $result['nr_of_tries'] = (int) $this->getNrOfTries();
870  $result['shuffle'] = (bool) $this->getShuffle();
871  $result['maxlength'] = (int) $this->getMaxNumOfChars();
872  return json_encode($result);
873  }
874 
875  public function getAnswerCount()
876  {
877  return count($this->answers);
878  }
879 
893  public function addAnswer(
894  $answertext = "",
895  $points = 0.0,
896  $points_unchecked = 0.0,
897  $order = 0,
898  $answerimage = ""
899  )
900  {
901  include_once "./Modules/TestQuestionPool/classes/class.assAnswerMultipleResponseImage.php";
902 
903  // add answer
904  $answer = new ASS_AnswerMultipleResponseImage($answertext, $points);
905  $this->answers[] = $answer;
906  }
907 
908  public function getAnswers()
909  {
910  return $this->answers;
911  }
912 
922  function getAnswer($index = 0)
923  {
924  if ($index < 0) return NULL;
925  if (count($this->answers) < 1) return NULL;
926  if ($index >= count($this->answers)) return NULL;
927 
928  return $this->answers[$index];
929  }
930 
939  function deleteAnswer($index = 0)
940  {
941  if ($index < 0) return;
942  if (count($this->answers) < 1) return;
943  if ($index >= count($this->answers)) return;
944  $answer = $this->answers[$index];
945  if (strlen($answer->getImage())) $this->deleteImage($answer->getImage());
946  unset($this->answers[$index]);
947  $this->answers = array_values($this->answers);
948  for ($i = 0; $i < count($this->answers); $i++)
949  {
950  if ($this->answers[$i]->getOrder() > $index)
951  {
952  $this->answers[$i]->setOrder($i);
953  }
954  }
955  }
956 
958  {
959  return 'qpl_a_essay';
960  }
961 
968  function flushAnswers()
969  {
970  $this->answers = array();
971  }
972 
973  public function setAnswers($answers)
974  {
975  if( isset($answers['answer']) )
976  {
977  $count = count($answers['answer']);
978  $withPoints = true;
979  }
980  else
981  {
982  $count = count($answers);
983  $withPoints = false;
984  }
985 
986  $this->flushAnswers();
987 
988  for( $i = 0; $i < $count; $i++ )
989  {
990  if($withPoints)
991  {
992  $this->addAnswer($answers['answer'][$i], $answers['points'][$i]);
993  }
994  else
995  {
996  $this->addAnswer($answers[$i], 0);
997  }
998  }
999  }
1000 
1002  {
1003  global $ilDB;
1004 
1005  $result = $ilDB->queryF("SELECT * FROM qpl_a_essay WHERE question_fi = %s",
1006  array('integer'),
1007  array($original_id)
1008  );
1009  if ($result->numRows())
1010  {
1011  while ($row = $ilDB->fetchAssoc($result))
1012  {
1013  $next_id = $ilDB->nextId('qpl_a_essay');
1014  $affectedRows = $ilDB->manipulateF(
1015  "INSERT INTO qpl_a_essay (answer_id, question_fi, answertext, points)
1016  VALUES (%s, %s, %s, %s)",
1017  array('integer','integer','text','integer'),
1018  array($next_id, $this->getId(), $row["answertext"], $row["points"])
1019  );
1020  }
1021  }
1022  }
1023 
1024  public function getKeywordRelation()
1025  {
1026  return $this->keyword_relation;
1027  }
1028 
1033  public function setKeywordRelation($a_relation)
1034  {
1035  $this->keyword_relation = $a_relation;
1036  }
1037 
1038  public static function getValidScoringModes()
1039  {
1040  return array_merge(self::getScoringModesWithPointsByQuestion(), self::getScoringModesWithPointsByKeyword());
1041  }
1042 
1043  public static function getScoringModesWithPointsByQuestion()
1044  {
1045  return array('non', 'all', 'one');
1046  }
1047 
1048  public static function getScoringModesWithPointsByKeyword()
1049  {
1050  return array('any');
1051  }
1052 
1053 
1064  public function isAnswered($active_id, $pass)
1065  {
1066  $answered = assQuestion::doesSolutionRecordsExist($active_id, $pass, $this->getId());
1067 
1068  return $answered;
1069  }
1070 
1081  public static function isObligationPossible($questionId)
1082  {
1083  return true;
1084  }
1085 }