Importer class for question pools. More...

Inheritance diagram for ilTestQuestionPoolImporter:

Collaboration diagram for ilTestQuestionPoolImporter:

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

Protected Member Functions
	parseXmlFileNames ()
	Create qti and xml file name. More...

	importQuestionSkillAssignments ($xmlFile, ilImportMapping $mappingRegistry, $targetParentObjId)

Private Member Functions
	getImportDirectoryContainer ()

	getImportPackageName ()

Private Attributes
	$poolOBJ

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

	$imp

Detailed Description

Importer class for question pools.

Author: Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Version: $Id$

Definition at line 14 of file class.ilTestQuestionPoolImporter.php.

Member Function Documentation

◆ finalProcessing()

ilTestQuestionPoolImporter::finalProcessing ( $a_mapping )

Final processing.

Parameters

ilImportMapping $a_mapping

Returns

Reimplemented from ilXmlImporter.

Definition at line 145 of file class.ilTestQuestionPoolImporter.php.

    {
        //echo "<pre>".print_r($a_mapping, true)."</pre>"; exit;
        // get all glossaries of the import
        include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
        $maps = $a_mapping->getMappingsOfEntity("Modules/TestQuestionPool", "qpl");
        foreach ($maps as $old => $new) {
            if ($old != "new_id" && (int) $old > 0) {
                // get all new taxonomys of this object
                $new_tax_ids = $a_mapping->getMapping("Services/Taxonomy", "tax_usage_of_obj", $old);
                if ($new_tax_ids !== false) {
                    $tax_ids = explode(":", $new_tax_ids);
                    foreach ($tax_ids as $tid) {
                        ilObjTaxonomy::saveUsage($tid, $new);
                    }
                }
                
                $taxMappings = $a_mapping->getMappingsOfEntity('Services/Taxonomy', 'tax');
                foreach ($taxMappings as $oldTaxId => $newTaxId) {
                    if ($oldTaxId == $this->poolOBJ->getNavTaxonomyId()) {
                        $this->poolOBJ->setNavTaxonomyId($newTaxId);
                        $this->poolOBJ->saveToDb();
                        break;
                    }
                }
            }
        }
    }

References ilObjTaxonomy\saveUsage().

Here is the call graph for this function:

◆ getImportDirectoryContainer()

ilTestQuestionPoolImporter::getImportDirectoryContainer ( )

private

Definition at line 191 of file class.ilTestQuestionPoolImporter.php.

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

References ilXmlImporter\getImportDirectory().

Referenced by importXmlRepresentation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImportPackageName()

ilTestQuestionPoolImporter::getImportPackageName ( )

private

Definition at line 198 of file class.ilTestQuestionPoolImporter.php.

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

References $name, and ilXmlImporter\getImportDirectory().

Referenced by importXmlRepresentation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importQuestionSkillAssignments()

ilTestQuestionPoolImporter::importQuestionSkillAssignments	(		$xmlFile,
		ilImportMapping	$mappingRegistry,
			$targetParentObjId
	)

protected

Definition at line 205 of file class.ilTestQuestionPoolImporter.php.

    {
        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($targetParentObjId);
        $importer->setImportInstallationId($this->getInstallId());
        $importer->setImportMappingRegistry($mappingRegistry);
        $importer->setImportMappingComponent('Modules/TestQuestionPool');
        $importer->setImportAssignmentList($parser->getAssignmentList());
        
        $importer->import();
        
        if ($importer->getFailedImportAssignmentList()->assignmentsExist()) {
            require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssQuestionSkillAssignmentImportFails.php';
            $qsaImportFails = new ilAssQuestionSkillAssignmentImportFails($targetParentObjId);
            $qsaImportFails->registerFailedImports($importer->getFailedImportAssignmentList());
            
            $this->poolOBJ->setOnline(false);
        }
    }

References $parser, and ilXmlImporter\getInstallId().

Referenced by importXmlRepresentation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importXmlRepresentation()

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

Import XML.

Parameters

return

Reimplemented from ilXmlImporter.

