assQuestionImport Class Reference

Class for question imports. More...

Inheritance diagram for assQuestionImport:

Collaboration diagram for assQuestionImport:

Public Member Functions
	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

Protected Member Functions
	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)

Protected Attributes
SuggestedSolutionsDatabaseRepository	$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 34 of file class.assQuestionImport.php.

Member Function Documentation

addGeneralMetadata()

assQuestionImport::addGeneralMetadata ( ilQTIItem  $item )

protected

Parameters

ilQTIItem

$item

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

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

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

                                                          : 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:

addQuestionToParentObjectAndBuildMappingEntry()

assQuestionImport::addQuestionToParentObjectAndBuildMappingEntry ( int  $questionpool_id, ?int  $tst_id, int &  $question_counter, ?ilObjTest &  $tst_object  )

protected

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

References ilObject\getId().

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

     : array {
        if ($tst_id !== null && $tst_id === $questionpool_id) {
            $tst_object->questions[$question_counter++] = $this->object->getId();
            return ['pool' => 0, 'test' => $this->object->getId()];
        }

        if ($tst_id > 0) {
            $question_id = $this->object->duplicate(true, '', '', -1, $tst_id);
            $tst_object->questions[$question_counter++] = $question_id;
            return ['pool' => $this->object->getId(), 'test' => $question_id];
        }
        return ['pool' => $this->object->getId(), 'test' => 0];
    }

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 371 of file class.assQuestionImport.php.

References ILIAS\Repository\object().

Referenced by assMultipleChoiceImport\fromXML(), assSingleChoiceImport\fromXML(), assKprimChoiceImport\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 261 of file class.assQuestionImport.php.

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

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

                                                                                   : 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 122 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 209 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 322 of file class.assQuestionImport.php.

Referenced by importSuggestedSolutions().

                                                             : ?string
    {
        foreach (array_keys(SuggestedSolution::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	(	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 178 of file class.assQuestionImport.php.

     : array {
        return [];
    }

getFeedbackAnswerSpecific()

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

protected

Parameters

ilQTIItem	$item
string	$prefix

Returns

array

Definition at line 132 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 63 of file class.assQuestionImport.php.

References QTIMaterialToString().

Referenced by assErrorTextImport\fromXML(), assFileUploadImport\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:

getQuestionId()

assQuestionImport::getQuestionId

(

)

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

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

getSuggestedSolutionsRepo()

assQuestionImport::getSuggestedSolutionsRepo ( )

protected

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

References $dic, and $suggestedsolution_repo.

Referenced by importSuggestedSolutions().

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

Here is the caller graph for this function:

importSuggestedSolutions()

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

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

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

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

     : 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 !== SuggestedSolution::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 232 of file class.assQuestionImport.php.

References $text, 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;
                $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 348 of file class.assQuestionImport.php.

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

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

                                                                  : string
    {
        $result = '';
        $mobs = ilSession::get('import_mob_xhtml') ?? [];
        for ($i = 0; $i < $a_material->getMaterialCount(); $i++) {
            $material = $a_material->getMaterial($i);
            switch ($material['type']) {
                case 'mattext':
                    $result .= $material['material']->getContent();
                    break;
                case 'matimage':
                    $matimage = $material['material'];
                    if (preg_match("/(il_([0-9]+)_mob_([0-9]+))/", $matimage->getLabel(), $matches)) {
                        $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 41 of file class.assQuestionImport.php.

$object

assQuestionImport::$object

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

$suggestedsolution_repo

SuggestedSolutionsDatabaseRepository assQuestionImport::$suggestedsolution_repo = null

protected

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

Referenced by getSuggestedSolutionsRepo().

---

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

• components/ILIAS/TestQuestionPool/classes/import/qti12/class.assQuestionImport.php