ilImport Class Reference

Import class. More...

Inheritance diagram for ilImport:

Collaboration diagram for ilImport:

Public Member Functions
	__construct ($a_target_id=0)
	Constructor. More...
	getConfig ($a_comp)
	Get configuration (note that configurations are optional, null may be returned!) More...
	getMapping ()
	Get mapping object. More...
	setEntityTypes ($a_val)
	Set entity types. More...
	getEntityTypes ()
	Get entity types. More...
	addSkipEntity ($a_component, $a_entity, $skip=true)
	Add skip entity. More...
	setCurrentDataset ($a_val)
	Set currrent dataset. More...
	getCurrentDataset ()
	Get currrent dataset. More...
	afterEntityTypes ()
	After entity types are parsed. More...
	importRecord ($a_entity, $a_types, $a_record)
	After entity types are parsed. More...
	importEntity ( $a_tmp_file, $a_filename, $a_entity, $a_component, $a_copy_file=false)
	Import entity. More...
	importObject ( $a_new_obj, $a_tmp_file, $a_filename, $a_type, $a_comp="", $a_copy_file=false)
	Import repository object export file. More...
	importFromDirectory ($dir, $a_type, $a_comp)
	Import from directory. More...
	getTemporaryImportDir ()
	Get temporary import directory. More...
	processItemXml ($a_entity, $a_schema_version, $a_id, $a_xml, $a_install_id, $a_install_url)
	Process item xml. More...

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

Protected Attributes
	$log
	$install_id = ""
	$install_url = ""
	$entities = ""
	$tmp_import_dir = ""
	$mapping = null
	$skip_entity = array()
	$configs = array()

Detailed Description

Import class.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilImport::__construct

(

$a_target_id = 0

)

Constructor.

Parameters

int	id of parent container

Returns

Reimplemented in ilImportContainer.

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

    {
        include_once("./Services/Export/classes/class.ilImportMapping.php");
        $this->mapping = new ilImportMapping();
        $this->mapping->setTargetId($a_target_id);
        $this->log = ilLoggerFactory::getLogger('exp');
    }

References ilLoggerFactory\getLogger().

Here is the call graph for this function:

Member Function Documentation

addSkipEntity()

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

Add skip entity.

Parameters

string	$a_val	component
string	$a_val	entity

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

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

afterEntityTypes()

ilImport::afterEntityTypes

(

)

After entity types are parsed.

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

    {
        $this->getCurrentDataset()->setImport($this);
    }

References getCurrentDataset().

Here is the call graph for this function:

doImportObject()

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

protected

Import repository object export file.

Parameters

string

absolute filename of temporary upload file

