ilImport Class Reference

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

Inheritance diagram for ilImport:

Collaboration diagram for ilImport:

Public Member Functions
	__construct (int $a_target_id=0)
	getConfig (string $a_comp)
	Get configuration (note that configurations are optional, null may be returned!) More...
	getMapping ()
	setEntityTypes (array $a_val)
	getEntityTypes ()
	addSkipEntity (string $a_component, string $a_entity, bool $skip=true)
	Add skip entity. More...
	addSkipImporter (string $a_component, bool $skip=true)
	importEntity (string $a_tmp_file, string $a_filename, string $a_entity, string $a_component, bool $a_copy_file=false)
	Import entity. More...
	importObject (?object $a_new_obj, string $a_tmp_file, string $a_filename, string $a_type, string $a_comp="", bool $a_copy_file=false)
	importFromDirectory (string $dir, string $a_type, string $a_comp)
	getTemporaryImportDir ()
	Get temporary import directory. More...
	processItemXml (string $a_entity, string $a_schema_version, string $a_id, string $a_xml, string $a_install_id, string $a_install_url)
	Process item xml. More...

Protected Member Functions
	setTemporaryImportDir (string $a_val)
	Set temporary import directory. More...
	doImportObject (string $dir, string $a_type, string $a_component="", string $a_tmpdir="")
	Import repository object export file. More...

Protected Attributes
ilLogger	$log
ilObjectDefinition	$objDefinition
string	$install_id = ""
string	$install_url = ""
string	$entities = ""
string	$tmp_import_dir = ""
ilImportMapping	$mapping = null
array	$skip_entity = array()
array	$configs = array()
array	$skip_importer = []

Private Attributes
array	$entity_types = []
ilXmlImporter	$importer = null
string	$comp = ''
string	$current_comp = ''

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 Import class

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Definition at line 25 of file class.ilImport.php.

Constructor & Destructor Documentation

__construct()

ilImport::__construct

(

int

$a_target_id = 0

)

Reimplemented in ilImportContainer.

Definition at line 44 of file class.ilImport.php.

    {
        global $DIC;
 
        $this->objDefinition = $DIC['objDefinition'];
        $this->mapping = new ilImportMapping();
        $this->mapping->setTargetId($a_target_id);
        $this->log = $DIC->logger()->exp();
    }

References $DIC.

Member Function Documentation

addSkipEntity()

ilImport::addSkipEntity	(	string	$a_component,
		string	$a_entity,
		bool	$skip = true
	)

Add skip entity.

Definition at line 91 of file class.ilImport.php.

                                                                                           : void
    {
        $this->skip_entity[$a_component][$a_entity] = $skip;
    }

addSkipImporter()

ilImport::addSkipImporter	(	string	$a_component,
		bool	$skip = true
	)

Definition at line 96 of file class.ilImport.php.

                                                                           : void
    {
        $this->skip_importer[$a_component] = $skip;
    }

doImportObject()

ilImport::doImportObject ( string  $dir, string  $a_type, string  $a_component = "", string  $a_tmpdir = ""  )

protected

Import repository object export file.

Reimplemented in ilImportContainer.

