ilTestImporter Class Reference

Importer class for files. More...

Inheritance diagram for ilTestImporter:

Collaboration diagram for ilTestImporter:

Public Member Functions
	__construct ()
	importXmlRepresentation (string $a_entity, string $a_id, string $a_xml, ilImportMapping $a_mapping)
	addTaxonomyAndQuestionsMapping (array $question_id_mapping, int $new_obj_id, ilImportMapping $mapping)
	finalProcessing (ilImportMapping $a_mapping)
	importRandomQuestionSetConfig (ilObjTest $test_obj, ?string $xml_file, \ilImportMapping $a_mapping)
Public Member Functions inherited from ilXmlImporter
	__construct ()
	setImport (ilImport $a_val)
	getImport ()
	init ()
	setInstallId (string $a_val)
	getInstallId ()
	setInstallUrl (string $a_val)
	getInstallUrl ()
	setSchemaVersion (string $a_val)
	getSchemaVersion ()
	setImportDirectory (string $a_val)
	getImportDirectory ()
	setSkipEntities (array $a_val)
	getSkipEntities ()
	exportedFromSameInstallation ()
	importXmlRepresentation (string $a_entity, string $a_id, string $a_xml, ilImportMapping $a_mapping)
	finalProcessing (ilImportMapping $a_mapping)
	afterContainerImportProcessing (ilImportMapping $mapping)

Static Public Attributes
static	$finallyProcessedTestsRegistry = []

Protected Member Functions
	finalRandomTestTaxonomyProcessing (ilImportMapping $mapping, string $old_tst_obj_id, string $new_tst_obj_id, ilObjTest $test_obj)
	getNewMappedTaxonomyFilter (ilImportMapping $mapping, array $mapped_filter)
	importQuestionSkillAssignments (ilImportMapping $mapping, ilObjTest $test_obj, ?string $xml_file)
	importSkillLevelThresholds (ilImportMapping $mapping, ilAssQuestionSkillAssignmentList $assignment_list, ilObjTest $test_obj, ?string $xml_file)

Private Attributes
readonly TestLogger	$logger
readonly ilDBInterface	$db
readonly ResourceStorage	$irss

Additional Inherited Members
Protected Attributes inherited from ilXmlImporter
array	$skip_entities = array()
ilImport	$imp
string	$install_id
string	$install_url
string	$schema_version
string	$import_directory

Detailed Description

Importer class for files.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$ \

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

Constructor & Destructor Documentation

__construct()

ilTestImporter::__construct

(

)

Definition at line 45 of file class.ilTestImporter.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\logger().

    {
        global $DIC;
        $this->logger = TestDIC::dic()['logging.logger'];
        $this->db = $DIC['ilDB'];
        $this->irss = $DIC['resource_storage'];

        parent::__construct();
    }

Here is the call graph for this function:

Member Function Documentation

addTaxonomyAndQuestionsMapping()

ilTestImporter::addTaxonomyAndQuestionsMapping	(	array	$question_id_mapping,
		int	$new_obj_id,
		ilImportMapping	$mapping
	)

Definition at line 150 of file class.ilTestImporter.php.

References ilImportMapping\addMapping().

