ilTestImporter Class Reference

Importer class for files. More...

Inheritance diagram for ilTestImporter:

Collaboration diagram for ilTestImporter:

Public Member Functions
	importXmlRepresentation ($a_entity, $a_id, $a_xml, $a_mapping)
	Import XML. More...
	finalProcessing ($a_mapping)
	Final processing. More...
Public Member Functions inherited from ilXmlImporter
	__construct ()
	Constructor. More...
	setImport ($a_val)
	Set import. More...
	getImport ()
	Get import. More...
	init ()
	Init. More...
	setInstallId ($a_val)
	Set installation id. More...
	getInstallId ()
	Get installation id. More...
	setInstallUrl ($a_val)
	Set installation url. More...
	getInstallUrl ()
	Get installation url. More...
	setSchemaVersion ($a_val)
	Set schema version. More...
	getSchemaVersion ()
	Get schema version. More...
	setImportDirectory ($a_val)
	Set import directory. More...
	getImportDirectory ()
	Get import directory. More...
	setSkipEntities ($a_val)
	Set skip entities. More...
	getSkipEntities ()
	Get skip entities. More...
	exportedFromSameInstallation ()
	Is exporting and importing installation identical? More...
	importXmlRepresentation ($a_entity, $a_id, $a_xml, $a_mapping)
	Import xml representation. More...
	finalProcessing ($a_mapping)
	Final processing. More...
	afterContainerImportProcessing (ilImportMapping $mapping)
	Called after all container objects have been implemented. More...

Static Public Attributes
static	$finallyProcessedTestsRegistry = array()

Protected Member Functions
	finalRandomTestTaxonomyProcessing (ilImportMapping $mapping, $oldTstObjId, $newTstObjId, ilObjTest $testOBJ)
	getNewMappedTaxonomyFilter (ilImportMapping $mapping, array $mappedFilter)
	parseXmlFileNames ()
	Create qti and xml file name. More...
	importRandomQuestionSetConfig (ilObjTest $testOBJ, $xmlFile, $a_mapping)
	importQuestionSkillAssignments (ilImportMapping $mapping, ilObjTest $testOBJ, $xmlFile)
	importSkillLevelThresholds (ilImportMapping $mapping, ilAssQuestionSkillAssignmentList $assignmentList, ilObjTest $testOBJ, $xmlFile)

Private Member Functions
	getImportDirectoryContainer ()
	getImportPackageName ()

Additional Inherited Members
Protected Attributes inherited from ilXmlImporter
	$skip_entities = array()
	$imp

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 13 of file class.ilTestImporter.php.

Member Function Documentation

finalProcessing()

ilTestImporter::finalProcessing

(

$a_mapping

)

Final processing.

Parameters

ilImportMapping

$a_mapping

Returns

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

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

    {
        $maps = $a_mapping->getMappingsOfEntity("Modules/Test", "tst");
        
        foreach ($maps as $old => $new) {
            if ($old == "new_id" || (int) $old <= 0) {
                continue;
            }
            
            if (isset(self::$finallyProcessedTestsRegistry[$new])) {
                continue;
            }

            /* @var ilObjTest $testOBJ */
            $testOBJ = ilObjectFactory::getInstanceByObjId($new, false);
            if ($testOBJ->isRandomTest()) {
                $this->finalRandomTestTaxonomyProcessing($a_mapping, $old, $new, $testOBJ);
            }
            
            self::$finallyProcessedTestsRegistry[$new] = true;
        }
    }

Here is the call graph for this function:

finalRandomTestTaxonomyProcessing()

ilTestImporter::finalRandomTestTaxonomyProcessing ( ilImportMapping  $mapping,   $oldTstObjId,   $newTstObjId, ilObjTest  $testOBJ  )

protected

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

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

