ILIAS  release_10 Revision v10.1-43-ga1241a92c2f
Public Member Functions | Data Fields | Protected Member Functions
assOrderingQuestionImport Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

+ Inheritance diagram for assOrderingQuestionImport:
+ Collaboration diagram for assOrderingQuestionImport:

Public Member Functions

 fromXML (string $importdirectory, int $user_id, ilQTIItem $item, int $questionpool_id, ?int $tst_id, ?ilObject &$tst_object, int &$question_counter, array $import_mapping)
 
- Public Member Functions inherited from assQuestionImport
 getQuestionId ()
 
 getFeedbackGeneric ($item)
 
 fromXML (string $importdirectory, int $user_id, ilQTIItem $item, int $questionpool_id, ?int $tst_id, ?ilObject &$tst_object, int &$question_counter, array $import_mapping)
 
 importSuggestedSolutions (int $question_id, array $solution_from_import)
 
 QTIMaterialToString (ilQTIMaterial $a_material)
 Reads an QTI material tag and creates a text or XHTML string. More...
 

Data Fields

 $object
 
- Data Fields inherited from assQuestionImport
 $object
 

Protected Member Functions

 handleUploadedFile (array $answer)
 
 ensureImagePathExists ()
 
- Protected Member Functions inherited from assQuestionImport
 fetchIndexFromFeedbackIdent ($feedbackIdent, $prefix='response_')
 
 getFeedbackAnswerSpecific (ilQTIItem $item, $prefix='response_')
 
 addGeneralMetadata (ilQTIItem $item)
 
 fetchLifecycle (ilQTIItem $item)
 
 processNonAbstractedImageReferences ($text, $sourceNic)
 
 fetchAdditionalContentEditingModeInformation ($qtiItem)
 fetches the "additional content editing mode" information from qti item and falls back to ADDITIONAL_CONTENT_EDITING_MODE_RTE when no or invalid information is given More...
 
 findSolutionTypeByValue (string $value)
 
 getSuggestedSolutionsRepo ()
 
 deduceThumbSizeFromImportValue (?int $size)
 
 addQuestionToParentObjectAndBuildMappingEntry (int $questionpool_id, ?int $tst_id, int &$question_counter, ?ilObjTest &$tst_object)
 

Additional Inherited Members

- Protected Attributes inherited from assQuestionImport
SuggestedSolutionsDatabaseRepository $suggestedsolution_repo = null
 

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class for ordering question imports

assOrderingQuestionImport is a class for ordering question imports

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
Version
$Id$ \

Definition at line 28 of file class.assOrderingQuestionImport.php.

Member Function Documentation

◆ ensureImagePathExists()

assOrderingQuestionImport::ensureImagePathExists ( )
protected

Definition at line 337 of file class.assOrderingQuestionImport.php.

References ilFileUtils\makeDirParents(), and ILIAS\Repository\object().

Referenced by handleUploadedFile().

338  {
339  if (!file_exists($this->object->getImagePath())) {
340  ilFileUtils::makeDirParents($this->object->getImagePath());
341  }
342  }
ilFileUtils\makeDirParents
static makeDirParents(string $a_dir)
Create a new directory and all parent directories.
Definition: class.ilFileUtils.php:188
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fromXML()

assOrderingQuestionImport::fromXML ( string  $importdirectory,
int  $user_id,
ilQTIItem  $item,
int  $questionpool_id,
?int  $tst_id,
?ilObject &  $tst_object,
int &  $question_counter,
array  $import_mapping 
)

Definition at line 35 of file class.assOrderingQuestionImport.php.

