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

Collaboration diagram for ilExportContainer:

Public Member Functions
	__construct (ilExportOptions $eo)
	Constructor. More...
	exportObject (string $a_type, int $a_id, string $a_target_release="")
	@inheritDoc More...
Public Member Functions inherited from ilExport
	__construct ()
	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...

Protected Member Functions
	manifestWriterBegin (string $a_type, int $a_id, string $a_target_release)
	addContainer ()
	addSubitems (int $a_id, string $a_type, string $a_target_release)
	manifestWriterEnd (string $a_type, int $a_id, string $a_target_release)

Private Attributes
string	$cont_export_dir = ''
ilXmlWriter	$cont_manifest_writer = null
ilExportOptions	$eo

Additional Inherited Members
Static Public Member Functions inherited from ilExport
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 inherited from ilExport
string	$export_run_dir = ''
Static Protected Member Functions inherited from ilExport
static	createPathFromId (int $a_container_id, string $a_name)
Protected Attributes inherited from ilExport
ilLogger	$log

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 Export Container

Author

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

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

Constructor & Destructor Documentation

__construct()

ilExportContainer::__construct

(

ilExportOptions

$eo

)

Constructor.

Parameters

ilExportOptions

$eo

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

    {
        $this->eo = $eo;
        parent::__construct();
    }

References $eo, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

addContainer()

ilExportContainer::addContainer ( )

protected

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

                                     : void
    {
    }

Referenced by exportObject().

Here is the caller graph for this function:

addSubitems()

ilExportContainer::addSubitems ( int  $a_id, string  $a_type, string  $a_target_release  )

protected

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

                                                                                       : void
    {
        $set_number = 1;
        foreach ($this->eo->getSubitemsForExport() as $ref_id) {
            // get last export file
            $obj_id = ilObject::_lookupObjId($ref_id);
 
            $expi = ilExportFileInfo::lookupLastExport($obj_id, 'xml', $a_target_release);
 
            if (!$expi instanceof ilExportFileInfo) {
                $this->log->warning('Cannot find export file for refId ' . $ref_id . ', type ' . ilObject::_lookupType($a_id));
                continue;
            }
 
            $exp_dir = ilExport::_getExportDirectory($obj_id, 'xml', ilObject::_lookupType($obj_id));
            $exp_full = $exp_dir . DIRECTORY_SEPARATOR . $expi->getFilename();
 
            $this->log->debug('Zip path ' . $exp_full);
 
            // Unzip
            ilFileUtils::unzip($exp_full, true, false);
 
            // create set directory
            ilFileUtils::makeDirParents($this->cont_export_dir . DIRECTORY_SEPARATOR . 'set_' . $set_number);
 
            // cut .zip
            $new_path_rel = 'set_' . $set_number . DIRECTORY_SEPARATOR . $expi->getBasename();
            $new_path_abs = $this->cont_export_dir . DIRECTORY_SEPARATOR . $new_path_rel;
 
            $this->log->debug($new_path_rel . ' ' . $new_path_abs);
 
            // Move export
            rename(
                $exp_dir . DIRECTORY_SEPARATOR . $expi->getBasename(),
                $new_path_abs
            );
 
            $this->log->debug($exp_dir . DIRECTORY_SEPARATOR . $expi->getBasename() . ' -> ' . $new_path_abs);
 
            // Delete latest container xml of source
            if ($a_id == $obj_id) {
                $expi->delete();
                if (file_exists($exp_full)) {
                    $this->log->info('Deleting' . $exp_full);
                    unlink($exp_full);
                }
            }
 
            $this->cont_manifest_writer->xmlElement(
                'ExportSet',
                array(
                    'Path' => $new_path_rel,
                    'Type' => ilObject::_lookupType($obj_id)
                )
            );
            ++$set_number;
        }
    }

References $ref_id, ilExport\_getExportDirectory(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilExportFileInfo\lookupLastExport(), ilFileUtils\makeDirParents(), and ilFileUtils\unzip().

Referenced by exportObject().

Here is the call graph for this function:

Here is the caller graph for this function:

exportObject()

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

@inheritDoc

Reimplemented from ilExport.

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

                                                                                          : array
    {
        $log = $GLOBALS['DIC']->logger()->exp();
 
        // 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";
        }
 
        // Create base export directory
        ilExport::_createExportDirectory($a_id, "xml", $a_type);
        $export_dir = ilExport::_getExportDirectory($a_id, "xml", $a_type);
        $ts = time();
        $sub_dir = $ts . "__" . IL_INST_ID . "__" . $a_type . "_" . $a_id;
 
        $this->cont_export_dir = $export_dir . DIRECTORY_SEPARATOR . $sub_dir;
        ilFileUtils::makeDirParents($this->cont_export_dir);
 
        $log->debug('Using base directory: ' . $this->export_run_dir);
 
        $this->manifestWriterBegin($a_type, $a_id, $a_target_release);
        $this->addContainer();
        $this->addSubitems($a_id, $a_type, $a_target_release);
        $this->manifestWriterEnd($a_type, $a_id, $a_target_release);
 
        ilFileUtils::zip($this->cont_export_dir, $this->cont_export_dir . '.zip');
        ilFileUtils::delDir($this->cont_export_dir);
        return [];
    }

References $GLOBALS, ilExport\$log, ilExport\_createExportDirectory(), ilExport\_getExportDirectory(), addContainer(), addSubitems(), ilLogger\debug(), ilFileUtils\delDir(), IL_INST_ID, ILIAS_VERSION_NUMERIC, ilFileUtils\makeDirParents(), manifestWriterBegin(), manifestWriterEnd(), and ilFileUtils\zip().

Here is the call graph for this function:

manifestWriterBegin()

ilExportContainer::manifestWriterBegin ( string  $a_type, int  $a_id, string  $a_target_release  )

protected

Definition at line 75 of file class.ilExportContainer.php.

                                                                                               : void
    {
        $this->cont_manifest_writer = new ilXmlWriter();
        $this->cont_manifest_writer->xmlHeader();
        $this->cont_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
            )
        );
    }

References ilObject\_lookupTitle(), and IL_INST_ID.

Referenced by exportObject().

Here is the call graph for this function:

Here is the caller graph for this function:

manifestWriterEnd()

ilExportContainer::manifestWriterEnd ( string  $a_type, int  $a_id, string  $a_target_release  )

protected

Definition at line 154 of file class.ilExportContainer.php.

                                                                                             : void
    {
        $this->cont_manifest_writer->xmlEndTag('Manifest');
        $this->log->debug($this->cont_export_dir . DIRECTORY_SEPARATOR . 'manifest.xml');
        $this->cont_manifest_writer->xmlDumpFile($this->cont_export_dir . DIRECTORY_SEPARATOR . 'manifest.xml', true);
    }

Referenced by exportObject().

Here is the caller graph for this function:

Field Documentation

$cont_export_dir

string ilExportContainer::$cont_export_dir = ''

private

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

$cont_manifest_writer

ilXmlWriter ilExportContainer::$cont_manifest_writer = null

private

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

$eo

ilExportOptions ilExportContainer::$eo

private

Definition at line 29 of file class.ilExportContainer.php.

Referenced by __construct().

---

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

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