Referenced by importXmlRepresentation().

     : ilImportMapping {
        foreach ($question_id_mapping as $old_question_id => $new_question_id) {
            $mapping->addMapping(
                'components/ILIAS/Taxonomy',
                'tax_item',
                "tst:quest:{$old_question_id}",
                (string) $new_question_id
            );

            $mapping->addMapping(
                'components/ILIAS/Taxonomy',
                'tax_item_obj_id',
                "tst:quest:{$old_question_id}",
                (string) $new_obj_id
            );

            $mapping->addMapping(
                'components/ILIAS/Test',
                'quest',
                (string) $old_question_id,
                (string) $new_question_id
            );
        }

        return $mapping;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

finalProcessing()

ilTestImporter::finalProcessing

(

ilImportMapping

$a_mapping

)

Definition at line 181 of file class.ilTestImporter.php.

References finalRandomTestTaxonomyProcessing(), ilObjectFactory\getInstanceByObjId(), and ilImportMapping\getMappingsOfEntity().

                                                               : void
    {
        $maps = $a_mapping->getMappingsOfEntity("components/ILIAS/Test", "tst");

        foreach ($maps as $old => $new) {
            if ($old == "new_id" || (int) $old <= 0) {
                continue;
            }

            if (isset(self::$finallyProcessedTestsRegistry[$new])) {
                continue;
            }

            $test_obj = ilObjectFactory::getInstanceByObjId((int) $new, false);
            if ($test_obj->isRandomTest()) {
                $this->finalRandomTestTaxonomyProcessing($a_mapping, (string) $old, $new, $test_obj);
            }

            self::$finallyProcessedTestsRegistry[$new] = true;
        }
    }

Here is the call graph for this function:

finalRandomTestTaxonomyProcessing()

ilTestImporter::finalRandomTestTaxonomyProcessing ( ilImportMapping  $mapping, string  $old_tst_obj_id, string  $new_tst_obj_id, ilObjTest  $test_obj  )

protected

Definition at line 203 of file class.ilTestImporter.php.

References ilImportMapping\getMapping(), getNewMappedTaxonomyFilter(), and ilObjTaxonomy\saveUsage().

Referenced by finalProcessing().

     : void {
        $new_tax_ids = $mapping->getMapping(
            'components/ILIAS/Taxonomy',
            'tax_usage_of_obj',
            $old_tst_obj_id
        );

        if ($new_tax_ids !== null) {
            foreach (explode(':', $new_tax_ids) as $tax_id) {
                ilObjTaxonomy::saveUsage((int) $tax_id, (int) $new_tst_obj_id);
            }
        }

        $src_pool_def_list = new ilTestRandomQuestionSetSourcePoolDefinitionList(
            $this->db,
            $test_obj,
            new ilTestRandomQuestionSetSourcePoolDefinitionFactory(
                $this->db,
                $test_obj
            )
        );

        $src_pool_def_list->loadDefinitions();

        foreach ($src_pool_def_list as $definition) {
            $mapped_taxonomy_filter = $definition->getMappedTaxonomyFilter();
            if ($mapped_taxonomy_filter === []) {
                continue;
            }

            $definition->setMappedTaxonomyFilter(
                $this->getNewMappedTaxonomyFilter(
                    $mapping,
                    $mapped_taxonomy_filter
                )
            );
            $definition->saveToDb();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNewMappedTaxonomyFilter()

ilTestImporter::getNewMappedTaxonomyFilter ( ilImportMapping  $mapping, array  $mapped_filter  )

protected

Definition at line 248 of file class.ilTestImporter.php.

References ilImportMapping\getMapping().

Referenced by finalRandomTestTaxonomyProcessing().

     : array {
        $new_mapped_filter = [];
        foreach ($mapped_filter as $tax_id => $tax_nodes) {
            $new_tax_id = $mapping->getMapping(
                'components/ILIAS/Taxonomy',
                'tax',
                (string) $tax_id
            );

            if ($new_tax_id === null) {
                continue;
            }

            $new_mapped_filter[$new_tax_id] = [];

            foreach ($tax_nodes as $tax_node_id) {
                $new_tax_node_id = $mapping->getMapping(
                    'components/ILIAS/Taxonomy',
                    'tax_tree',
                    (string) $tax_node_id
                );

                if ($new_tax_node_id === null) {
                    continue;
                }

                $new_mapped_filter[$new_tax_id][] = $new_tax_node_id;
            }
        }

        return $new_mapped_filter;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importQuestionSkillAssignments()

ilTestImporter::importQuestionSkillAssignments ( ilImportMapping  $mapping, ilObjTest  $test_obj, ?string  $xml_file  )

protected

Definition at line 296 of file class.ilTestImporter.php.

References ilObject\getId(), ilXmlImporter\getInstallId(), ilObject\getObjectProperties(), and ilAssQuestionSkillAssignmentImportFails\registerFailedImports().

Referenced by importXmlRepresentation().

     : ilAssQuestionSkillAssignmentList {
        $parser = new ilAssQuestionSkillAssignmentXmlParser($xml_file);
        $parser->startParsing();

        $importer = new ilAssQuestionSkillAssignmentImporter();
        $importer->setTargetParentObjId($test_obj->getId());
        $importer->setImportInstallationId((int) $this->getInstallId());
        $importer->setImportMappingRegistry($mapping);
        $importer->setImportMappingComponent('components/ILIAS/Test');
        $importer->setImportAssignmentList($parser->getAssignmentList());

        $importer->import();

        if ($importer->getFailedImportAssignmentList()->assignmentsExist()) {
            $qsaImportFails = new ilAssQuestionSkillAssignmentImportFails($test_obj->getId());
            $qsaImportFails->registerFailedImports($importer->getFailedImportAssignmentList());

            $test_obj->getObjectProperties()->storePropertyIsOnline(
                $test_obj->getObjectProperties()->getPropertyIsOnline()->withOffline()
            );
        }

        return $importer->getSuccessImportAssignmentList();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importRandomQuestionSetConfig()

ilTestImporter::importRandomQuestionSetConfig	(	ilObjTest	$test_obj,
		?string	$xml_file,
		\ilImportMapping	$a_mapping
	)

Definition at line 284 of file class.ilTestImporter.php.

Referenced by importXmlRepresentation().

     : void {
        $test_obj->questions = [];
        $parser = new ilObjTestXMLParser($xml_file);
        $parser->setTestOBJ($test_obj);
        $parser->setImportMapping($a_mapping);
        $parser->startParsing();
    }

Here is the caller graph for this function:

importSkillLevelThresholds()

ilTestImporter::importSkillLevelThresholds ( ilImportMapping  $mapping, ilAssQuestionSkillAssignmentList  $assignment_list, ilObjTest  $test_obj, ?string  $xml_file  )

protected

Definition at line 325 of file class.ilTestImporter.php.

References ilObject\getId(), ilXmlImporter\getInstallId(), ilObjTest\getTestId(), ilTestSkillLevelThresholdImportFails\registerFailedImports(), and ilObject\setOfflineStatus().

Referenced by importXmlRepresentation().

     : void {
        $parser = new ilTestSkillLevelThresholdXmlParser($xml_file);
        $parser->initSkillLevelThresholdImportList();
        $parser->startParsing();

        $importer = new ilTestSkillLevelThresholdImporter($this->db);
        $importer->setTargetTestId($test_obj->getTestId());
        $importer->setImportInstallationId((int) $this->getInstallId());
        $importer->setImportMappingRegistry($mapping);
        $importer->setImportedQuestionSkillAssignmentList($assignment_list);
        $importer->setImportThresholdList($parser->getSkillLevelThresholdImportList());
        $importer->import();

        if ($importer->getFailedThresholdImportSkillList()->skillsExist()) {
            $sltImportFails = new ilTestSkillLevelThresholdImportFails($test_obj->getId());
            $sltImportFails->registerFailedImports($importer->getFailedThresholdImportSkillList());

            $test_obj->setOfflineStatus(true);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importXmlRepresentation()

ilTestImporter::importXmlRepresentation	(	string	$a_entity,
		string	$a_id,
		string	$a_xml,
		ilImportMapping	$a_mapping
	)

Definition at line 55 of file class.ilTestImporter.php.

References $results, ilImportMapping\addMapping(), addTaxonomyAndQuestionsMapping(), ILIAS\TestQuestionPool\Import\buildImportDirectoriesFromContainerImport(), ILIAS\TestQuestionPool\Import\buildImportDirectoriesFromImportFile(), ILIAS\TestQuestionPool\Import\buildResultsFilePath(), ilSession\clear(), ilSession\get(), ilImportMapping\getAllMappings(), ilXmlImporter\getImportDirectory(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), ilImportMapping\getMappingsOfEntity(), ilQTIParser\IL_MO_PARSE_QTI, importQuestionSkillAssignments(), importRandomQuestionSetConfig(), importSkillLevelThresholds(), ILIAS\Repository\int(), ILIAS\Repository\logger(), ilSession\set(), and ilQTIParser\setTestObject().

     : void {
        $results_file_path = null;
        if ($new_id = (int) $a_mapping->getMapping('components/ILIAS/Container', 'objs', $a_id)) {
            // container content
            $new_obj = ilObjectFactory::getInstanceByObjId((int) $new_id, false);
            $new_obj->saveToDb();

            ilSession::set('path_to_container_import_file', $this->getImportDirectory());
            [$importdir, $xmlfile, $qtifile] = $this->buildImportDirectoriesFromContainerImport(
                $this->getImportDirectory()
            );
            $selected_questions = [];
        } else {
            // single object
            $new_id = (int) $a_mapping->getMapping('components/ILIAS/Test', 'tst', 'new_id');
            $new_obj = ilObjectFactory::getInstanceByObjId($new_id, false);

            $selected_questions = ilSession::get('tst_import_selected_questions') ?? [];
            [$subdir, $importdir, $xmlfile, $qtifile] = $this->buildImportDirectoriesFromImportFile(
                ilSession::get('path_to_import_file')
            );
            $results_file_path = $this->buildResultsFilePath($importdir, $subdir);
            ilSession::clear('tst_import_selected_questions');
        }

        $new_obj->loadFromDb();

        if (!file_exists($xmlfile)) {
            $this->logger->error(__METHOD__ . ': Cannot find xml definition: ' . $xmlfile);
            return;
        }
        if (!file_exists($qtifile)) {
            $this->logger->error(__METHOD__ . ': Cannot find xml definition: ' . $qtifile);
            return;
        }

        // start parsing of QTI files
        $qti_parser = new ilQTIParser(
            $importdir,
            $qtifile,
            ilQTIParser::IL_MO_PARSE_QTI,
            $new_obj->getId(),
            $selected_questions,
            $a_mapping->getAllMappings()
        );
        $qti_parser->setTestObject($new_obj);
        $qti_parser->startParsing();
        $new_obj = $qti_parser->getTestObject();

        // import page data
        $question_page_parser = new ilQuestionPageParser(
            $new_obj,
            $xmlfile,
            $importdir
        );
        $question_page_parser->setQuestionMapping($qti_parser->getImportMapping());
        $question_page_parser->startParsing();

        $a_mapping = $this->addTaxonomyAndQuestionsMapping($qti_parser->getQuestionIdMapping(), $new_obj->getId(), $a_mapping);

        if ($new_obj->isRandomTest()) {
            $this->importRandomQuestionSetConfig($new_obj, $xmlfile, $a_mapping);
        }

        if ($results_file_path !== null && file_exists($results_file_path)) {
            $results = new ilTestResultsImportParser($results_file_path, $new_obj, $this->db, $this->logger, $this->irss);
            $results->setQuestionIdMapping($a_mapping->getMappingsOfEntity('components/ILIAS/Test', 'quest'));
            $results->setSrcPoolDefIdMapping($a_mapping->getMappingsOfEntity('components/ILIAS/Test', 'rnd_src_pool_def'));
            $results->startParsing();
        }

        $new_obj->saveToDb(); // this creates test_fi
        $new_obj->update(); // this saves ilObject data

        $this->importSkillLevelThresholds(
            $a_mapping,
            $this->importQuestionSkillAssignments($a_mapping, $new_obj, $xmlfile),
            $new_obj,
            $xmlfile
        );

        $a_mapping->addMapping("components/ILIAS/Test", "tst", (string) $a_id, (string) $new_obj->getId());
        $a_mapping->addMapping(
            "components/ILIAS/MetaData",
            "md",
            $a_id . ":0:tst",
            $new_obj->getId() . ":0:tst"
        );
    }

Here is the call graph for this function:

Field Documentation

$db

readonly ilDBInterface ilTestImporter::$db

private

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

$finallyProcessedTestsRegistry

ilTestImporter::$finallyProcessedTestsRegistry = []

static

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

$irss

readonly ResourceStorage ilTestImporter::$irss

private

Definition at line 43 of file class.ilTestImporter.php.

$logger

readonly TestLogger ilTestImporter::$logger

private

Definition at line 41 of file class.ilTestImporter.php.

---

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

• components/ILIAS/Test/classes/class.ilTestImporter.php