ilExport Class Reference

Export. More...

Inheritance diagram for ilExport:

Collaboration diagram for ilExport:

Public Member Functions
	__construct ()
	setPathInfo (ExportPathInfoInterface $export_path_info)
	getExportDirInContainer ()
	getPathToComponentExpDirInContainer ()
	getPathToComponentExpDirInContainerWithLeadingSetNumber ()
	getSetNumber ()
	isContainerExport ()
	setExportDirectories (string $a_dir_relative, string $a_dir_absolute)
	getRelativeExportDirectory ()
	getAbsoluteExportDirectory ()
	setExportWriter (ilExportHandlerConsumerExportWriterInterface $export_writer,)
	getExportWriter ()
	setExportConfigs (ExportConfigCollectionInterface $export_configs)
	getExportConfigs ()
	exportObject (string $a_type, int $a_id, string $a_target_release="")
	@depricated Export an ILIAS object (the object type must be known by objDefinition) More...
	exportEntity (string $a_entity, string $a_id, string $a_target_release, string $a_component, string $a_title, string $a_export_dir, string $a_type_for_file="")
	@depricated Export an ILIAS entity More...
	processExporter (string $a_comp, string $a_class, string $a_entity, string $a_target_release, ?array $a_id=null)
	@depricated Process exporter More...

Static Public Member Functions
static	_getValidExportSubItems (int $a_ref_id)
	Get a list of subitems of a repository resource, that implement the export. More...
static	_getLastExportFileDate (int $a_obj_id, string $a_type="", string $a_obj_type="")
	@depricated Get date of last export file More...
static	_getLastExportFileInformation (int $a_obj_id, string $a_type="", string $a_obj_type="")
	@depricated Get last export file information More...
static	_getExportDirectory (int $a_obj_id, string $a_type="xml", string $a_obj_type="", string $a_entity="")
	@depricated Get export directory for an repository object More...
static	_getExportFiles (int $a_obj_id, $a_export_types="", string $a_obj_type="")
	@depricated More...
static	_createExportDirectory (int $a_obj_id, string $a_export_type="xml", string $a_obj_type="")
static	_generateIndexFile (string $a_filename, int $a_obj_id, array $a_files, string $a_type="")
	@depricated Generates an index.html file including links to all xml files included (for container exports) More...

Data Fields
string	$export_run_dir = ''

Static Protected Member Functions
static	createPathFromId (int $a_container_id, string $a_name)

Protected Attributes
string	$dir_relative = ""
string	$dir_absolute = ""
ilLogger	$log
ilExportHandlerConsumerExportWriterInterface	$export_writer
ExportPathInfoInterface	$export_path_info
ExportConfigCollectionInterface	$export_configs

Private Attributes
array	$cnt = []
ilXmlWriter	$manifest_writer = null

Static Private Attributes
static array	$new_file_structure
static array	$export_implementer = array("tst", "lm", "glo", "sahs")

Detailed Description

Export.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilExport::__construct

(

)

Definition at line 56 of file class.ilExport.php.

    {
        global $DIC;
        $this->log = $DIC->logger()->exp();
    }

References $DIC.

Member Function Documentation

_createExportDirectory()

static ilExport::_createExportDirectory ( int  $a_obj_id, string  $a_export_type = "xml", string  $a_obj_type = ""  )

static

Definition at line 318 of file class.ilExport.php.

     : bool {
        global $DIC;
 
        $ilErr = $DIC['ilErr'];
 
        if ($a_obj_type == "") {
            $a_obj_type = ilObject::_lookupType($a_obj_id);
        }
 
        $edir = ilExport::_getExportDirectory($a_obj_id, $a_export_type, $a_obj_type);
        ilFileUtils::makeDirParents($edir);
        return true;
    }

References ilObject\_lookupType().

Referenced by ILIAS\Notes\Export\NotesHtmlExport\__construct(), ilObjGlossary\createExportDirectory(), ilObjFileBasedLMGUI\exportHTML(), ilExportContainer\exportObject(), ILIAS\Export\ExportHandler\Info\Export\Handler\getLegacyExportRunDir(), and ilOrgUnitExporter\sendAndCreateSimpleExportFile().

