ilFileExporter Class Reference

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

Protected Member Functions
	prepareExportDirectories (ilFileXMLWriter $writer)

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
ilExport	$exp

Detailed Description

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 28 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.

Reimplemented from ilXmlExporter.

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

                                                            : array
    {
        return [
            "4.1.0" => [
                "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"

Reimplemented from ilXmlExporter.

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

                                                                                                          : array
    {
        $md_ids = [];
        foreach ($a_ids as $file_id) {
            $md_ids[] = $file_id . ":0:file";
        }
 
        return [
            [
                "component" => "components/ILIAS/MetaData",
                "entity" => "md",
                "ids" => $md_ids,
            ],
            [
                "component" => "components/ILIAS/ILIASObject",
                "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

Reimplemented from ilXmlExporter.

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

                                                                                                  : string
    {
        $xml = '';
        if (ilObject::_lookupType((int) $a_id) === 'file') {
            $file = new ilObjFile((int) $a_id, false);
            $writer = new ilFileXMLWriter();
            $writer->setFile($file);
            $writer->setOmitHeader(true);
            $writer->setAttachFileContents(ilFileXMLWriter::$CONTENT_ATTACH_COPY);
            $this->prepareExportDirectories($writer);
            $writer->start();
            $xml = $writer->getXml();
        }
        return $xml;
    }

References ilFileXMLWriter\$CONTENT_ATTACH_COPY, ilObject\_lookupType(), and prepareExportDirectories().

Here is the call graph for this function:

init()

ilFileExporter::init

(

)

Initialisation.

Reimplemented from ilXmlExporter.

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

                          : void
    {
    }

prepareExportDirectories()

ilFileExporter::prepareExportDirectories ( ilFileXMLWriter  $writer )

protected

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

     : void {
        $path = str_replace('\\', '/', $this->exp->getExportDirInContainer());
        $segments = explode('/', $path);
        array_shift($segments);
        $target_dir_relative = implode('/', $segments) . '/expDir_1';
        $target_dir_absolute = rtrim($this->getAbsoluteExportDirectory(), '/') . '/' . $target_dir_relative;
        ilFileUtils::makeDirParents($target_dir_absolute);
        $writer->setFileTargetDirectories(
            $target_dir_relative,
            $target_dir_absolute
        );
    }

Referenced by getXmlRepresentation().

Here is the caller graph for this function:

---

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

• components/ILIAS/File/classes/class.ilFileExporter.php