References $DIC, $filename, $response, ilRTE\_replaceMediaObjectImageSrc(), ilObjMediaObject\_saveTempFileAsMediaObject(), ilObjMediaObject\_saveUsage(), assQuestionImport\addGeneralMetadata(), assQuestionImport\addQuestionToParentObjectAndBuildMappingEntry(), ilSession\clear(), assQuestionImport\deduceThumbSizeFromImportValue(), assQuestionImport\fetchAdditionalContentEditingModeInformation(), assQuestionImport\fetchIndexFromFeedbackIdent(), ilSession\get(), ilQTIItem\getAuthor(), ilQTIItem\getComment(), assQuestionImport\getFeedbackAnswerSpecific(), ilQTIItem\getIdent(), ILIAS\Test\Questions\Presentation\getLabel, ilQTIItem\getMaxattempts(), ilQTIItem\getMetadataEntry(), ilQTIItem\getPresentation(), ilQTIItem\getQuestiontext(), ilQTIItem\getTitle(), IL_INST_ID, assQuestionImport\importSuggestedSolutions(), ILIAS\Repository\int(), ILIAS\Repository\object(), assOrderingQuestion\OQ_NESTED_PICTURES, assOrderingQuestion\OQ_NESTED_TERMS, assOrderingQuestion\OQ_PICTURES, assOrderingQuestion\OQ_TERMS, and assQuestionImport\QTIMaterialToString().