Definition at line 177 of file class.ilImport.php.

     : array {
        if ($a_component == "") {
            $a_component = ilImportExportFactory::getComponentForExport($a_type);
        }
        $this->comp = $a_component;
 
        // get import class
        $success = true;
 
        // process manifest file
        if (!is_file($dir . "/manifest.xml")) {
            $mess = (DEVMODE)
                ? 'Manifest file not found: "' . $dir . "/manifest.xml" . '".'
                : 'Manifest file not found: "manifest.xml."';
            $e = new ilManifestFileNotFoundImportException($mess);
            $e->setManifestDir($dir);
            $e->setTmpDir($a_tmpdir);
            throw $e;
        }
        $parser = new ilManifestParser($dir . "/manifest.xml");
        $this->mapping->setInstallUrl($parser->getInstallUrl());
        $this->mapping->setInstallId($parser->getInstallId());
 
        // check for correct type
        if ($parser->getMainEntity() != $a_type) {
            throw new ilImportObjectTypeMismatchException(
                "Object type does not match. Import file has type '" .
                $parser->getMainEntity() . "' but import being processed for '" . $a_type . "'."
            );
        }
 
        // process export files
        $expfiles = $parser->getExportFiles();
 
        $all_importers = array();
        foreach ($expfiles as $expfile) {
            $comp = $expfile["component"];
 
            if (isset($this->skip_importer[$comp]) && $this->skip_importer[$comp] === true) {
                continue;
            }
 
            $class = ilImportExportFactory::getImporterClass($comp);
 
            // log a warning for inactive page component plugins, but continue import
            // page content will be imported, but not its additional data
            // (other plugins throw an exception in ilImportExportFactory)
            if ($class == '') {
                $this->log->warning("no class found for component: $comp");
                continue;
            }
 
            $this->log->debug("create new class = $class");
 
            $this->importer = new $class();
            $this->importer->setImport($this);
            $all_importers[] = $this->importer;
            $this->importer->setImportDirectory($dir);
            $this->importer->init();
            $this->current_comp = $comp;
            try {
                $this->log->debug("Process file: " . $dir . "/" . $expfile["path"]);
                $parser = new ilExportFileParser($dir . "/" . $expfile["path"], $this, "processItemXml");
            } catch (Exception $e) {
                $this->log->error("Import failed: " . $e->getMessage());
                $this->log->error('XML failed: ' . file_get_contents($dir . '/' . $expfile['path']));
                throw $e;
            }
        }
 
        // write import ids before(!) final processing
        $obj_map = $this->getMapping()->getMappingsOfEntity('Services/Container', 'objs');
        if (is_array($obj_map)) {
            foreach ($obj_map as $obj_id_old => $obj_id_new) {
                ilObject::_writeImportId(
                    (int) $obj_id_new,
                    "il_" . $this->mapping->getInstallId() . "_" . ilObject::_lookupType((int) $obj_id_new) . "_" . $obj_id_old
                );
            }
        }
 
        // final processing
        foreach ($all_importers as $imp) {
            $this->log->debug("Call finalProcessing for: " . get_class($imp));
            $imp->finalProcessing($this->mapping);
        }
 
        // we should only get on mapping here
        $top_mapping = $this->mapping->getMappingsOfEntity($this->comp, $a_type);
 
        $new_id = (int) current($top_mapping);
        return array(
            'new_id' => $new_id,
            'importers' => $all_importers
        );
    }

getConfig()

ilImport::getConfig

(

string

$a_comp

)

Get configuration (note that configurations are optional, null may be returned!)

Definition at line 57 of file class.ilImport.php.

                                             : ilImportConfig
    {
        // if created, return existing config object
        if (isset($this->configs[$a_comp])) {
            return $this->configs[$a_comp];
        }
 
        // create instance of export config object
        $comp_arr = explode("/", $a_comp);
        $a_class = "il" . $comp_arr[1] . "ImportConfig";
        $imp_config = new $a_class();
        $this->configs[$a_comp] = $imp_config;
 
        return $imp_config;
    }

getEntityTypes()

ilImport::getEntityTypes ( )

final

Definition at line 83 of file class.ilImport.php.

                                          : array
    {
        return $this->entity_types;
    }

References $entity_types.

getMapping()

ilImport::getMapping

(

)

Definition at line 73 of file class.ilImport.php.

                                : ilImportMapping
    {
        return $this->mapping;
    }

References $mapping.

getTemporaryImportDir()

ilImport::getTemporaryImportDir

(

)

Get temporary import directory.

Returns

string temporary import directory (used to unzip and read import)

Definition at line 169 of file class.ilImport.php.

                                           : string
    {
        return $this->tmp_import_dir;
    }

importEntity()

ilImport::importEntity ( string  $a_tmp_file, string  $a_filename, string  $a_entity, string  $a_component, bool  $a_copy_file = false  )

final

Import entity.

Definition at line 104 of file class.ilImport.php.

     : int {
        return $this->importObject(null, $a_tmp_file, $a_filename, $a_entity, $a_component, $a_copy_file);
    }

importFromDirectory()

ilImport::importFromDirectory	(	string	$dir,
		string	$a_type,
		string	$a_comp
	)

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

                                                                                    : ?int
    {
        $ret = $this->doImportObject($dir, $a_type, $a_comp);
        if (is_array($ret)) {
            return $ret['new_id'];
        }
        return null;
    }

importObject()

ilImport::importObject ( ?object  $a_new_obj, string  $a_tmp_file, string  $a_filename, string  $a_type, string  $a_comp = "", bool  $a_copy_file = false  )