Definition at line 27 of file class.ilTestQuestionPoolImporter.php.

    {
        /* @var ilObjQuestionPool $newObj */
        
        include_once "./Modules/TestQuestionPool/classes/class.ilObjQuestionPool.php";
        ilObjQuestionPool::_setImportDirectory($this->getImportDirectoryContainer());
        
        // Container import => pool object already created
        if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_id)) {
            $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
            $newObj->setOnline(true);
 
            $_SESSION['qpl_import_subdir'] = $this->getImportPackageName();
 
            $newObj->setOnline(true);
        } elseif ($new_id = $a_mapping->getMapping('Modules/TestQuestionPool', 'qpl', "new_id")) {
            $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
        } else {
            // Shouldn't happen
            global $DIC; /* @var ILIAS\DI\Container $DIC */
            $DIC['ilLog']->write(__METHOD__ . ': non container and no tax mapping, perhaps old qpl export');
            return false;
        }
 
        
 
        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 qti definition: ' . $qti_file);
            return false;
        }
        
        $this->poolOBJ = $newObj;
        
        $newObj->fromXML($xml_file);
 
        // set another question pool name (if possible)
        if (isset($_POST["qpl_new"]) && strlen($_POST["qpl_new"])) {
            $newObj->setTitle($_POST["qpl_new"]);
        }
        
        $newObj->update();
        $newObj->saveToDb();
 
        // FIXME: Copied from ilObjQuestionPoolGUI::importVerifiedFileObject
        // TODO: move all logic to ilObjQuestionPoolGUI::importVerifiedFile and call
        // this method from ilObjQuestionPoolGUI and ilTestImporter
        
        global $DIC; /* @var ILIAS\DI\Container $DIC */
        $DIC['ilLog']->write(__METHOD__ . ': xml file: ' . $xml_file . ", qti file:" . $qti_file);
        
        if (isset($_SESSION["qpl_import_idents"])) {
            $idents = $_SESSION["qpl_import_idents"];
            unset($_SESSION["qpl_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, $newObj->getId(), $idents);
        $result = $qtiParser->startParsing();
 
        // import page data
        if (strlen($xml_file)) {
            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->getImportMapping() as $k => $v) {
                $oldQuestionId = substr($k, strpos($k, 'qst_') + strlen('qst_'));
                $newQuestionId = $v['pool']; // yes, this is the new question id ^^
                
                $a_mapping->addMapping(
                    "Services/Taxonomy",
                    "tax_item",
                    "qpl:quest:$oldQuestionId",
                    $newQuestionId
                );
                
                $a_mapping->addMapping(
                    "Services/Taxonomy",
                    "tax_item_obj_id",
                    "qpl:quest:$oldQuestionId",
                    $newObj->getId()
                );
 
                $a_mapping->addMapping(
                    "Modules/TestQuestionPool",
                    "quest",
                    $oldQuestionId,
                    $newQuestionId
                );
            }
        }
        
        $this->importQuestionSkillAssignments($xml_file, $a_mapping, $newObj->getId());
 
        $a_mapping->addMapping("Modules/TestQuestionPool", "qpl", $a_id, $newObj->getId());
 
        ilObjQuestionPool::_setImportDirectory(null);
        
        $newObj->saveToDb();
    }

References $_POST, $_SESSION, $DIC, $result, ilObjQuestionPool\_setImportDirectory(), ilXmlImporter\getImportDirectory(), getImportDirectoryContainer(), getImportPackageName(), ilObjectFactory\getInstanceByObjId(), IL_MO_PARSE_QTI, importQuestionSkillAssignments(), and parseXmlFileNames().

Here is the call graph for this function:

◆ parseXmlFileNames()

ilTestQuestionPoolImporter::parseXmlFileNames ( )

protected

Create qti and xml file name.

Returns: array

Definition at line 178 of file class.ilTestQuestionPoolImporter.php.

    {
        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('/qpl/', 'qti', $basename) . '.xml';
        
        return array($xml,$qti);
    }