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

Collaboration diagram for ilFileExporter:

Public Member Functions
	init ()
	Initialisation. More...
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get tail dependencies. More...
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	Get xml representation. More...
	getValidSchemaVersions (string $a_entity)
	Returns schema versions that the component can export to. More...
Public Member Functions inherited from ilXmlExporter
	__construct ()
	setExport (ilExport $a_exp)
	getExport ()
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	init ()
	setExportDirectories (string $a_dir_relative, string $a_dir_absolute)
	getRelativeExportDirectory ()
	getAbsoluteExportDirectory ()
	getXmlExportHeadDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get head dependencies. More...
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get tail dependencies. More...
	getValidSchemaVersions (string $a_entity)
	Returns schema versions that the component can export to. More...
	determineSchemaVersion (string $a_entity, string $a_target_release)

Additional Inherited Members
Static Public Member Functions inherited from ilXmlExporter
static	lookupExportDirectory (string $a_obj_type, int $a_obj_id, string $a_export_type='xml', string $a_entity="")
Protected Attributes inherited from ilXmlExporter
string	$dir_relative = ""
string	$dir_absolute = ""
ilExport	$exp

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 Exporter class for files

Author

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

Version

Id

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

Member Function Documentation

getValidSchemaVersions()

ilFileExporter::getValidSchemaVersions

(

string

$a_entity

)

Returns schema versions that the component can export to.

ILIAS chooses the first one, that has min/max constraints which fit to the target release. Please put the newest on top.

Definition at line 98 of file class.ilFileExporter.php.

                                                            : array
    {
        return array(
            "4.1.0" => array(
                "namespace" => "http://www.ilias.de/Modules/File/file/4_1",
                "xsd_file" => "ilias_file_4_1.xsd",
                "min" => "4.1.0",
                "max" => "",
            ),
        );
    }

getXmlExportTailDependencies()

ilFileExporter::getXmlExportTailDependencies	(	string	$a_entity,
		string	$a_target_release,
		array	$a_ids
	)

Get tail dependencies.

Parameters

string	entity
string	target release
array	ids

Returns

array array of array with keys "component", entity", "ids"

Definition at line 42 of file class.ilFileExporter.php.

                                                                                                          : array
    {
        $md_ids = [];
        foreach ($a_ids as $file_id) {
            $md_ids[] = $file_id . ":0:file";
        }

        return [
            [
                "component" => "Services/MetaData",
                "entity" => "md",
                "ids" => $md_ids,
            ],
            [
                "component" => "Services/Object",
                "entity" => "common",
                "ids" => $a_ids
            ]
        ];
    }

getXmlRepresentation()

ilFileExporter::getXmlRepresentation	(	string	$a_entity,
		string	$a_schema_version,
		string	$a_id
	)

Get xml representation.

Parameters

string	entity
string	target release
string	id

Returns

string xml string

Definition at line 71 of file class.ilFileExporter.php.

References ilFileXMLWriter\$CONTENT_ATTACH_COPY, $xml, ilObject\_lookupType(), ilXmlExporter\getAbsoluteExportDirectory(), ilXmlExporter\getRelativeExportDirectory(), and ilFileUtils\makeDirParents().

                                                                                                  : string
    {
        $xml = '';
        if (ilObject::_lookupType($a_id) == "file") {
            $file = new ilObjFile($a_id, false);
            $writer = new ilFileXMLWriter();
            $writer->setFile($file);
            $writer->setOmitHeader(true);
            $writer->setAttachFileContents(ilFileXMLWriter::$CONTENT_ATTACH_COPY);
            ilFileUtils::makeDirParents($this->getAbsoluteExportDirectory());
            $writer->setFileTargetDirectories(
                $this->getRelativeExportDirectory(),
                $this->getAbsoluteExportDirectory()
            );
            $writer->start();
            $xml = $writer->getXml();
        }

        return $xml;
    }

Here is the call graph for this function:

init()

ilFileExporter::init

(

)

Initialisation.

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

                          : void
    {
    }

---

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

• Modules/File/classes/class.ilFileExporter.php