Importer class for files. More...

Inheritance diagram for ilLearningModuleImporter:

Collaboration diagram for ilLearningModuleImporter:

Public Member Functions
	init ()

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

	finalProcessing (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)

Protected Attributes
ReadingTimeManager	$reading_time_manager

array	$qtis

ilLearningModuleDataSet	$ds

ilImportConfig	$config

ilLogger	$log

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

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

Member Function Documentation

◆ finalProcessing()

ilLearningModuleImporter::finalProcessing ( ilImportMapping $a_mapping )

Definition at line 118 of file class.ilLearningModuleImporter.php.

References $id, ILIAS\LTI\ToolProvider\$updated, ilPageObject\_exists(), ilLMObject\_lookupContObjID(), ilPageObject\_writeParentId(), ilLMMenuEditor\fixImportMenuItems(), ilPageObjectFactory\getInstance(), ilImportMapping\getMapping(), ilImportMapping\getMappingsOfEntity(), ILIAS\Repository\int(), ilObjContentObject\writeFooterPage(), and ilObjContentObject\writeHeaderPage().

                                                                : void
     {
         $pg_map = $a_mapping->getMappingsOfEntity("Modules/LearningModule", "pg");
 
         $this->log->debug("pg map entries: " . count($pg_map));
         foreach ($pg_map as $pg_id) {
             $lm_id = ilLMPageObject::_lookupContObjID($pg_id);
             ilLMPage::_writeParentId("lm", $pg_id, $lm_id);
             $this->log->debug("write parent id, pg id: " . $pg_id . ", lm id: " . $lm_id);
         }
 
         // header footer page
         foreach ($a_mapping->getMappingsOfEntity("Modules/LearningModule", "lm_header_page") as $old_id => $dummy) {
             $new_page_id = (int) $a_mapping->getMapping("Modules/LearningModule", "pg", $old_id);
             if ($new_page_id > 0) {
                 $lm_id = ilLMPageObject::_lookupContObjID($new_page_id);
                 ilObjLearningModule::writeHeaderPage($lm_id, $new_page_id);
             }
         }
         foreach ($a_mapping->getMappingsOfEntity("Modules/LearningModule", "lm_footer_page") as $old_id => $dummy) {
             $new_page_id = (int) $a_mapping->getMapping("Modules/LearningModule", "pg", $old_id);
             if ($new_page_id > 0) {
                 $lm_id = ilLMPageObject::_lookupContObjID($new_page_id);
                 ilObjLearningModule::writeFooterPage($lm_id, $new_page_id);
             }
         }
 
 
         $link_map = $a_mapping->getMappingsOfEntity("Modules/LearningModule", "link");
         $pages = $a_mapping->getMappingsOfEntity("Services/COPage", "pgl");
         foreach ($pages as $p) {
             $id = explode(":", $p);
             if (count($id) == 3) {
                 if (ilPageObject::_exists($id[0], $id[1], $id[2], true)) {
                     $new_page = ilPageObjectFactory::getInstance($id[0], $id[1], 0, $id[2]);
                     $new_page->buildDom();
 
                     // fix question references
                     $updated = $new_page->resolveQuestionReferences($this->qtis);
 
                     // in translation mode use link mapping to fix internal links
                     //$a_mapping->addMapping("Modules/LearningModule", "link",
                     if ($this->config->getTranslationImportMode()) {
                         $il = $new_page->resolveIntLinks($link_map);
                         if ($il) {
                             $updated = true;
                         }
                     }
 
                     if ($updated) {
                         $new_page->update(false, true);
                     }
                 }
             }
         }
 
         // assign style
         /*
         $alls_map = $a_mapping->getMappingsOfEntity("Modules/LearningModule", "lm_style");
         foreach ($alls_map as $new_lm_id => $old_style_id) {
             $new_style_id = (int) $a_mapping->getMapping("Services/Style", "sty", $old_style_id);
             if ($new_lm_id > 0 && $new_style_id > 0) {
                 $lm = new ilObjLearningModule($new_lm_id, false);
                 $lm->writeStyleSheetId($new_style_id);
             }
         }*/
 
         // menu item ref ids
         $ref_mapping = $a_mapping->getMappingsOfEntity('Services/Container', 'refs');
         $lm_map = $a_mapping->getMappingsOfEntity("Modules/LearningModule", "lm");
         foreach ($lm_map as $old_lm_id => $new_lm_id) {
             ilLMMenuEditor::fixImportMenuItems($new_lm_id, $ref_mapping);
         }
 
         // typical reading time
         $lm_map = $a_mapping->getMappingsOfEntity("Modules/LearningModule", "lm");
         foreach ($lm_map as $old_lm_id => $new_lm_id) {
             $this->reading_time_manager->updateReadingTime($new_lm_id);
         }
     }