Here is the call graph for this function:

Here is the caller graph for this function:

_generateIndexFile()

static ilExport::_generateIndexFile ( string  $a_filename, int  $a_obj_id, array  $a_files, string  $a_type = ""  )

static

@depricated Generates an index.html file including links to all xml files included (for container exports)

Definition at line 341 of file class.ilExport.php.

     : void {
        global $DIC;
 
        $lng = $DIC->language();
        $lng->loadLanguageModule("export");
 
        if ($a_type == "") {
            $a_type = ilObject::_lookupType($a_obj_id);
        }
        $a_tpl = new ilGlobalTemplate("tpl.main.html", true, true);
        $location_stylesheet = ilUtil::getStyleSheetLocation();
        $a_tpl->setVariable("LOCATION_STYLESHEET", $location_stylesheet);
        $a_tpl->loadStandardTemplate();
        $a_tpl->setTitle(ilObject::_lookupTitle($a_obj_id));
        $a_tpl->setDescription($lng->txt("export_export_date") . ": " .
            date('Y-m-d H:i:s', time()) . " (" . date_default_timezone_get() . ")");
        $f_tpl = new ilTemplate("tpl.export_list.html", true, true, "components/ILIAS/Export");
        foreach ($a_files as $file) {
            $f_tpl->setCurrentBlock("file_row");
            $f_tpl->setVariable("TITLE", $file["title"]);
            $f_tpl->setVariable("TYPE", $lng->txt("obj_" . $file["type"]));
            $f_tpl->setVariable("FILE", $file["file"]);
            $f_tpl->parseCurrentBlock();
        }
        $a_tpl->setContent($f_tpl->get());
        $index_content = $a_tpl->getSpecial("DEFAULT", false, false, false, true, false, false);
 
        $f = fopen($a_filename, "w");
        fwrite($f, $index_content);
        fclose($f);
    }

References ilObject\_lookupType().

Here is the call graph for this function:

_getExportDirectory()

static ilExport::_getExportDirectory ( int  $a_obj_id, string  $a_type = "xml", string  $a_obj_type = "", string  $a_entity = ""  )

static

@depricated Get export directory for an repository object

Parameters

int	$a_obj_id	object id
string	$a_type	export type ("xml", "html", ...), default "xml"
string	$a_obj_type	object type (optional, if not given, type is looked up)
string	$a_entity

Returns

string export directory

Definition at line 216 of file class.ilExport.php.

     : string {
        global $DIC;
 
        $logger = $DIC->logger()->exp();
        $objDefinition = $DIC['objDefinition'];
 
        $ent = ($a_entity == "")
            ? ""
            : "_" . $a_entity;
 
        if ($a_obj_type == "") {
            $a_obj_type = ilObject::_lookupType($a_obj_id);
        }
 
        if (in_array($a_obj_type, self::$new_file_structure)) {
            $dir = ilFileUtils::getDataDir() . DIRECTORY_SEPARATOR;
            $dir .= 'il' . $objDefinition->getClassName($a_obj_type) . $ent . DIRECTORY_SEPARATOR;
            $dir .= self::createPathFromId($a_obj_id, $a_obj_type) . DIRECTORY_SEPARATOR;
            $dir .= ($a_type == 'xml' ? 'export' : 'export_' . $a_type);
            return $dir;
        }
 
        $exporter_class = ilImportExportFactory::getExporterClass($a_obj_type);
        $export_dir = call_user_func(
            array($exporter_class, 'lookupExportDirectory'),
            $a_obj_type,
            $a_obj_id,
            $a_type,
            $a_entity
        );
 
        $logger->debug('Export dir is ' . $export_dir);
        return $export_dir;
    }

References ilObject\_lookupType().