44  : array {
45  // empty session variable for imported xhtml mobs
46  ilSession::clear('import_mob_xhtml');
47 
48  $presentation = $item->getPresentation();
49  $shuffle = 0;
50  $foundimage = false;
51  $answers = [];
52  $type = assOrderingQuestion::OQ_TERMS;
53 
54  foreach ($presentation->order as $entry) {
55  switch ($entry['type']) {
56  case 'response':
57  $response = $presentation->response[$entry["index"]];
58  $type = $response->getIdent();
59  if ($response->getIdent() === 'OQP') {
60  $type = assOrderingQuestion::OQ_PICTURES;
61  } elseif ($response->getIdent() === 'OQNP') {
62  $type = assOrderingQuestion::OQ_NESTED_PICTURES;
63  } elseif ($response->getIdent() === 'OQNT') {
64  $type = assOrderingQuestion::OQ_NESTED_TERMS;
65  } elseif ($response->getIdent() === 'OQT') {
66  $type = assOrderingQuestion::OQ_TERMS;
67  }
68 
69  $rendertype = $response->getRenderType();
70  switch (get_class($rendertype)) {
71  case ilQTIRenderChoice::class:
72  $shuffle = $rendertype->getShuffle();
73  $answerorder = 0;
74  foreach ($rendertype->response_labels as $response_label) {
75  $ident = $response_label->getIdent();
76  $answertext = '';
77  $answerimage = [];
78  $answerdepth = 0;
79  foreach ($response_label->material as $mat) {
80  for ($m = 0; $m < $mat->getMaterialCount(); $m++) {
81  $foundmat = $mat->getMaterial($m);
82 
83  if ($foundmat['material']->getLabel() === 'answerdepth') {
84  $answerdepth = $foundmat['material']->getContent();
85  }
86  if ($foundmat['type'] === 'mattext'
87  && $foundmat['material']->getLabel() !== 'answerdepth') {
88  $answertext .= $foundmat['material']->getContent();
89  }
90  if ($foundmat['type'] === 'matimage'
91  && $foundmat['material']->getLabel() !== 'answerdepth') {
92  $foundimage = true;
93  $answerimage = [
94  'imagetype' => $foundmat['material']->getImageType(),
95  'label' => $foundmat['material']->getLabel(),
96  'content' => $foundmat['material']->getContent()
97  ];
98  }
99  }
100  }
101  $answers[$answerorder] = [
102  'ident' => $ident,
103  'answertext' => $answertext,
104  'answerimage' => $answerimage,
105  'points' => 0,
106  'answerorder' => $answerorder,
107  'answerdepth' => $answerdepth,
108  'correctness' => '',
109  'action' => ''
110  ];
111  $answerorder++;
112  }
113  break;
114  }
115  break;
116  }
117  }
118 
119  $feedbacksgeneric = [];
120  foreach ($item->resprocessing as $resprocessing) {
121  foreach ($resprocessing->respcondition as $respcondition) {
122  $ident = '';
123  $correctness = 1;
124  $conditionvar = $respcondition->getConditionvar();
125  foreach ($conditionvar->order as $order) {
126  switch ($order['field']) {
127  case "arr_not":
128  $correctness = 0;
129  break;
130  case "varequal":
131  $ident = $conditionvar->varequal[$order['index']]->getContent();
132  $orderindex = $conditionvar->varequal[$order['index']]->getIndex();
133  break;
134  }
135  }
136  foreach ($respcondition->setvar as $setvar) {
137  if ($ident !== '') {
138  $answers[$ident]['solutionorder'] = $orderindex;
139  $answers[$ident]['action'] = $setvar->getAction();
140  $answers[$ident]['points'] = $setvar->getContent();
141  }
142  }
143  if (!is_array($respcondition->displayfeedback)) {
144  continue;
145  }
146 
147  foreach ($respcondition->displayfeedback as $feedbackpointer) {
148  if ($feedbackpointer->getLinkrefid() === '') {
149  continue;
150  }
151 
152  foreach ($item->itemfeedback as $ifb) {
153  if ($ifb->getIdent() === 'response_allcorrect') {
154  // found a feedback for the identifier
155  foreach ($ifb->material as $material) {
156  $feedbacksgeneric[1] = $material;
157  }
158  foreach ($ifb->flow_mat as $fmat) {
159  foreach ($fmat->material as $material) {
160  $feedbacksgeneric[1] = $material;
161  }
162  }
163  continue;
164  }
165 
166  if ($ifb->getIdent() === 'response_onenotcorrect') {
167  // found a feedback for the identifier
168  foreach ($ifb->material as $material) {
169  $feedbacksgeneric[0] = $material;
170  }
171  foreach ($ifb->flow_mat as $fmat) {
172  foreach ($fmat->material as $material) {
173  $feedbacksgeneric[0] = $material;
174  }
175  }
176  }
177  }
178  }
179  }
180  }
181 
182  $itemfeedbacks = $this->getFeedbackAnswerSpecific($item, 'link_');
183 
184  $this->addGeneralMetadata($item);
185  $this->object->setTitle($item->getTitle());
186  $this->object->setNrOfTries((int) $item->getMaxattempts());
187  $this->object->setComment($item->getComment());
188  $this->object->setAuthor($item->getAuthor());
189  $this->object->setOwner($user_id);
190  $this->object->setQuestion($this->QTIMaterialToString($item->getQuestiontext()));
191  $this->object->setOrderingType($type);
192  $this->object->setObjId($questionpool_id);
193  $this->object->setThumbSize(
194  $this->deduceThumbSizeFromImportValue((int) $item->getMetadataEntry('thumb_geometry'))
195  );
196  $this->object->setElementHeight($item->getMetadataEntry('element_height')
197  ? (int) $item->getMetadataEntry('element_height')
198  : null);
199  $this->object->setShuffle($shuffle);
200  $this->object->setPoints(0);
201  $this->object->saveQuestionDataToDb();
202  $points = 0;
203  $solanswers = [];
204 
205  foreach ($answers as $answer) {
206  if (isset($answer['solutionorder'])) {
207  $solanswers[$answer['solutionorder']] = $answer;
208  }
209  }
210  ksort($solanswers);
211  $position = 0;
212  $element_list = $this->object->getOrderingElementList();
213  foreach ($solanswers as $answer) {
214  $points += $answer['points'];
215 
216  $element = new ilAssOrderingElement();
217 
218  if ($element->isExportIdent($answer['ident'])) {
219  $element->setExportIdent($answer['ident']);
220  } else {
221  $element = $element->withPosition($position++);
222  if (isset($answer['answerdepth'])) {
223  $element = $element->withIndentation((int) $answer['answerdepth']);
224  }
225  }
226 
227  if ($this->object->isImageOrderingType()) {
228  $filename = $this->handleUploadedfile($answer);
229  if ($filename !== null) {
230  $element = $element->withContent($filename);
231  }
232  } else {
233  $element = $element->withContent($answer['answertext']);
234  }
235 
236  $element_list->addElement($element);
237  }
238  $this->object->setOrderingElementList($element_list);
239  $points = ($item->getMetadataEntry('points') > 0) ? $item->getMetadataEntry('points') : $points;
240  $this->object->setPoints($points);
241  // additional content editing mode information
242  $this->object->setAdditionalContentEditingMode(
243  $this->fetchAdditionalContentEditingModeInformation($item)
244  );
245  $this->object->saveToDb();
246  $this->importSuggestedSolutions($this->object->getId(), $item->suggested_solutions);
247  foreach ($feedbacksgeneric as $correctness => $material) {
248  $m = $this->QTIMaterialToString($material);
249  $feedbacksgeneric[$correctness] = $m;
250  }
251  $questiontext = $this->object->getQuestion();
252 
253  // handle the import of media objects in XHTML code
254  if (is_array(ilSession::get('import_mob_xhtml'))) {
255  foreach (ilSession::get('import_mob_xhtml') as $mob) {
256  $importfile = $importdirectory . DIRECTORY_SEPARATOR . $mob['uri'];
257 
258  global $DIC; /* @var ILIAS\DI\Container $DIC */
259  $DIC['ilLog']->write(__METHOD__ . ': import mob from dir: ' . $importfile);
260 
261  $media_object = ilObjMediaObject::_saveTempFileAsMediaObject(basename($importfile), $importfile, false);
262  ilObjMediaObject::_saveUsage($media_object->getId(), "qpl:html", $this->object->getId());
263  $questiontext = str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $questiontext);
264  foreach ($this->object->getOrderingElementList() as $element) {
265  $element->setContent(str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $element->getContent()));
266  }
267  foreach ($feedbacksgeneric as $correctness => $material) {
268  $feedbacksgeneric[$correctness] = str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $material);
269  }
270  foreach ($itemfeedbacks as $ident => $material) {
271  $itemfeedbacks[$ident] = str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $material);
272  }
273  }
274  }
275  $this->object->setQuestion(ilRTE::_replaceMediaObjectImageSrc($questiontext, 1));
276  foreach ($this->object->getOrderingElementList() as $element) {
277  $element->setContent(ilRTE::_replaceMediaObjectImageSrc($element->getContent(), 1));
278  }
279  foreach ($feedbacksgeneric as $correctness => $material) {
280  $this->object->feedbackOBJ->importGenericFeedback(
281  $this->object->getId(),
282  $correctness,
283  ilRTE::_replaceMediaObjectImageSrc($material, 1)
284  );
285  }
286  foreach ($itemfeedbacks as $ident => $material) {
287  $index = $this->fetchIndexFromFeedbackIdent($ident, 'link_');
288 
289  $this->object->feedbackOBJ->importSpecificAnswerFeedback(
290  $this->object->getId(),
291  0,
292  $index,
293  ilRTE::_replaceMediaObjectImageSrc($material, 1)
294  );
295  }
296  $this->object->saveToDb();
297  $import_mapping[$item->getIdent()] = $this->addQuestionToParentObjectAndBuildMappingEntry(
298  $questionpool_id,
299  $tst_id,
300  $question_counter,
301  $tst_object
302  );
303  return $import_mapping;
304  }
ilRTE\_replaceMediaObjectImageSrc
static _replaceMediaObjectImageSrc(string $a_text, int $a_direction=0, string $nic='')
Replaces image source from mob image urls with the mob id or replaces mob id with the correct image s...
Definition: class.ilRTE.php:174
ilSession\get
static get(string $a_var)
Definition: class.ilSession.php:401
assQuestionImport\getFeedbackAnswerSpecific
getFeedbackAnswerSpecific(ilQTIItem $item, $prefix='response_')
Definition: class.assQuestionImport.php:132
assQuestionImport\deduceThumbSizeFromImportValue
deduceThumbSizeFromImportValue(?int $size)
Definition: class.assQuestionImport.php:371
assQuestionImport\addGeneralMetadata
addGeneralMetadata(ilQTIItem $item)
Definition: class.assQuestionImport.php:194
IL_INST_ID
const IL_INST_ID
Definition: constants.php:40
assQuestionImport\QTIMaterialToString
QTIMaterialToString(ilQTIMaterial $a_material)
Reads an QTI material tag and creates a text or XHTML string.
Definition: class.assQuestionImport.php:348
assQuestionImport\addQuestionToParentObjectAndBuildMappingEntry
addQuestionToParentObjectAndBuildMappingEntry(int $questionpool_id, ?int $tst_id, int &$question_counter, ?ilObjTest &$tst_object)
Definition: class.assQuestionImport.php:388
ilQTIItem\getMetadataEntry
getMetadataEntry(string $a_label)
Definition: class.ilQTIItem.php:335
assQuestionImport\fetchAdditionalContentEditingModeInformation
fetchAdditionalContentEditingModeInformation($qtiItem)
fetches the "additional content editing mode" information from qti item and falls back to ADDITIONAL_...
Definition: class.assQuestionImport.php:261
ilObjMediaObject\_saveUsage
static _saveUsage(int $a_mob_id, string $a_type, int $a_id, int $a_usage_hist_nr=0, string $a_lang="-")
Save usage of mob within another container (e.g.
Definition: class.ilObjMediaObject.php:850
$response
$response
Definition: xapitoken.php:90
$DIC
global $DIC
Definition: shib_login.php:25
$filename
$filename
Definition: buildRTE.php:78
assQuestionImport\importSuggestedSolutions
importSuggestedSolutions(int $question_id, array $solution_from_import)
Definition: class.assQuestionImport.php:272
ilObjMediaObject\_saveTempFileAsMediaObject
static _saveTempFileAsMediaObject(string $name, string $tmp_name, bool $upload=true)
Definition: class.ilObjMediaObject.php:1342
ilSession\clear
static clear(string $a_var)
Definition: class.ilSession.php:414
assQuestionImport\fetchIndexFromFeedbackIdent
fetchIndexFromFeedbackIdent($feedbackIdent, $prefix='response_')
Definition: class.assQuestionImport.php:122
+ Here is the call graph for this function:

◆ handleUploadedFile()

assOrderingQuestionImport::handleUploadedFile ( array  $answer)
protected

Definition at line 306 of file class.assOrderingQuestionImport.php.

References ilShellUtil\convertImage(), ensureImagePathExists(), ilFileUtils\ilTempnam(), ILIAS\Repository\object(), and assOrderingQuestion\VALID_UPLOAD_SUFFIXES.

306  : ?string
307  {
308  $image = base64_decode($answer["answerimage"]["content"] ?? '');
309  $image_file_name = $answer['answerimage']['label'] ?? '';
310  $tmp_path = ilFileUtils::ilTempnam();
311 
312  $file_handle = fopen($tmp_path, "wb");
313  if ($file_handle === false) {
314  return null;
315  }
316  fwrite($file_handle, $image);
317  fclose($file_handle);
318 
319  $filename_path_parts = explode(".", $image_file_name);
320  $suffix = strtolower(array_pop($filename_path_parts));
321  if (!in_array($suffix, assOrderingQuestion::VALID_UPLOAD_SUFFIXES)) {
322  return null;
323  }
324 
325  $this->ensureImagePathExists();
326  $target_filename = $this->object->buildHashedImageFilename($image_file_name, true);
327  $target_filepath = $this->object->getImagePath() . $target_filename;
328  if (rename($tmp_path, $target_filepath)) {
329  $thumb_path = $this->object->getImagePath() . $this->object->getThumbPrefix() . $target_filename;
330  ilShellUtil::convertImage($target_filepath, $thumb_path, "JPEG", $this->object->getThumbSize());
331  return $target_filename;
332  }
333 
334  return null;
335  }
ilShellUtil\convertImage
static convertImage(string $a_from, string $a_to, string $a_target_format="", string $a_geometry="", string $a_background_color="")
Definition: class.ilShellUtil.php:161
ilFileUtils\ilTempnam
static ilTempnam(?string $a_temp_path=null)
Returns a unique and non existing Path for e temporary file or directory.
Definition: class.ilFileUtils.php:676
+ Here is the call graph for this function:

Field Documentation

◆ $object

assOrderingQuestionImport::$object

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

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