Class for question imports. More...

Inheritance diagram for assQuestionImport:

Collaboration diagram for assQuestionImport:

Public Member Functions
	getQuestionId ()

	getFeedbackGeneric ($item)

	fromXML (&$item, $questionpool_id, &$tst_id, &$tst_object, &$question_counter, $import_mapping)
	Creates a question from a QTI file. More...

	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

Protected Member Functions
	fetchIndexFromFeedbackIdent ($feedbackIdent, $prefix='response_')

	getFeedbackAnswerSpecific (ilQTIItem $item, $prefix='response_')

	addGeneralMetadata (ilQTIItem $item)

	fetchLifecycle (ilQTIItem $item)

	getQplImportArchivDirectory ()
	returns the full path to extracted qpl import archiv (qpl import dir + qpl archiv subdir) More...

	getTstImportArchivDirectory ()
	returns the full path to extracted tst import archiv (tst import dir + tst archiv subdir) More...

	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)

Protected Attributes
assQuestionSuggestedSolutionsDatabaseRepository	$suggestedsolution_repo = null

Private Attributes
Filesystem	$filesystem

Detailed Description

Class for question imports.

assQuestionImport is a basis class 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 33 of file class.assQuestionImport.php.

Member Function Documentation

◆ addGeneralMetadata()

assQuestionImport::addGeneralMetadata ( ilQTIItem $item )

protected

Parameters

ilQTIItem $item

Definition at line 197 of file class.assQuestionImport.php.