Referenced by ILIAS\Notes\Export\NotesHtmlExport\__construct(), _getExportFiles(), ilExportContainer\addSubitems(), ilSAHSEditGUI\executeCommand(), ilObjFileBasedLMGUI\exportHTML(), ilExportContainer\exportObject(), ilDclContentExporter\getExportContentPath(), ilObjQuestionPool\getExportDirectory(), ilObjGlossary\getExportDirectory(), ILIAS\Export\ExportHandler\Info\Export\Handler\getLegacyExportRunDir(), ilObjUser\getPersonalDataExportFile(), ILIAS\Wiki\Export\WikiHtmlExport\getUserExportFile(), ilDataCollectionExportOptionsXLSX\onDeleteFiles(), ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler\onDeleteFiles(), ilMediaPoolExportOptionXMLMaster\onDeleteFiles(), ilMediaPoolExportOptionXMLMasterNoMedia\onDeleteFiles(), ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler\onDownloadFiles(), ilMediaPoolExportOptionXMLMaster\onDownloadFiles(), ilMediaPoolExportOptionXMLMasterNoMedia\onDownloadFiles(), ilOrgUnitExporter\sendAndCreateSimpleExportFile(), ilObjUser\sendPersonalDataFile(), and ILIAS\Notes\Export\NotesHtmlExport\zipPackage().

Here is the call graph for this function:

Here is the caller graph for this function:

_getExportFiles()

static ilExport::_getExportFiles ( int  $a_obj_id,   $a_export_types = "", string  $a_obj_type = ""  )

static

@depricated

Parameters

int	$a_obj_id
string | array	$a_export_types
string	$a_obj_type

Returns

array

Definition at line 263 of file class.ilExport.php.

                                                                                                        : array
    {
        if ($a_obj_type == "") {
            $a_obj_type = ilObject::_lookupType($a_obj_id);
        }
 
        if ($a_export_types == "") {
            $a_export_types = array("xml");
        }
        if (!is_array($a_export_types)) {
            $a_export_types = array($a_export_types);
        }
 
        // initialize array
        $file = array();
 
        $types = $a_export_types;
 
        foreach ($types as $type) {
            $dir = ilExport::_getExportDirectory($a_obj_id, $type, $a_obj_type);
 
            // quit if import dir not available
            if (!is_dir($dir) || !is_writable($dir)) {
                continue;
            }
 
            // open directory
            $h_dir = dir($dir);
 
            // get files and save the in the array
            while ($entry = $h_dir->read()) {
                if ($entry !== "." &&
                    $entry !== ".." &&
                    substr($entry, -4) === ".zip" &&
                    preg_match("/^[0-9]{10}_{2}[0-9]+_{2}(" . $a_obj_type . "_)*[0-9]+\.zip\$/", $entry)) {
                    $ts = substr($entry, 0, strpos($entry, "__"));
                    $file[$entry . $type] = [
                        "type" => (string) $type,
                        "file" => (string) $entry,
                        "size" => (int) filesize($dir . "/" . $entry),
                        "timestamp" => (int) $ts
                    ];
                }
            }
 
            // close import directory
            $h_dir->close();
        }
 
        // sort files
        ksort($file);
        reset($file);
        return $file;
    }

References _getExportDirectory(), ilObject\_lookupType(), and ILIAS\Repository\int().

Referenced by _getLastExportFileDate().

Here is the call graph for this function:

Here is the caller graph for this function:

_getLastExportFileDate()

static ilExport::_getLastExportFileDate ( int  $a_obj_id, string  $a_type = "", string  $a_obj_type = ""  )

static

@depricated Get date of last export file

Parameters

int	$a_obj_id	object id
string	$a_type	export type ("xml", "html", ...), default "xml"
string	$a_obj_type	object type (optional, if not given, type is looked up)

Definition at line 176 of file class.ilExport.php.

                                                                                                              : int
    {
        $files = ilExport::_getExportFiles($a_obj_id, $a_type, $a_obj_type);
        if (is_array($files)) {
            $files = ilArrayUtil::sortArray($files, "timestamp", "desc");
            return (int) $files[0]["timestamp"];
        }
        return 0;
    }

