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

Inheritance diagram for assQuestionImport:

Collaboration diagram for assQuestionImport:

Public Member Functions
	__construct ($a_object)
	assQuestionImport constructor More...

	getQuestionId ()

	getFeedbackGeneric ($item)

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

	importSuggestedSolution (int $question_id, string $value="", int $subquestion_index=0)

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

	deduceThumbSizeFromImportValue (?int $size)

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

Constructor & Destructor Documentation

◆ __construct()

assQuestionImport::__construct ( $a_object )

assQuestionImport constructor

Parameters

object $a_object The question object @access public

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

    {
        $this->object = $a_object;
    }

Member Function Documentation

◆ addGeneralMetadata()

assQuestionImport::addGeneralMetadata ( ilQTIItem $item )

protected

Parameters

ilQTIItem $item

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

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

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

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

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

References ILIAS\Repository\object().

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

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

@final @access protected

Returns: string $additionalContentEditingMode

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

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

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

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

Reimplemented in assMatchingQuestionImport.

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

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

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

Here is the caller graph for this function:

◆ fetchLifecycle()

assQuestionImport::fetchLifecycle ( ilQTIItem $item )

protected

Parameters

ilQTIItem $item

Returns: ilAssQuestionLifecycle

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

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

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

Referenced by addGeneralMetadata().

Here is the call graph for this function:

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 @access public

Reimplemented in assClozeTestImport, assErrorTextImport, assFileUploadImport, assFlashQuestionImport, assFormulaQuestionImport, assImagemapQuestionImport, assKprimChoiceImport, assLongMenuImport, assMatchingQuestionImport, assMultipleChoiceImport, assNumericImport, assOrderingHorizontalImport, assOrderingQuestionImport, assSingleChoiceImport, assTextQuestionImport, and assTextSubsetImport.

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

                                                                                                                  : array
    {
    }

◆ getFeedbackAnswerSpecific()

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

protected

Parameters

ilQTIItem	$item
string	$prefix

Returns: array

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

                                                                                        : array
    {
        $feedbacks = array();
 
        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->object->QTIMaterialToString($material);
            $feedbacks[$ident] = $m;
        }
 
        return $feedbacks;
    }

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

Here is the caller graph for this function:

◆ getFeedbackGeneric()

assQuestionImport::getFeedbackGeneric ( $item )

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

                                             : array
    {
        $feedbacksgeneric = array();
        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->object->QTIMaterialToString($material);
            $feedbacksgeneric[$correctness] = $m;
        }
        return $feedbacksgeneric;
    }

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

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionId()

assQuestionImport::getQuestionId ( )

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

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

◆ getTstImportArchivDirectory()

assQuestionImport::getTstImportArchivDirectory ( )

protected

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

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importSuggestedSolution()

assQuestionImport::importSuggestedSolution	(	int	$question_id,
		string	$value = `""`,
		int	$subquestion_index = `0`
	)

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

     : void {
        $type = $this->findSolutionTypeByValue($value);
        if (!$type) {
            return;
        }
 
        $repo = $this->getSuggestedSolutionsRepo();
 
        $nu_value = $this->object->_resolveInternalLink($value);
        $solution = $repo->create($question_id, $type)
            ->withInternalLink($nu_value)
            ->withImportId($value);
        $repo->update($solution);
    }

◆ processNonAbstractedImageReferences()

assQuestionImport::processNonAbstractedImageReferences	(	$text,
		$sourceNic
	)

protected

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

                                                                             : string
    {
        $reg = '/<img.*src=".*\\/mm_(\\d+)\\/(.*?)".*>/m';
        $matches = null;
 
        if (preg_match_all($reg, $text, $matches)) {
            $mobs = array();
            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[] = array(
                    "mob" => $mobSrcLabel, "uri" => 'objects/' . $mobSrcLabel . '/' . $mobSrcName
                );
            }
            ilSession::set('import_mob_xhtml', $mobs);
        }
 
        return ilRTE::_replaceMediaObjectImageSrc($text, 0, $sourceNic);
    }

References $i, $mobs, ilRTE\_replaceMediaObjectImageSrc(), and ilSession\set().

Referenced by assClozeTestImport\fromXML().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $object

assQuestionImport::$object

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

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

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addGeneralMetadata()

◆ deduceThumbSizeFromImportValue()

◆ fetchAdditionalContentEditingModeInformation()

◆ fetchIndexFromFeedbackIdent()

◆ fetchLifecycle()

◆ fromXML()

◆ getFeedbackAnswerSpecific()

◆ getFeedbackGeneric()

◆ getQplImportArchivDirectory()

◆ getQuestionId()

◆ getTstImportArchivDirectory()

◆ importSuggestedSolution()

◆ processNonAbstractedImageReferences()

Field Documentation

◆ $object