Inheritance diagram for ilExport:

Collaboration diagram for ilExport:

Public Member Functions
	__construct ()

	setExportDirInContainer (string $export_dir_in_container)

	setPathInfo (ExportPathInfoInterface $export_path_info)

	getExportDirInContainer ()

	getPathToComponentExpDirInContainer ()

	setExportDirectories (string $a_dir_relative, string $a_dir_absolute)

	getRelativeExportDirectory ()

	getAbsoluteExportDirectory ()

	setExportWriter (ilExportHandlerConsumerExportWriterInterface $export_writer,)

	getExportWriter ()

	getConfig (string $a_comp)
	Get configuration (note that configurations are optional, null may be returned!) More...

	exportObject (string $a_type, int $a_id, string $a_target_release="")
	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="")
	Export an ILIAS entity More...

	processExporter (string $a_comp, string $a_class, string $a_entity, string $a_target_release, ?array $a_id=null)
	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="")
	Get date of last export file More...

static	_getLastExportFileInformation (int $a_obj_id, string $a_type="", string $a_obj_type="")
	Get last export file information More...

static	_getExportDirectory (int $a_obj_id, string $a_type="xml", string $a_obj_type="", string $a_entity="")
	Get export directory for an repository object More...

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

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="")
	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

string	$export_dir_in_container

ExportPathInfoInterface	$export_path_info

Private Attributes
array	$configs = []

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 28 of file class.ilExport.php.

Constructor & Destructor Documentation

◆ __construct()

ilExport::__construct ( )

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

References $DIC.

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

Member Function Documentation

◆ _createExportDirectory()

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

static

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

References $DIC, $ilErr, _getExportDirectory(), ilObject\_lookupType(), and ilFileUtils\makeDirParents().

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

      : 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;
     }

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

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

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

References $DIC, Vendor\Package\$f, $lng, ilObject\_lookupTitle(), ilObject\_lookupType(), and ilUtil\getStyleSheetLocation().

      : 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);
     }

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

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 220 of file class.ilExport.php.

References $DIC, ilObject\_lookupType(), and ilFileUtils\getDataDir().

Referenced by ILIAS\Notes\Export\NotesHtmlExport\__construct(), _createExportDirectory(), _getExportFiles(), ilExportContainer\addSubitems(), ilObjBlogGUI\buildExportFile(), ilSAHSEditGUI\executeCommand(), ilObjFileBasedLMGUI\exportHTML(), ilExportContainer\exportObject(), exportObject(), ilObjUser\exportPersonalData(), ilCmiXapiDataSet\getDependencies(), ilDclContentExporter\getExportContentPath(), ilObjGlossary\getExportDirectory(), ilObjQuestionPool\getExportDirectory(), ilDclExportTableGUI\getExportFiles(), ilScormAiccDataSet\getExtendedXmlRepresentation(), ilDataCollectionExportOptionsXLSX\getFiles(), ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler\getFiles(), ilMediaPoolExportOptionXMLMaster\getFiles(), ILIAS\Export\ExportHandler\Info\Export\Handler\getLegacyExportRunDir(), ilObjUser\getPersonalDataExportFile(), ILIAS\Wiki\Export\WikiHtmlExport\getUserExportFile(), ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler\onDeleteFiles(), ilDataCollectionExportOptionsXLSX\onDeleteFiles(), ilMediaPoolExportOptionXMLMasterNoMedia\onDeleteFiles(), ilMediaPoolExportOptionXMLMaster\onDeleteFiles(), ilMediaPoolExportOptionXMLMaster\onDownloadFiles(), ilMediaPoolExportOptionXMLMasterNoMedia\onDownloadFiles(), ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler\onDownloadFiles(), ilMediaPoolExportOptionXMLMasterNoMedia\onDownloadWithLink(), ilMediaPoolExportOptionXMLMaster\onDownloadWithLink(), ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler\onDownloadWithLink(), ilHTLMExportOptionHTML\onExportOptionSelected(), ilOrgUnitExporter\sendAndCreateSimpleExportFile(), ilObjUser\sendPersonalDataFile(), ILIAS\Notes\Export\NotesHtmlExport\zipPackage(), and ILIAS\Wiki\Export\BlogHtmlExport\zipPackage().

      : 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;
     }

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

Parameters

int	$a_obj_id
string \| array	$a_export_types
string	$a_obj_type

Returns: array

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

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

Referenced by _getLastExportFileDate(), _getLastExportFileInformation(), ilExportTableGUI\getExportFiles(), and ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler\getFiles().

                                                                                                         : 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;
     }

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

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 180 of file class.ilExport.php.

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

Referenced by _getValidExportSubItems().

                                                                                                               : 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;
     }

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

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 198 of file class.ilExport.php.

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

      : ?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;
     }

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 151 of file class.ilExport.php.

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