References _getExportFiles(), and ilArrayUtil\sortArray().

Referenced by _getValidExportSubItems().

Here is the call graph for this function:

Here is the caller graph for this function:

_getLastExportFileInformation()

static ilExport::_getLastExportFileInformation ( int  $a_obj_id, string  $a_type = "", string  $a_obj_type = ""  )

static

@depricated Get last export file information

Parameters

int	$a_obj_id	object id
string	$a_type	export type ("xml", "html", ...), default "xml"
string	$a_obj_type	object type (optional, if not given, type is looked up)

Returns

?array

Definition at line 194 of file class.ilExport.php.

     : ?array {
        $files = ilExport::_getExportFiles($a_obj_id, $a_type, $a_obj_type);
        if (is_array($files)) {
            $files = ilArrayUtil::sortArray($files, "timestamp", "desc");
            return $files[0];
        }
        return null;
    }

References ilArrayUtil\sortArray().

Here is the call graph for this function:

_getValidExportSubItems()

static ilExport::_getValidExportSubItems ( int  $a_ref_id )

static

Get a list of subitems of a repository resource, that implement the export.

Includes also information on last export file.

Returns

array<int, array<string, int|string>>

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

                                                                 : array
    {
        global $DIC;
 
        $tree = $DIC->repositoryTree();
 
        $valid_items = array();
        $sub_items = $tree->getSubTree($tree->getNodeData($a_ref_id));
        foreach ($sub_items as $sub_item) {
            if (in_array($sub_item["type"], self::$export_implementer)) {
                $valid_items[] = [
                    "type" => (string) $sub_item["type"],
                    "title" => (string) $sub_item["title"],
                    "ref_id" => (int) $sub_item["child"],
                    "obj_id" => (int) $sub_item["obj_id"],
                    "timestamp" => ilExport::_getLastExportFileDate($sub_item["obj_id"], "xml", $sub_item["type"])
                ];
            }
        }
        return $valid_items;
    }

References $DIC, _getLastExportFileDate(), and ILIAS\Repository\int().

Referenced by ilSubItemSelectionTableGUI\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

createPathFromId()

static ilExport::createPathFromId ( int  $a_container_id, string  $a_name  )

staticprotected

Definition at line 703 of file class.ilExport.php.

                                                                                   : string
    {
        $max_exponent = 3;
        $factor = 100;
 
        $path = [];
        $found = false;
        $num = $a_container_id;
        $path_string = '';
        for ($i = $max_exponent; $i > 0; $i--) {
            $factor = pow($factor, $i);
            if (($tmp = (int) ($num / $factor)) or $found) {
                $path[] = $tmp;
                $num = $num % $factor;
                $found = true;
            }
        }
        if (count($path)) {
            $path_string = (implode('/', $path) . '/');
        }
        return $path_string . $a_name . '_' . $a_container_id;
    }

References $path.

exportEntity()

ilExport::exportEntity	(	string	$a_entity,
		string	$a_id,
		string	$a_target_release,
		string	$a_component,
		string	$a_title,
		string	$a_export_dir,
		string	$a_type_for_file = ""
	)

@depricated Export an ILIAS entity

Parameters

string	$a_entity	entity type, e.g. "sty"
mixed	$a_id	entity id
string	$a_target_release	target release
string	$a_component	component that exports (e.g. "components/ILIAS/Style")

Returns

array success and info array

