ilImportContainer 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 ilImportContainer:

Collaboration diagram for ilImportContainer:

Public Member Functions
	__construct (int $a_target_id)
Public Member Functions inherited from ilImport
	__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
	doImportObject (string $dir, string $a_type, string $a_component="", string $a_tmpdir="")
	createDummy (string $a_type)
Protected Member Functions inherited from ilImport
	validateXMLFiles (SplFileInfo $manifest_spl)
	checkStatuses (ilImportStatusHandlerCollectionInterface $import_status_collection)
	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...

Additional Inherited Members
Protected Attributes inherited from ilImport
ilLogger	$log
ilObjectDefinition	$objDefinition
array	$entity_types = []
ilXmlImporter	$importer = null
string	$comp = ''
string	$current_comp = ''
string	$entities = ""
string	$tmp_import_dir = ""
ilImportMapping	$mapping = null
array	$skip_entity = array()
array	$configs = array()
array	$skip_importer = []
Archives	$archives
Filesystems	$filesystem
ilImportFactory	$import
ilImportStatusFactory	$import_status

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

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilImportContainer::__construct

(

int

$a_target_id

)

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

References ILIAS\MetaData\Repository\Validation\Data\__construct().

    {
        parent::__construct($a_target_id);
    }

Here is the call graph for this function:

Member Function Documentation

createDummy()

ilImportContainer::createDummy ( string  $a_type )

protected

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

References ilImport\getMapping().

Referenced by doImportObject().

                                                  : ilObject
    {
        $class_name = "ilObj" . $this->objDefinition->getClassName($a_type);

        $new = new $class_name();
        $new->setTitle('Import');
        $new->create(true);
        $new->createReference();
        $new->putInTree($this->getMapping()->getTargetId());
        $new->setPermissions($this->getMapping()->getTargetId());

        $this->getMapping()->addMapping('Services/Container', 'objs', '0', (string) $new->getId());
        $this->getMapping()->addMapping('Services/Container', 'refs', '0', (string) $new->getRefId());

        return $new;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doImportObject()

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

protected

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

References ilImport\$importer, createDummy(), and ilImport\getMapping().

     : array {
        $manifest_file = $dir . "/manifest.xml";
        if (!file_exists($manifest_file)) {
            return [];
        }
        $parser = new ilManifestParser($manifest_file);

        // Handling single containers without subitems
        // @todo: check if this is required
        // all container have container export sets
        $all_importers = array();
        if (!$parser->getExportSets()) {
            $this->createDummy($a_type);
            $import_info = parent::doImportObject($dir, $a_type);
            $all_importers = array_merge($all_importers, $import_info['importers']);
            return $import_info;
        }

        // Handling containers with subitems
        $first = true;
        $ret = [];
        foreach ($parser->getExportSets() as $set) {
            $import_info = parent::doImportObject($dir . DIRECTORY_SEPARATOR . $set['path'], $set['type']);
            $all_importers = array_merge($all_importers, $import_info['importers']);
            if ($first) {
                $ret = $import_info;
                $first = false;
            }
        }
        // after container import is finished, call all importers to perform a final processing
        foreach ($all_importers as $importer) {
            $importer->afterContainerImportProcessing($this->getMapping());
        }
        return $ret;
    }

Here is the call graph for this function:

---

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

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