Referenced by finalProcessing().

    {
        require_once 'Services/Taxonomy/classes/class.ilObjTaxonomy.php';
        
        // get all new taxonomies of this object and store usage for test object
        
        $new_tax_ids = $mapping->getMapping(
            'Services/Taxonomy',
            'tax_usage_of_obj',
            $oldTstObjId
        );
        
        if ($new_tax_ids !== false) {
            $tax_ids = explode(":", $new_tax_ids);
            
            foreach ($tax_ids as $tid) {
                ilObjTaxonomy::saveUsage($tid, $newTstObjId);
            }
        }

        // update all source pool definition's tax/taxNode ids with new mapped id
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        $ilDB = $DIC['ilDB'];

        require_once 'Modules/Test/classes/class.ilTestRandomQuestionSetSourcePoolDefinitionFactory.php';
        $srcPoolDefFactory = new ilTestRandomQuestionSetSourcePoolDefinitionFactory(
            $ilDB,
            $testOBJ
        );

        require_once 'Modules/Test/classes/class.ilTestRandomQuestionSetSourcePoolDefinitionList.php';
        $srcPoolDefList = new ilTestRandomQuestionSetSourcePoolDefinitionList(
            $ilDB,
            $testOBJ,
            $srcPoolDefFactory
        );

        $srcPoolDefList->loadDefinitions();

        foreach ($srcPoolDefList as $definition) {
            // #21330
            if (!is_array($definition->getMappedTaxonomyFilter()) || 0 === count($definition->getMappedTaxonomyFilter())) {
                continue;
            }

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

Here is the call graph for this function:

Here is the caller graph for this function:

getImportDirectoryContainer()

ilTestImporter::getImportDirectoryContainer ( )

private

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

References ilXmlImporter\getImportDirectory().

Referenced by importXmlRepresentation().

    {
        $dir = $this->getImportDirectory();
        $dir = dirname($dir);
        return $dir;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getImportPackageName()

ilTestImporter::getImportPackageName ( )

private

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

References $name, and ilXmlImporter\getImportDirectory().

Referenced by importXmlRepresentation().

    {
        $dir = $this->getImportDirectory();
        $name = basename($dir);
        return $name;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNewMappedTaxonomyFilter()

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

protected

Parameters

ilImportMapping	$mapping
array	$mappedFilter

Returns

array

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

References ilImportMapping\getMapping().

Referenced by finalRandomTestTaxonomyProcessing().

    {
        $newMappedFilter = array();

        foreach ($mappedFilter as $taxId => $taxNodes) {
            $newTaxId = $mapping->getMapping(
                'Services/Taxonomy',
                'tax',
                $taxId
            );

            if (!$newTaxId) {
                continue;
            }

            $newMappedFilter[$newTaxId] = array();

            foreach ($taxNodes as $taxNodeId) {
                $newTaxNodeId = $mapping->getMapping(
                    'Services/Taxonomy',
                    'tax_tree',
                    $taxNodeId
                );

                if (!$newTaxNodeId) {
                    continue;
                }

                $newMappedFilter[$newTaxId][] = $newTaxNodeId;
            }
        }

        return $newMappedFilter;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importQuestionSkillAssignments()

ilTestImporter::importQuestionSkillAssignments ( ilImportMapping  $mapping, ilObjTest  $testOBJ,   $xmlFile  )

protected

Parameters

ilImportMapping	$mappingRegistry
ilObjTest	$testOBJ
string	$xmlfile

Returns

ilAssQuestionSkillAssignmentList

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

References $parser, ilObject\getId(), ilXmlImporter\getInstallId(), ilAssQuestionSkillAssignmentImportFails\registerFailedImports(), and ilObjTest\setOnline().

Referenced by importXmlRepresentation().

    {
        require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssQuestionSkillAssignmentXmlParser.php';
        $parser = new ilAssQuestionSkillAssignmentXmlParser($xmlFile);
        $parser->startParsing();
        
        require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssQuestionSkillAssignmentImporter.php';
        $importer = new ilAssQuestionSkillAssignmentImporter();
        $importer->setTargetParentObjId($testOBJ->getId());
        $importer->setImportInstallationId($this->getInstallId());
        $importer->setImportMappingRegistry($mapping);
        $importer->setImportMappingComponent('Modules/Test');
        $importer->setImportAssignmentList($parser->getAssignmentList());
        
        $importer->import();
        
        if ($importer->getFailedImportAssignmentList()->assignmentsExist()) {
            require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssQuestionSkillAssignmentImportFails.php';
            $qsaImportFails = new ilAssQuestionSkillAssignmentImportFails($testOBJ->getId());
            $qsaImportFails->registerFailedImports($importer->getFailedImportAssignmentList());
            
            $testOBJ->setOnline(false);
        }
        
        return $importer->getSuccessImportAssignmentList();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importRandomQuestionSetConfig()

ilTestImporter::importRandomQuestionSetConfig ( ilObjTest  $testOBJ,   $xmlFile,   $a_mapping  )

protected

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

References $parser.

Referenced by importXmlRepresentation().

    {
        require_once 'Modules/Test/classes/class.ilObjTestXMLParser.php';
        $parser = new ilObjTestXMLParser($xmlFile);
        $parser->setTestOBJ($testOBJ);
        $parser->setImportMapping($a_mapping);
        $parser->startParsing();
    }

Here is the caller graph for this function:

importSkillLevelThresholds()

ilTestImporter::importSkillLevelThresholds ( ilImportMapping  $mapping, ilAssQuestionSkillAssignmentList  $assignmentList, ilObjTest  $testOBJ,   $xmlFile  )

protected

Parameters

ilImportMapping	$mapping
ilAssQuestionSkillAssignmentList	$assignmentList
ilObjTest	$testOBJ
	$xmlFile

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

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

Referenced by importXmlRepresentation().

    {
        require_once 'Modules/Test/classes/class.ilTestSkillLevelThresholdXmlParser.php';
        $parser = new ilTestSkillLevelThresholdXmlParser($xmlFile);
        $parser->startParsing();
        
        require_once 'Modules/Test/classes/class.ilTestSkillLevelThresholdImporter.php';
        $importer = new ilTestSkillLevelThresholdImporter();
        $importer->setTargetTestId($testOBJ->getTestId());
        $importer->setImportInstallationId($this->getInstallId());
        $importer->setImportMappingRegistry($mapping);
        $importer->setImportedQuestionSkillAssignmentList($assignmentList);
        $importer->setImportThresholdList($parser->getSkillLevelThresholdImportList());
        $importer->import();
        
        if ($importer->getFailedThresholdImportSkillList()->skillsExist()) {
            require_once 'Modules/Test/classes/class.ilTestSkillLevelThresholdImportFails.php';
            $sltImportFails = new ilTestSkillLevelThresholdImportFails($testOBJ->getId());
            $sltImportFails->registerFailedImports($importer->getFailedThresholdImportSkillList());

            $testOBJ->setOfflineStatus(true);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importXmlRepresentation()

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

Import XML.

Parameters

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

References $_SESSION, $DIC, $result, $results, ilObjTest\_setImportDirectory(), ilXmlImporter\getImportDirectory(), getImportDirectoryContainer(), getImportPackageName(), ilObjectFactory\getInstanceByObjId(), IL_MO_PARSE_QTI, importQuestionSkillAssignments(), importRandomQuestionSetConfig(), importSkillLevelThresholds(), and parseXmlFileNames().

    {
        // Container import => test object already created
        include_once "./Modules/Test/classes/class.ilObjTest.php";
        ilObjTest::_setImportDirectory($this->getImportDirectoryContainer());

        if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_id)) {
            // container content
            $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
            $_SESSION['tst_import_subdir'] = $this->getImportPackageName();
            $newObj->saveToDb(); // this generates test id first time
            $questionParentObjId = $newObj->getId();
            $newObj->setOfflineStatus(false);
            $questionParentObjId = $newObj->getId();
        } else {
            // single object
            $new_id = $a_mapping->getMapping('Modules/Test', 'tst', 'new_id');
            $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
            
            if (isset($_SESSION['tst_import_qst_parent'])) {
                $questionParentObjId = $_SESSION['tst_import_qst_parent'];
            } else {
                $questionParentObjId = $newObj->getId();
            }
        }

        $newObj->loadFromDb();

        list($xml_file, $qti_file) = $this->parseXmlFileNames();
        
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        if (!@file_exists($xml_file)) {
            $DIC['ilLog']->write(__METHOD__ . ': Cannot find xml definition: ' . $xml_file);
            return false;
        }
        if (!@file_exists($qti_file)) {
            $DIC['ilLog']->write(__METHOD__ . ': Cannot find xml definition: ' . $qti_file);
            return false;
        }
        
        /* @var ilObjTest $newObj */
        
        // FIXME: Copied from ilObjTestGUI::importVerifiedFileObject
        // TODO: move all logic to ilObjTest::importVerifiedFile and call
        // this method from ilObjTestGUI and ilTestImporter
        $newObj->mark_schema->flush();
        

        if (isset($_SESSION['tst_import_idents'])) {
            $idents = $_SESSION['tst_import_idents'];
        } else {
            $idents = null;
        }

        // start parsing of QTI files
        include_once "./Services/QTI/classes/class.ilQTIParser.php";
        $qtiParser = new ilQTIParser($qti_file, IL_MO_PARSE_QTI, $questionParentObjId, $idents);
        $qtiParser->setTestObject($newObj);
        $result = $qtiParser->startParsing();

        // import page data
        include_once("./Modules/LearningModule/classes/class.ilContObjParser.php");
        $contParser = new ilContObjParser($newObj, $xml_file, basename($this->getImportDirectory()));
        $contParser->setQuestionMapping($qtiParser->getImportMapping());
        $contParser->startParsing();

        foreach ($qtiParser->getQuestionIdMapping() as $oldQuestionId => $newQuestionId) {
            $a_mapping->addMapping(
                "Services/Taxonomy",
                "tax_item",
                "tst:quest:$oldQuestionId",
                $newQuestionId
            );

            $a_mapping->addMapping(
                "Services/Taxonomy",
                "tax_item_obj_id",
                "tst:quest:$oldQuestionId",
                $newObj->getId()
            );

            $a_mapping->addMapping(
                "Modules/Test",
                "quest",
                $oldQuestionId,
                $newQuestionId
            );
        }
        
        if ($newObj->isRandomTest()) {
            $newObj->questions = array();
            $this->importRandomQuestionSetConfig($newObj, $xml_file, $a_mapping);
        }

        // import test results
        if (@file_exists($_SESSION["tst_import_results_file"])) {
            include_once("./Modules/Test/classes/class.ilTestResultsImportParser.php");
            $results = new ilTestResultsImportParser($_SESSION["tst_import_results_file"], $newObj);
            $results->setQuestionIdMapping($a_mapping->getMappingsOfEntity('Modules/Test', 'quest'));
            $results->setSrcPoolDefIdMapping($a_mapping->getMappingsOfEntity('Modules/Test', 'rnd_src_pool_def'));
            $results->startParsing();
        }
        
        $newObj->saveToDb(); // this creates test_fi
        $newObj->update(); // this saves ilObject data
        
        // import skill assignments
        $importedAssignmentList = $this->importQuestionSkillAssignments($a_mapping, $newObj, $xml_file);
        $this->importSkillLevelThresholds($a_mapping, $importedAssignmentList, $newObj, $xml_file);
            
        $a_mapping->addMapping("Modules/Test", "tst", $a_id, $newObj->getId());

        ilObjTest::_setImportDirectory();
    }

Here is the call graph for this function:

parseXmlFileNames()

ilTestImporter::parseXmlFileNames ( )

protected

Create qti and xml file name.

Returns

array

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

References $DIC, $xml, and ilXmlImporter\getImportDirectory().

Referenced by importXmlRepresentation().

    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        $DIC['ilLog']->write(__METHOD__ . ': ' . $this->getImportDirectory());
        
        $basename = basename($this->getImportDirectory());

        $xml = $this->getImportDirectory() . '/' . $basename . '.xml';
        $qti = $this->getImportDirectory() . '/' . preg_replace('/test|tst/', 'qti', $basename) . '.xml';
        
        return array($xml,$qti);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$finallyProcessedTestsRegistry

ilTestImporter::$finallyProcessedTestsRegistry = array()

static

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

---

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

• Modules/Test/classes/class.ilTestImporter.php