Referenced by ilSubItemSelectionTableGUI\__construct().

                                                                  : 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;
     }

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 707 of file class.ilExport.php.

References $path.

                                                                                    : 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;
     }

◆ 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 = `""`
	)

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 484 of file class.ilExport.php.

References $c, $DIC, ilFileUtils\delDir(), IL_INST_ID, ILIAS_VERSION_NUMERIC, ilFileUtils\makeDirParents(), processExporter(), and ilFileUtils\zip().

      : 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
         );
     }

Here is the call graph for this function:

◆ exportObject()

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

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

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

References _createExportDirectory(), _getExportDirectory(), ilObject\_lookupTitle(), ilFileUtils\delDir(), IL_CAL_UNIX, IL_INST_ID, ILIAS_VERSION_NUMERIC, ilFileUtils\makeDirParents(), processExporter(), and ilFileUtils\zip().

      : 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
         );
     }

Here is the call graph for this function:

◆ getAbsoluteExportDirectory()

ilExport::getAbsoluteExportDirectory ( )

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

References $dir_absolute.

                                                 : string
     {
         return $this->dir_absolute;
     }

◆ getConfig()

ilExport::getConfig ( string $a_comp )

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

Parameters

string $a_comp component (e.g. "components/ILIAS/Glossary")

Returns: ilExportConfig $a_comp configuration object

Exceptions

ilExportException thronw if no config exists

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

                                              : ilExportConfig
     {
         // 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);
         $component = str_replace("_", "", $comp_arr[2]);
         $a_class = "il" . $component . "ExportConfig";
         $exp_config = new $a_class();
         $this->configs[$a_comp] = $exp_config;
         return $exp_config;
     }

◆ 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 80 of file class.ilExport.php.

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

◆ getExportWriter()

ilExport::getExportWriter ( )

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

References $export_writer.

                                      : 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 90 of file class.ilExport.php.

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

◆ getRelativeExportDirectory()

ilExport::getRelativeExportDirectory ( )

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

References $dir_relative.

                                                 : string
     {
         return $this->dir_relative;
     }

◆ processExporter()

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

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 564 of file class.ilExport.php.

References $id, IL_INST_ID, and ilFileUtils\makeDirParents().

Referenced by exportEntity(), and exportObject().

      : 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setExportDirectories()

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

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

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

◆ setExportDirInContainer()

ilExport::setExportDirInContainer ( string $export_dir_in_container )

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

References $export_dir_in_container.

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

◆ setExportWriter()

ilExport::setExportWriter ( ilExportHandlerConsumerExportWriterInterface $export_writer )

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

References $export_writer.

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

◆ setPathInfo()

ilExport::setPathInfo ( ExportPathInfoInterface $export_path_info )

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

References $export_path_info.

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

Field Documentation

◆ $cnt

array ilExport::$cnt = []

private

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

◆ $configs

array ilExport::$configs = []

private

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

◆ $dir_absolute

string ilExport::$dir_absolute = ""

protected

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

Referenced by getAbsoluteExportDirectory().

◆ $dir_relative

string ilExport::$dir_relative = ""

protected

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

Referenced by getRelativeExportDirectory().

◆ $export_dir_in_container

string ilExport::$export_dir_in_container

protected

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

Referenced by setExportDirInContainer().

◆ $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.

Referenced by setPathInfo().

◆ $export_run_dir

string ilExport::$export_run_dir = ''

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

◆ $export_writer

ilExportHandlerConsumerExportWriterInterface ilExport::$export_writer

protected

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

Referenced by getExportWriter(), and setExportWriter().

◆ $log

ilLogger ilExport::$log

protected

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

Referenced by ilExportContainer\exportObject().

◆ $manifest_writer

ilXmlWriter ilExport::$manifest_writer = null

private

Definition at line 56 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

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _createExportDirectory()

◆ _generateIndexFile()

◆ _getExportDirectory()

◆ _getExportFiles()

◆ _getLastExportFileDate()

◆ _getLastExportFileInformation()

◆ _getValidExportSubItems()

◆ createPathFromId()

◆ exportEntity()

◆ exportObject()

◆ getAbsoluteExportDirectory()

◆ getConfig()

◆ getExportDirInContainer()

◆ getExportWriter()

◆ getPathToComponentExpDirInContainer()

◆ getRelativeExportDirectory()

◆ processExporter()

◆ setExportDirectories()

◆ setExportDirInContainer()

◆ setExportWriter()

◆ setPathInfo()

Field Documentation

◆ $cnt

◆ $configs

◆ $dir_absolute

◆ $dir_relative

◆ $export_dir_in_container

◆ $export_implementer

◆ $export_path_info

◆ $export_run_dir

◆ $export_writer

◆ $log

◆ $manifest_writer

◆ $new_file_structure