Definition at line 480 of file class.ilExport.php.

     : array {
        global $DIC;
 
        $objDefinition = $DIC['objDefinition'];
        $tpl = $DIC['tpl'];
 
        // if no target release specified, use latest major release number
        if ($a_target_release == "") {
            $v = explode(".", ILIAS_VERSION_NUMERIC);
            $a_target_release = $v[0] . "." . $v[1] . ".0";
        }
 
        if ($a_type_for_file == "") {
            $a_type_for_file = $a_entity;
        }
 
        $comp = $a_component;
        $c = explode("/", $comp);
        $component = str_replace("_", "", $c[2]);
        $class = "il" . $component . "Exporter";
 
        // manifest writer
        $this->manifest_writer = new ilXmlWriter();
        $this->manifest_writer->xmlHeader();
        $this->manifest_writer->xmlStartTag(
            'Manifest',
            array(
                "MainEntity" => $a_entity,
                "Title" => $a_title,
                /* "TargetRelease" => $a_target_release, */
                "InstallationId" => IL_INST_ID,
                "InstallationUrl" => ILIAS_HTTP_PATH
            )
        );
 
        $export_dir = $a_export_dir;
        $ts = time();
 
        // determine file name and subdirectory
        $sub_dir = $ts . '__' . IL_INST_ID . '__' . $a_type_for_file . '_' . $a_id;
        $new_file = $sub_dir . '.zip';
 
        $this->export_run_dir = $export_dir . "/" . $sub_dir;
        ilFileUtils::makeDirParents($this->export_run_dir);
 
        $this->cnt = array();
        $success = $this->processExporter($comp, $class, $a_entity, $a_target_release, [$a_id]);
        $this->manifest_writer->xmlEndTag('Manifest');
        $this->manifest_writer->xmlDumpFile($this->export_run_dir . "/manifest.xml", false);
 
        // zip the file
        ilFileUtils::zip($this->export_run_dir, $export_dir . "/" . $new_file);
        ilFileUtils::delDir($this->export_run_dir);
 
        return array(
            "success" => $success,
            "file" => $new_file,
            "directory" => $export_dir
        );
    }

References ILIAS_VERSION_NUMERIC.

exportObject()

ilExport::exportObject	(	string	$a_type,
		int	$a_id,
		string	$a_target_release = ""
	)

@depricated Export an ILIAS object (the object type must be known by objDefinition)

Parameters

string	$a_type	repository object type
int	$a_id	id of object or entity that shoudl be exported
string	$a_target_release	target release

Returns

array success and info array

Reimplemented in ilExportContainer.

Definition at line 397 of file class.ilExport.php.

     : array {
        $this->log->debug("export type: $a_type, id: $a_id, target_release: " . $a_target_release);
 
        // if no target release specified, use latest major release number
        if ($a_target_release == "") {
            $v = explode(".", ILIAS_VERSION_NUMERIC);
            $a_target_release = $v[0] . "." . $v[1] . ".0";
            $this->log->debug("target_release set to: " . $a_target_release);
        }
 
        // manifest writer
        $this->manifest_writer = new ilXmlWriter();
        $this->manifest_writer->xmlHeader();
        $this->manifest_writer->xmlStartTag(
            'Manifest',
            array(
                "MainEntity" => $a_type,
                "Title" => ilObject::_lookupTitle($a_id),
                /* "TargetRelease" => $a_target_release, */
                "InstallationId" => IL_INST_ID,
                "InstallationUrl" => ILIAS_HTTP_PATH
            )
        );
 
        // get export class
        ilExport::_createExportDirectory($a_id, "xml", $a_type);
        $export_dir = ilExport::_getExportDirectory($a_id, "xml", $a_type);
        $ts = time();
 
        // Workaround for test assessment
        $sub_dir = $ts . '__' . IL_INST_ID . '__' . $a_type . '_' . $a_id;
        $new_file = $sub_dir . '.zip';
 
        $this->export_run_dir = $export_dir . "/" . $sub_dir;
        ilFileUtils::makeDirParents($this->export_run_dir);
        $this->log->debug("export dir: " . $this->export_run_dir);
 
        $this->cnt = array();
 
        $class = ilImportExportFactory::getExporterClass($a_type);
        $comp = ilImportExportFactory::getComponentForExport($a_type);
 
        $success = $this->processExporter($comp, $class, $a_type, $a_target_release, [$a_id]);
 
        $this->manifest_writer->xmlEndTag('Manifest');
        $this->manifest_writer->xmlDumpFile($this->export_run_dir . "/manifest.xml", false);
 
        // zip the file
        $this->log->debug("zip: " . $export_dir . "/" . $new_file);
        $this->log->debug("run dir: " . $this->export_run_dir);
        ilFileUtils::zip($this->export_run_dir, $export_dir . "/" . $new_file);
        ilFileUtils::delDir($this->export_run_dir);
 
        // Store info about export
        if ($success) {
            $exp = new ilExportFileInfo($a_id);
            $exp->setVersion($a_target_release);
            $exp->setCreationDate(new ilDateTime($ts, IL_CAL_UNIX));
            $exp->setExportType('xml');
            $exp->setFilename($new_file);
            $exp->create();
        }
 
        return array(
            "success" => $success,
            "file" => $new_file,
            "directory" => $export_dir
        );
    }