References fetchLifecycle(), and ilQTIItem\getMetadataEntry().

                                                           : void
     {
         if ($item->getMetadataEntry('externalID')) {
             $this->object->setExternalId($item->getMetadataEntry('externalID'));
         } else {
             $this->object->setExternalId($item->getMetadataEntry('externalId'));
         }
 
         $this->object->setLifecycle($this->fetchLifecycle($item));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deduceThumbSizeFromImportValue()

assQuestionImport::deduceThumbSizeFromImportValue ( ?int $size )

protected

Definition at line 399 of file class.assQuestionImport.php.

References ILIAS\Repository\object().

Referenced by assKprimChoiceImport\fromXML(), assSingleChoiceImport\fromXML(), assMultipleChoiceImport\fromXML(), assOrderingQuestionImport\fromXML(), and assMatchingQuestionImport\fromXML().

                                                                  : int
     {
         if ($size === null) {
             return $this->object->getThumbSize();
         }
 
         if ($size < $this->object->getMinimumThumbSize()) {
             return $this->object->getMinimumThumbSize();
         }
 
         if ($size > $this->object->getMaximumThumbSize()) {
             return $this->object->getMaximumThumbSize();
         }
 
         return $size;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchAdditionalContentEditingModeInformation()

assQuestionImport::fetchAdditionalContentEditingModeInformation ( $qtiItem )

finalprotected

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

protected

Returns: string $additionalContentEditingMode

Definition at line 286 of file class.assQuestionImport.php.

References assQuestion\ADDITIONAL_CONTENT_EDITING_MODE_RTE, and ILIAS\Repository\object().

                                                                                    : string
     {
         $additionalContentEditingMode = $qtiItem->getMetadataEntry('additional_cont_edit_mode');
 
         if (!$this->object->isValidAdditionalContentEditingMode($additionalContentEditingMode ?? '')) {
             $additionalContentEditingMode = assQuestion::ADDITIONAL_CONTENT_EDITING_MODE_RTE;
         }
 
         return $additionalContentEditingMode;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchIndexFromFeedbackIdent()

assQuestionImport::fetchIndexFromFeedbackIdent	(	$feedbackIdent,
		$prefix = `'response_'`
	)

protected

Parameters

	$feedbackIdent
string	$prefix

Returns: int

Definition at line 121 of file class.assQuestionImport.php.

Referenced by assErrorTextImport\fromXML(), assOrderingHorizontalImport\fromXML(), assOrderingQuestionImport\fromXML(), and assTextQuestionImport\fromXML().

                                                                                          : int
     {
         return (int) str_replace($prefix, '', $feedbackIdent);
     }

Here is the caller graph for this function:

◆ fetchLifecycle()

assQuestionImport::fetchLifecycle ( ilQTIItem $item )

protected

Parameters

ilQTIItem $item

Returns: ilAssQuestionLifecycle

Definition at line 212 of file class.assQuestionImport.php.

References Vendor\Package\$e, $lifecycle, ilAssQuestionLifecycle\getDraftInstance(), ilAssQuestionLifecycle\getInstance(), and ilQTIItem\getMetadataEntry().

Referenced by addGeneralMetadata().

                                                       : ilAssQuestionLifecycle
     {
         try {
             $lifecycle = ilAssQuestionLifecycle::getInstance(
                 $item->getMetadataEntry('ilias_lifecycle')
             );
         } catch (ilTestQuestionPoolInvalidArgumentException $e) {
             try {
                 $lomLifecycle = new ilAssQuestionLomLifecycle(
                     $item->getMetadataEntry('lifecycle')
                 );
 
                 $lifecycle = ilAssQuestionLifecycle::getInstance(
                     $lomLifecycle->getMappedIliasLifecycleIdentifer()
                 );
             } catch (ilTestQuestionPoolInvalidArgumentException $e) {
                 $lifecycle = ilAssQuestionLifecycle::getDraftInstance();
             }
         }
 
         return $lifecycle;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findSolutionTypeByValue()

assQuestionImport::findSolutionTypeByValue ( string $value )

protected

Definition at line 347 of file class.assQuestionImport.php.

Referenced by importSuggestedSolutions().

                                                              : ?string
     {
         foreach (array_keys(assQuestionSuggestedSolution::TYPES) as $type) {
             $search_type = '_' . $type . '_';
             if (strpos($value, $search_type) !== false) {
                 return $type;
             }
         }
         return null;
     }

Here is the caller graph for this function:

◆ fromXML()

assQuestionImport::fromXML	(	&	$item,
			$questionpool_id,
		&	$tst_id,
		&	$tst_object,
		&	$question_counter,
			$import_mapping
	)

Creates a question from a QTI file.

Receives parameters from a QTI parser and creates a valid ILIAS question object

Parameters

ilQtiItem	$item	The QTI item object
integer	$questionpool_id	The id of the parent questionpool
integer	$tst_id	The id of the parent test if the question is part of a test
object	$tst_object	A reference to the parent test object
integer	$question_counter	A reference to a question counter to count the questions of an imported question pool
array	$import_mapping	An array containing references to included ILIAS objects public

Definition at line 190 of file class.assQuestionImport.php.

                                                                                                                   : array
     {
     }

◆ getFeedbackAnswerSpecific()

assQuestionImport::getFeedbackAnswerSpecific	(	ilQTIItem	$item,
			$prefix = `'response_'`
	)

protected

Parameters

ilQTIItem	$item
string	$prefix

Returns: array

Definition at line 131 of file class.assQuestionImport.php.

References QTIMaterialToString().

Referenced by assErrorTextImport\fromXML(), assOrderingHorizontalImport\fromXML(), assOrderingQuestionImport\fromXML(), assTextQuestionImport\fromXML(), and assMatchingQuestionImport\fromXML().

                                                                                         : array
     {
         $feedbacks = [];
 
         foreach ($item->itemfeedback as $ifb) {
             if ($ifb->getIdent() == 'response_allcorrect' || $ifb->getIdent() == 'response_onenotcorrect') {
                 continue;
             }
 
             if ($ifb->getIdent() == $prefix . 'allcorrect' || $ifb->getIdent() == $prefix . 'onenotcorrect') {
                 continue;
             }
 
             if (substr($ifb->getIdent(), 0, strlen($prefix)) != $prefix) {
                 continue;
             }
 
             $ident = $ifb->getIdent();
 
             // found a feedback for the identifier
 
             if (count($ifb->material)) {
                 foreach ($ifb->material as $material) {
                     $feedbacks[$ident] = $material;
                 }
             }
 
             if ((count($ifb->flow_mat) > 0)) {
                 foreach ($ifb->flow_mat as $fmat) {
                     if (count($fmat->material)) {
                         foreach ($fmat->material as $material) {
                             $feedbacks[$ident] = $material;
                         }
                     }
                 }
             }
         }
 
         foreach ($feedbacks as $ident => $material) {
             $m = $this->QTIMaterialToString($material);
             $feedbacks[$ident] = $m;
         }
 
         return $feedbacks;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFeedbackGeneric()

assQuestionImport::getFeedbackGeneric ( $item )

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

References QTIMaterialToString().

Referenced by assFileUploadImport\fromXML(), assErrorTextImport\fromXML(), assFormulaQuestionImport\fromXML(), and assOrderingHorizontalImport\fromXML().

                                              : array
     {
         $feedbacksgeneric = [];
         foreach ($item->resprocessing as $resprocessing) {
             foreach ($resprocessing->respcondition as $respcondition) {
                 foreach ($respcondition->displayfeedback as $feedbackpointer) {
                     if (strlen($feedbackpointer->getLinkrefid())) {
                         foreach ($item->itemfeedback as $ifb) {
                             if (strcmp($ifb->getIdent(), "response_allcorrect") == 0) {
                                 // found a feedback for the identifier
                                 if (count($ifb->material)) {
                                     foreach ($ifb->material as $material) {
                                         $feedbacksgeneric[1] = $material;
                                     }
                                 }
                                 if ((count($ifb->flow_mat) > 0)) {
                                     foreach ($ifb->flow_mat as $fmat) {
                                         if (count($fmat->material)) {
                                             foreach ($fmat->material as $material) {
                                                 $feedbacksgeneric[1] = $material;
                                             }
                                         }
                                     }
                                 }
                             } elseif (strcmp($ifb->getIdent(), "response_onenotcorrect") == 0) {
                                 // found a feedback for the identifier
                                 if (count($ifb->material)) {
                                     foreach ($ifb->material as $material) {
                                         $feedbacksgeneric[0] = $material;
                                     }
                                 }
                                 if ((count($ifb->flow_mat) > 0)) {
                                     foreach ($ifb->flow_mat as $fmat) {
                                         if (count($fmat->material)) {
                                             foreach ($fmat->material as $material) {
                                                 $feedbacksgeneric[0] = $material;
                                             }
                                         }
                                     }
                                 }
                             }
                         }
                     }
                 }
             }
         }
         // handle the import of media objects in XHTML code
         foreach ($feedbacksgeneric as $correctness => $material) {
             $m = $this->QTIMaterialToString($material);
             $feedbacksgeneric[$correctness] = $m;
         }
         return $feedbacksgeneric;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQplImportArchivDirectory()

assQuestionImport::getQplImportArchivDirectory ( )

protected

returns the full path to extracted qpl import archiv (qpl import dir + qpl archiv subdir)

Definition at line 238 of file class.assQuestionImport.php.

References ilObjQuestionPool\_getImportDirectory(), and ilSession\get().

Referenced by assKprimChoiceImport\fromXML(), assLongMenuImport\fromXML(), assFileUploadImport\fromXML(), assErrorTextImport\fromXML(), assImagemapQuestionImport\fromXML(), assOrderingHorizontalImport\fromXML(), assMultipleChoiceImport\fromXML(), assNumericImport\fromXML(), assTextSubsetImport\fromXML(), assClozeTestImport\fromXML(), assSingleChoiceImport\fromXML(), assOrderingQuestionImport\fromXML(), assTextQuestionImport\fromXML(), and assMatchingQuestionImport\fromXML().

                                                     : string
     {
         return ilObjQuestionPool::_getImportDirectory() . '/' . ilSession::get("qpl_import_subdir");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionId()

assQuestionImport::getQuestionId ( )

Definition at line 57 of file class.assQuestionImport.php.

                                    : int
     {
         return (int) $this->object->getId();
     }

◆ getSuggestedSolutionsRepo()

assQuestionImport::getSuggestedSolutionsRepo ( )

protected

Definition at line 360 of file class.assQuestionImport.php.

References $dic, $suggestedsolution_repo, and ilQuestionPoolDIC\dic().

Referenced by importSuggestedSolutions().

                                                   : assQuestionSuggestedSolutionsDatabaseRepository
     {
         if (is_null($this->suggestedsolution_repo)) {
             $dic = ilQuestionPoolDIC::dic();
             $this->suggestedsolution_repo = $dic['question.repo.suggestedsolutions'];
         }
         return $this->suggestedsolution_repo;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTstImportArchivDirectory()

assQuestionImport::getTstImportArchivDirectory ( )

protected

returns the full path to extracted tst import archiv (tst import dir + tst archiv subdir)

Definition at line 246 of file class.assQuestionImport.php.

References ilObjTest\_getImportDirectory(), and ilSession\get().

Referenced by assKprimChoiceImport\fromXML(), assLongMenuImport\fromXML(), assFileUploadImport\fromXML(), assErrorTextImport\fromXML(), assImagemapQuestionImport\fromXML(), assOrderingHorizontalImport\fromXML(), assMultipleChoiceImport\fromXML(), assNumericImport\fromXML(), assTextSubsetImport\fromXML(), assClozeTestImport\fromXML(), assSingleChoiceImport\fromXML(), assOrderingQuestionImport\fromXML(), assTextQuestionImport\fromXML(), and assMatchingQuestionImport\fromXML().

                                                     : string
     {
         return ilObjTest::_getImportDirectory() . '/' . ilSession::get("tst_import_subdir");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importSuggestedSolutions()

assQuestionImport::importSuggestedSolutions	(	int	$question_id,
		array	$solution_from_import
	)

Definition at line 297 of file class.assQuestionImport.php.

References $path, CLIENT_WEB_DIR, ILIAS\Repository\filesystem(), findSolutionTypeByValue(), getSuggestedSolutionsRepo(), and ILIAS\Repository\object().

      : void {
         if (!$solution_from_import === []
             || !isset($solution_from_import[0]['solution'])) {
             return;
         }
 
         $solution_item = $solution_from_import[0]['solution'];
         $content = $solution_item->getContent();
         if ($solution_item->getTexttype() === 'application/json') {
             $content = json_decode($content, true);
             if (!isset($content['type']) || !isset($content['value'])) {
                 return;
             }
             $type = $content['type'];
         } else {
             $type = $this->findSolutionTypeByValue($solution_item->getContent());
             if ($type === null) {
                 return;
             }
         }
 
         $repo = $this->getSuggestedSolutionsRepo();
         $solution_object = $repo->create($question_id, $type);
 
         if ($type !== assQuestionSuggestedSolution::TYPE_FILE) {
             $link = is_string($content) ? $content : $content['value'];
             $adapted_link = $this->object->resolveInternalLink($link);
             if ($adapted_link === '') {
                 return;
             }
             $solution_object = $solution_object
                 ->withInternalLink($adapted_link)
                 ->withImportId($link);
         } else {
             if (!isset($content['title']) || !isset($content['filename'])) {
                 return;
             }
             $path = str_replace(CLIENT_WEB_DIR . DIRECTORY_SEPARATOR, '', $this->object->getSuggestedSolutionPath() . $content['filename']);
             $this->filesystem->put($path, base64_decode($content['value']));
             $solution_object = $solution_object->withTitle($content['title'])
                 ->withFilename($content['filename'])
                 ->withSize((int) $this->filesystem->getSize($path, DataSize::Byte)->inBytes())
                 ->withMime($this->filesystem->getMimeType($path));
         }
         $repo->update([$solution_object]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processNonAbstractedImageReferences()

assQuestionImport::processNonAbstractedImageReferences	(	$text,
		$sourceNic
	)

protected

Definition at line 251 of file class.assQuestionImport.php.

References ilRTE\_replaceMediaObjectImageSrc(), and ilSession\set().

Referenced by assClozeTestImport\fromXML().

                                                                              : string
     {
         $reg = '/<img.*src=".*\\/mm_(\\d+)\\/(.*?)".*>/m';
         $matches = null;
 
         if (preg_match_all($reg, $text, $matches)) {
             $mobs = [];
             for ($i = 0, $max = count($matches[1]); $i < $max; $i++) {
                 $mobSrcId = $matches[1][$i];
                 $mobSrcName = $matches[2][$i];
                 $mobSrcLabel = 'il_' . $sourceNic . '_mob_' . $mobSrcId;
 
                 //if (!is_array(ilSession::get("import_mob_xhtml"))) {
                 //    ilSession::set("import_mob_xhtml", array());
                 //}
 
                 //$_SESSION["import_mob_xhtml"][] = array(
                 $mobs[] = [
                     "mob" => $mobSrcLabel, "uri" => 'objects/' . $mobSrcLabel . '/' . $mobSrcName
                 ];
             }
             ilSession::set('import_mob_xhtml', $mobs);
         }
 
         return ilRTE::_replaceMediaObjectImageSrc($text, 0, $sourceNic);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ QTIMaterialToString()

assQuestionImport::QTIMaterialToString ( ilQTIMaterial $a_material )

Reads an QTI material tag and creates a text or XHTML string.

Returns: string text or xhtml string

Definition at line 373 of file class.assQuestionImport.php.

References ilSession\get(), ilQTIMaterial\getMaterial(), ilQTIMaterial\getMaterialCount(), and ilSession\set().

                                                                   : string
     {
         $result = "";
         $mobs = ilSession::get('import_mob_xhtml') ?? [];
         for ($i = 0; $i < $a_material->getMaterialCount(); $i++) {
             $material = $a_material->getMaterial($i);
             if (strcmp($material["type"], "mattext") === 0) {
                 $result .= $material["material"]->getContent();
             }
             if (strcmp($material["type"], "matimage") === 0) {
                 $matimage = $material["material"];
                 if (preg_match("/(il_([0-9]+)_mob_([0-9]+))/", $matimage->getLabel(), $matches)) {
                     // import an mediaobject which was inserted using tiny mce
                     //if (!is_array(ilSession::get("import_mob_xhtml"))) {
                     //    ilSession::set("import_mob_xhtml", array());
                     //}
                     $mobs[] = ["mob" => $matimage->getLabel(),
                                     "uri" => $matimage->getUri()
                     ];
                 }
             }
         }
         ilSession::set('import_mob_xhtml', $mobs);
         return $result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $filesystem

Filesystem assQuestionImport::$filesystem

private

Definition at line 40 of file class.assQuestionImport.php.

◆ $object

assQuestionImport::$object

Definition at line 38 of file class.assQuestionImport.php.

◆ $suggestedsolution_repo

assQuestionSuggestedSolutionsDatabaseRepository assQuestionImport::$suggestedsolution_repo = null

protected

Definition at line 359 of file class.assQuestionImport.php.

Referenced by getSuggestedSolutionsRepo().

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

Modules/TestQuestionPool/classes/import/qti12/class.assQuestionImport.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ addGeneralMetadata()

◆ deduceThumbSizeFromImportValue()

◆ fetchAdditionalContentEditingModeInformation()

◆ fetchIndexFromFeedbackIdent()

◆ fetchLifecycle()

◆ findSolutionTypeByValue()

◆ fromXML()

◆ getFeedbackAnswerSpecific()

◆ getFeedbackGeneric()

◆ getQplImportArchivDirectory()

◆ getQuestionId()

◆ getSuggestedSolutionsRepo()

◆ getTstImportArchivDirectory()

◆ importSuggestedSolutions()

◆ processNonAbstractedImageReferences()

◆ QTIMaterialToString()

Field Documentation

◆ $filesystem

◆ $object

◆ $suggestedsolution_repo