final

Definition at line 114 of file class.ilImport.php.

     : ?int {
 
        // create temporary directory
        $tmpdir = ilFileUtils::ilTempnam();
        ilFileUtils::makeDir($tmpdir);
        if ($a_copy_file) {
            copy($a_tmp_file, $tmpdir . "/" . $a_filename);
        } else {
            ilFileUtils::moveUploadedFile($a_tmp_file, $a_filename, $tmpdir . "/" . $a_filename);
        }
 
        $this->log->debug("unzip: " . $tmpdir . "/" . $a_filename);
        ilFileUtils::unzip($tmpdir . "/" . $a_filename);
        $dir = $tmpdir . "/" . substr($a_filename, 0, strlen($a_filename) - 4);
        $this->setTemporaryImportDir($dir);
        $this->log->debug("dir: " . $dir);
        $ret = $this->doImportObject($dir, $a_type, $a_comp, $tmpdir);
        $new_id = null;
        if (is_array($ret) && array_key_exists('new_id', $ret)) {
            $new_id = $ret['new_id'];
        }
        // delete temporary directory
        ilFileUtils::delDir($tmpdir);
        return $new_id;
    }

processItemXml()

ilImport::processItemXml	(	string	$a_entity,
		string	$a_schema_version,
		string	$a_id,
		string	$a_xml,
		string	$a_install_id,
		string	$a_install_url
	)

Process item xml.

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

     : void {
        // skip
        if (isset($this->skip_entity[$this->current_comp][$a_entity]) &&
            $this->skip_entity[$this->current_comp][$a_entity]) {
            return;
        }
 
        if ($this->objDefinition->isRBACObject($a_entity) &&
            $this->getMapping()->getMapping('Services/Container', 'imported', $a_id)) {
            $this->log->info('Ignoring referenced ' . $a_entity . ' with id ' . $a_id);
            return;
        }
        $this->importer->setInstallId($a_install_id);
        $this->importer->setInstallUrl($a_install_url);
        $this->importer->setSchemaVersion($a_schema_version);
        $this->importer->setSkipEntities($this->skip_entity);
        $this->importer->importXmlRepresentation($a_entity, $a_id, $a_xml, $this->mapping);
 
        // Store information about imported obj_ids in mapping to avoid double imports of references
        if ($this->objDefinition->isRBACObject($a_entity)) {
            $this->getMapping()->addMapping('Services/Container', 'imported', $a_id, '1');
        }
    }

setEntityTypes()

ilImport::setEntityTypes ( array  $a_val )

final

Definition at line 78 of file class.ilImport.php.

                                                      : void
    {
        $this->entity_types = $a_val;
    }

setTemporaryImportDir()

ilImport::setTemporaryImportDir ( string  $a_val )

protected

Set temporary import directory.

Parameters

string

$a_val

temporary import directory (used to unzip and read import)

Definition at line 160 of file class.ilImport.php.

    {
        $this->tmp_import_dir = $a_val;
    }

Field Documentation

$comp

string ilImport::$comp = ''

private

Definition at line 32 of file class.ilImport.php.

$configs

array ilImport::$configs = array()

protected

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

$current_comp

string ilImport::$current_comp = ''

private

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

$entities

string ilImport::$entities = ""

protected

Definition at line 36 of file class.ilImport.php.

$entity_types

array ilImport::$entity_types = []

private

Definition at line 30 of file class.ilImport.php.

Referenced by getEntityTypes().

$importer

ilXmlImporter ilImport::$importer = null

private

Definition at line 31 of file class.ilImport.php.

$install_id

string ilImport::$install_id = ""

protected

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

$install_url

string ilImport::$install_url = ""

protected

Definition at line 35 of file class.ilImport.php.

$log

ilLogger ilImport::$log

protected

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

$mapping

ilImportMapping ilImport::$mapping = null

protected

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

Referenced by getMapping().

$objDefinition

ilObjectDefinition ilImport::$objDefinition

protected

Definition at line 28 of file class.ilImport.php.

$skip_entity

array ilImport::$skip_entity = array()

protected

Definition at line 40 of file class.ilImport.php.

$skip_importer

array ilImport::$skip_importer = []

protected

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

$tmp_import_dir

string ilImport::$tmp_import_dir = ""

protected

Definition at line 37 of file class.ilImport.php.

---

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

• Services/Export/classes/class.ilImport.php