References ILIAS_VERSION_NUMERIC.

getAbsoluteExportDirectory()

ilExport::getAbsoluteExportDirectory

(

)

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

                                                : string
    {
        return $this->dir_absolute;
    }

getExportConfigs()

ilExport::getExportConfigs

(

)

Definition at line 137 of file class.ilExport.php.

                                      : ExportConfigCollectionInterface
    {
        return $this->export_configs;
    }

getExportDirInContainer()

ilExport::getExportDirInContainer

(

)

Returns

string the path to the export directory of the current component in the container, for example: "1737382047__0__cat_100/components/ILIAS/Style/set_0

Definition at line 72 of file class.ilExport.php.

                                             : string
    {
        return $this->export_path_info->getPathToComponentDirInContainer();
    }

getExportWriter()

ilExport::getExportWriter

(

)

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

                                     : ilExportHandlerConsumerExportWriterInterface
    {
        return $this->export_writer;
    }

getPathToComponentExpDirInContainer()

ilExport::getPathToComponentExpDirInContainer

(

)

Returns

string the path to the expDir folder in the export directory of the current component in the container, for example: "1737382047__0__cat_100/components/ILIAS/Style/set_0/expDir_1

Definition at line 82 of file class.ilExport.php.

                                                         : string
    {
        return $this->export_path_info->getPathToComponentExpDirInContainer();
    }

getPathToComponentExpDirInContainerWithLeadingSetNumber()

ilExport::getPathToComponentExpDirInContainerWithLeadingSetNumber

(

)

Definition at line 87 of file class.ilExport.php.

                                                                             : string
    {
        return "set_" . $this->export_path_info->getSetNumber() . DIRECTORY_SEPARATOR . $this->export_path_info->getPathToComponentExpDirInContainer();
    }

getRelativeExportDirectory()

ilExport::getRelativeExportDirectory

(

)

Definition at line 110 of file class.ilExport.php.

                                                : string
    {
        return $this->dir_relative;
    }

getSetNumber()

ilExport::getSetNumber

(

)

Definition at line 92 of file class.ilExport.php.

                                  : int
    {
        return $this->export_path_info->getSetNumber();
    }

isContainerExport()

ilExport::isContainerExport

(

)

Definition at line 97 of file class.ilExport.php.

                                       : bool
    {
        return $this->export_path_info->isContainerExport();
    }

processExporter()

ilExport::processExporter	(	string	$a_comp,
		string	$a_class,
		string	$a_entity,
		string	$a_target_release,
		?array	$a_id = null
	)

@depricated Process exporter

Parameters

string	$a_comp	e.g. "components/ILIAS/Forum"
string	$a_class
string	$a_entity	e.g. "frm"
string	$a_target_release	e.g. "5.1.0"
string	$a_id	id of entity (e.g. object id)

Returns

bool success true/false

Exceptions

ilExportException