Reimplemented in ilImportContainer.

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

    {
        if ($a_component == "") {
            include_once("./Services/Export/classes/class.ilImportExportFactory.php");
            $a_component = ilImportExportFactory::getComponentForExport($a_type);
        }
        $this->comp = $a_component;
 
        // get import class
        $success = true;
        
        // process manifest file
        include_once("./Services/Export/classes/class.ilManifestParser.php");
        if (!is_file($dir . "/manifest.xml")) {
            include_once("./Services/Export/exceptions/class.ilManifestFileNotFoundImportException.php");
            $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) {
            include_once("./Services/Export/exceptions/class.ilImportObjectTypeMismatchException.php");
            $e = new ilImportObjectTypeMismatchException("Object type does not match. Import file has type '" . $parser->getMainEntity() . "' but import being processed for '" . $a_type . "'.");
            throw $e;
        }
 
        // process export files
        $expfiles = $parser->getExportFiles();
        
        include_once("./Services/Export/classes/class.ilExportFileParser.php");
        include_once("./Services/Export/classes/class.ilImportExportFactory.php");
        $all_importers = array();
        foreach ($expfiles as $expfile) {
            $comp = $expfile["component"];
            $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());
                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($obj_id_new, "il_" . $this->mapping->getInstallId() . "_" . ilObject::_lookupType($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' => (array) $all_importers
        );
    }

References $a_type, $parser, $success, ilObject\_lookupType(), ilObject\_writeImportId(), and getMapping().

Referenced by importFromDirectory(), and importObject().

Here is the call graph for this function:

Here is the caller graph for this function:

getConfig()

ilImport::getConfig

(

$a_comp

)

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

Parameters

string

$a_comp

component (e.g. "Modules/Glossary")

Returns

ilImportConfig $a_comp configuration object or null

Exceptions

ilImportException

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

    {
        // 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";
        $import_config_file = "./" . $a_comp . "/classes/class." . $a_class . ".php";
        if (!is_file($import_config_file)) {
            include_once("./Services/Export/exceptions/class.ilImportException.php");
            throw new ilImportException('Component "' . $a_comp . '" does not provide ImportConfig class.');
        }
        include_once($import_config_file);
        $imp_config = new $a_class();
        $this->configs[$a_comp] = $imp_config;
 
        return $imp_config;
    }

getCurrentDataset()

ilImport::getCurrentDataset

(

)

Get currrent dataset.

Returns

object currrent dataset

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

    {
        return $this->current_dataset;
    }

Referenced by afterEntityTypes(), and importRecord().

Here is the caller graph for this function:

getEntityTypes()

ilImport::getEntityTypes ( )

final

Get entity types.

Returns

array entity types

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

    {
        return $this->entity_types;
    }

getMapping()

ilImport::getMapping

(

)

Get mapping object.

Returns

ilImportMapping ilImportMapping

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

    {
        return $this->mapping;
    }

References $mapping.

Referenced by ilImportContainer\createDummy(), doImportObject(), ilImportContainer\doImportObject(), and processItemXml().

Here is the caller graph for this function:

getTemporaryImportDir()

ilImport::getTemporaryImportDir

(

)

Get temporary import directory.

Returns

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

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

    {
        return $this->tmp_import_dir;
    }

References $tmp_import_dir.

importEntity()

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

final

Import entity.

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

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

References importObject().

Here is the call graph for this function:

importFromDirectory()

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

Import from directory.

Parameters

return

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

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

References $a_type, $ret, and doImportObject().

Here is the call graph for this function:

importObject()

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

final

Import repository object export file.

Parameters

string

absolute filename of temporary upload file

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

      {
 
        // create temporary directory
        $tmpdir = ilUtil::ilTempnam();
        ilUtil::makeDir($tmpdir);
        if ($a_copy_file) {
            copy($a_tmp_file, $tmpdir . "/" . $a_filename);
        } else {
            ilUtil::moveUploadedFile($a_tmp_file, $a_filename, $tmpdir . "/" . $a_filename);
        }
 
        $this->log->debug("unzip: " . $tmpdir . "/" . $a_filename);
 
        ilUtil::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)) {
            $new_id = $ret['new_id'];
        }
        
        // delete temporary directory
        ilUtil::delDir($tmpdir);
        return $new_id;
    }

References $a_type, $ret, ilUtil\delDir(), doImportObject(), ilUtil\ilTempnam(), ilUtil\makeDir(), setTemporaryImportDir(), and ilUtil\unzip().

Referenced by importEntity().

Here is the call graph for this function:

Here is the caller graph for this function:

importRecord()

ilImport::importRecord	(		$a_entity,
			$a_types,
			$a_record
	)

After entity types are parsed.

Parameters

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

    {
        $this->getCurrentDataset()->importRecord($a_entity, $a_types, $a_record);
    }

References getCurrentDataset().

Here is the call graph for this function:

processItemXml()

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

Process item xml.

@global ilObjectDefinition $objDefinition

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

    {
        global $objDefinition;
        
        // skip
        if ($this->skip_entity[$this->current_comp][$a_entity]) {
            return;
        }
 
        if ($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);
        $new_id = $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 ($objDefinition->isRBACObject($a_entity)) {
            $this->getMapping()->addMapping('Services/Container', 'imported', $a_id, 1);
        }
 
        // @TODO new id is not always set
        if ($new_id) {
            $this->mapping->addMapping($this->comp, $a_entity, $a_id, $new_id);
        }
    }

References getMapping().

Here is the call graph for this function:

setCurrentDataset()

ilImport::setCurrentDataset

(

$a_val

)

Set currrent dataset.

Parameters

object

currrent dataset

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

    {
        $this->current_dataset = $a_val;
    }

setEntityTypes()

ilImport::setEntityTypes (   $a_val )

final

Set entity types.

Parameters

array

entity types

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

    {
        $this->entity_types = $a_val;
    }

setTemporaryImportDir()

ilImport::setTemporaryImportDir (   $a_val )

protected

Set temporary import directory.

Parameters

string

$a_val

temporary import directory (used to unzip and read import)

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

    {
        $this->tmp_import_dir = $a_val;
    }

Referenced by importObject().

Here is the caller graph for this function:

Field Documentation

$configs

ilImport::$configs = array()

protected

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

$entities

ilImport::$entities = ""

protected

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

$install_id

ilImport::$install_id = ""

protected

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

$install_url

ilImport::$install_url = ""

protected

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

$log

ilImport::$log

protected

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

$mapping

ilImport::$mapping = null

protected

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

Referenced by getMapping().

$skip_entity

ilImport::$skip_entity = array()

protected

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

$tmp_import_dir

ilImport::$tmp_import_dir = ""

protected

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

Referenced by getTemporaryImportDir().

---

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

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