Here is the call graph for this function:

◆ importXmlRepresentation()

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

Definition at line 59 of file class.ilLearningModuleImporter.php.

References ilXmlImporter\getImportDirectory(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), ilXmlImporter\getSchemaVersion(), ilQTIParser\IL_MO_PARSE_QTI, and ilQTIParser\IL_MO_VERIFY_QTI.

      : void {
         $this->log->debug("import XML Representation");
 
         // case i container
         if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_id)) {
             $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
             $newObj->createLMTree();
             $this->log->debug("got mapping, new id is: " . $new_id);
         }
 
         // in the new version (5.1)  we are also here, but the following file should not exist
         // if being exported with 5.1 or higher
         $xml_file = $this->getImportDirectory() . '/' . basename($this->getImportDirectory()) . '.xml';
 
         // old school import
         // currently this means we got a container and mapping, too, since
         // for single lms the processing in ilObjContentObjectGUI->importFileObject is used
         // (this should be streamlined, see glossary)
         if (file_exists($xml_file)) {
             throw new ilLMOldExportFileException("This file seems to be from ILIAS version 5.0.x or lower. Import is not supported anymore.");
         } else {        // new import version (does mapping, too)
             $this->log->debug("create ilDataSetIportParser instance");
             $parser = new ilDataSetImportParser(
                 $a_entity,
                 $this->getSchemaVersion(),
                 $a_xml,
                 $this->ds,
                 $a_mapping
             );
         }
 
         // import qti stuff
         $this->log->debug("import qti data");
         $qti_file = $this->getImportDirectory() . '/qti.xml';
         $this->qtis = array();
         if (is_file($qti_file)) {
             $qtiParser = new ilQTIParser(
                 $qti_file,
                 ilQTIParser::IL_MO_VERIFY_QTI,
                 0,
                 ""
             );
             $result = $qtiParser->startParsing();
             $founditems = &$qtiParser->getFoundItems();
             $testObj = new ilObjTest(0, true);
             if (count($founditems) > 0) {
                 $qtiParser = new ilQTIParser($qti_file, ilQTIParser::IL_MO_PARSE_QTI, 0, "");
                 $qtiParser->setTestObject($testObj);
                 $result = $qtiParser->startParsing();
                 $this->qtis = array_merge($this->qtis, $qtiParser->getImportMapping());
             }
         }
     }

Here is the call graph for this function:

◆ init()

ilLearningModuleImporter::init ( )

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

References ilXmlImporter\getImport(), and ilLoggerFactory\getLogger().

                           : void
     {
         $this->ds = new ilLearningModuleDataSet();
         $this->ds->setDSPrefix("ds");
 
         $this->log = ilLoggerFactory::getLogger('lm');
 
         $this->config = $this->getImport()->getConfig("Modules/LearningModule");
         if ($this->config->getTranslationImportMode()) {
             $this->ds->setTranslationImportMode(
                 $this->config->getTranslationLM(),
                 $this->config->getTranslationLang()
             );
             $cop_config = $this->getImport()->getConfig("Services/COPage");
             $cop_config->setUpdateIfExists(true);
             $cop_config->setForceLanguage($this->config->getTranslationLang());
             $cop_config->setReuseOriginallyExportedMedia(true);
             $cop_config->setSkipInternalLinkResolve(true);
 
             $mob_config = $this->getImport()->getConfig("Services/MediaObjects");
             $mob_config->setUsePreviousImportIds(true);
         }
         $this->reading_time_manager = new ReadingTimeManager();
     }