Definition at line 560 of file class.ilExport.php.

     : bool {
        $success = true;
        $this->log->debug("process exporter, comp: " . $a_comp . ", class: " . $a_class . ", entity: " . $a_entity .
            ", target release " . $a_target_release . ", id: " . print_r($a_id, true));
 
        if (!is_array($a_id)) {
            if ($a_id == "") {
                return true;
            }
            $a_id = array($a_id);
        }
 
        // get exporter object
        if (!class_exists($a_class)) {
            $a_class = substr($a_class, 0, 2) . "ILIAS" . substr($a_class, 2);
            if (!class_exists($a_class)) {
                $export_class_file = "./" . $a_comp . "/classes/class." . $a_class . ".php";
                if (!is_file($export_class_file)) {
                    throw new ilExportException('Export class file "' . $export_class_file . '" not found.');
                }
            }
        }
 
        $exp = new $a_class();
        $exp->setExport($this);
        if (!isset($this->cnt[$a_comp])) {
            $this->cnt[$a_comp] = 1;
        } else {
            $this->cnt[$a_comp]++;
        }
        $set_dir_relative = $a_comp . "/set_" . $this->cnt[$a_comp];
        $set_dir_absolute = $this->export_run_dir . "/" . $set_dir_relative;
        ilFileUtils::makeDirParents($set_dir_absolute);
        $this->log->debug("dir: " . $set_dir_absolute);
 
        $this->log->debug("init exporter");
        $exp->init();
 
        // process head dependencies
        $this->log->debug("process head dependencies for " . $a_entity);
        $sequence = $exp->getXmlExportHeadDependencies($a_entity, $a_target_release, $a_id);
        foreach ($sequence as $s) {
            $comp = explode("/", $s["component"]);
            $component = str_replace("_", "", $comp[2]);
            $exp_class = "il" . $component . "Exporter";
            $s = $this->processExporter(
                $s["component"],
                $exp_class,
                $s["entity"],
                $a_target_release,
                $s["ids"]
            );
            if (!$s) {
                $success = false;
            }
        }
 
        // write export.xml file
        $export_writer = new ilXmlWriter();
        $export_writer->xmlHeader();
 
        $sv = $exp->determineSchemaVersion($a_entity, $a_target_release);
        $sv["uses_dataset"] ??= false;
        $sv['xsd_file'] ??= '';
        $this->log->debug("schema version for entity: $a_entity, target release: $a_target_release");
        $this->log->debug("...is: " . $sv["schema_version"] . ", namespace: " . $sv["namespace"] .
            ", xsd file: " . $sv["xsd_file"] . ", uses_dataset: " . ((int) $sv["uses_dataset"]));
 
        $attribs = array("InstallationId" => IL_INST_ID,
                         "InstallationUrl" => ILIAS_HTTP_PATH,
                         "Entity" => $a_entity,
                         "SchemaVersion" => $sv["schema_version"],
                         /* "TargetRelease" => $a_target_release, */
                         "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
                         "xmlns:exp" => "http://www.ilias.de/Services/Export/exp/4_1",
                         "xsi:schemaLocation" => "http://www.ilias.de/Services/Export/exp/4_1 " . ILIAS_HTTP_PATH . "/components/ILIAS/Export/xml/ilias_export_4_1.xsd"
        );
        if ($sv["namespace"] != "" && $sv["xsd_file"] != "") {
            $attribs["xsi:schemaLocation"] .= " " . $sv["namespace"] . " " .
                ILIAS_HTTP_PATH . "/components/ILIAS/Export/xml/" . $sv["xsd_file"];
            $attribs["xmlns"] = $sv["namespace"];
        }
        if ($sv["uses_dataset"]) {
            $attribs["xsi:schemaLocation"] .= " " .
                "http://www.ilias.de/Services/DataSet/ds/4_3 " . ILIAS_HTTP_PATH . "/components/ILIAS/Export/xml/ilias_ds_4_3.xsd";
            $attribs["xmlns:ds"] = "http://www.ilias.de/Services/DataSet/ds/4_3";
        }
        $export_writer->xmlStartTag('exp:Export', $attribs);
 
        $dir_cnt = 1;
        foreach ($a_id as $id) {
            $exp->setExportDirectories(
                $set_dir_relative . "/expDir_" . $dir_cnt,
                $set_dir_absolute . "/expDir_" . $dir_cnt
            );
            $export_writer->xmlStartTag('exp:ExportItem', array("Id" => $id));
            $xml = $exp->getXmlRepresentation($a_entity, $sv["schema_version"], (string) $id);
            $export_writer->appendXML($xml);
            $export_writer->xmlEndTag('exp:ExportItem');
            $dir_cnt++;
        }
 
        $export_writer->xmlEndTag('exp:Export');
        $export_writer->xmlDumpFile($set_dir_absolute . "/export.xml", false);
 
        $this->manifest_writer->xmlElement(
            "ExportFile",
            array("Component" => $a_comp, "Path" => $set_dir_relative . "/export.xml")
        );
 
        // process tail dependencies
        $this->log->debug("process tail dependencies of " . $a_entity);
        $sequence = $exp->getXmlExportTailDependencies($a_entity, $a_target_release, $a_id);
        foreach ($sequence as $s) {
            if (empty((array) ($s["ids"] ?? []))) {
                continue;
            }
 
            $comp = explode("/", $s["component"]);
            $component = str_replace("_", "", $comp[2]);
            $exp_class = "il" . $component . "Exporter";
            $s = $this->processExporter(
                $s["component"],
                $exp_class,
                $s["entity"],
                $a_target_release,
                (array) $s["ids"]
            );
            if (!$s) {
                $success = false;
            }
        }
 
        $this->log->debug("returning " . ((int) $success) . " for " . $a_entity);
        return $success;
    }

setExportConfigs()

ilExport::setExportConfigs

(

ExportConfigCollectionInterface

$export_configs

)

Definition at line 131 of file class.ilExport.php.

     : void {
        $this->export_configs = $export_configs;
    }

setExportDirectories()

ilExport::setExportDirectories	(	string	$a_dir_relative,
		string	$a_dir_absolute
	)

Definition at line 102 of file class.ilExport.php.

     : void {
        $this->dir_relative = $a_dir_relative;
        $this->dir_absolute = $a_dir_absolute;
    }

setExportWriter()

ilExport::setExportWriter

(

ilExportHandlerConsumerExportWriterInterface

$export_writer

)

Definition at line 120 of file class.ilExport.php.

     : void {
        $this->export_writer = $export_writer;
    }

setPathInfo()

ilExport::setPathInfo

(

ExportPathInfoInterface

$export_path_info

)

Definition at line 62 of file class.ilExport.php.

     : void {
        $this->export_path_info = $export_path_info;
    }

Field Documentation

$cnt

array ilExport::$cnt = []

private

Definition at line 53 of file class.ilExport.php.

$dir_absolute

string ilExport::$dir_absolute = ""

protected

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

$dir_relative

string ilExport::$dir_relative = ""

protected

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

$export_configs

ExportConfigCollectionInterface ilExport::$export_configs

protected

Definition at line 38 of file class.ilExport.php.

$export_implementer

array ilExport::$export_implementer = array("tst", "lm", "glo", "sahs")

staticprivate

Definition at line 52 of file class.ilExport.php.

$export_path_info

ExportPathInfoInterface ilExport::$export_path_info

protected

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

$export_run_dir

string ilExport::$export_run_dir = ''

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

$export_writer

ilExportHandlerConsumerExportWriterInterface ilExport::$export_writer

protected

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

$log

ilLogger ilExport::$log

protected

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

Referenced by ilExportContainer\exportObject().

$manifest_writer

ilXmlWriter ilExport::$manifest_writer = null

private

Definition at line 54 of file class.ilExport.php.

$new_file_structure

array ilExport::$new_file_structure

staticprivate

Initial value:

= array('cat',
                                               'exc',
                                               'crs',
                                               'sess',
                                               'file',
                                               'grp',
                                               'frm',
                                               'usr',
                                               'catr',
                                               'crsr',
                                               'grpr'
    )

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

---

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

• components/ILIAS/Export/classes/class.ilExport.php