ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f87
ilFileExporter Class Reference

Exporter class for files. More...

+ Inheritance diagram for ilFileExporter:
+ Collaboration diagram for ilFileExporter:

Public Member Functions

 init ()
 Initialisation. More...
 
 getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
 Get tail dependencies. More...
 
 getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
 Get xml representation. More...
 
 getValidSchemaVersions ($a_entity)
 Returns schema versions that the component can export to. More...
 
- Public Member Functions inherited from ilXmlExporter
 __construct ()
 Constructor. More...
 
 getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
 Get xml representation. More...
 
 init ()
 
 setExportDirectories ($a_dir_relative, $a_dir_absolute)
 Export directories. More...
 
 getRelativeExportDirectory ()
 Get relative export directory. More...
 
 getAbsoluteExportDirectory ()
 Get absolute export directory. More...
 
 getXmlExportHeadDependencies ($a_entity, $a_target_release, $a_ids)
 Get head dependencies. More...
 
 getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
 Get tail dependencies. More...
 
 getValidSchemaVersions ($a_entity)
 Returns schema versions that the component can export to. More...
 
 determineSchemaVersion ($a_entity, $a_target_release)
 Determine schema version. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ilXmlExporter
static lookupExportDirectory ($a_obj_type, $a_obj_id, $a_export_type='xml', $a_entity="")
 export directory lookup More...
 
- Protected Attributes inherited from ilXmlExporter
 $dir_relative
 
 $dir_absolute
 

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 13 of file class.ilFileExporter.php.

Member Function Documentation

◆ getValidSchemaVersions()

ilFileExporter::getValidSchemaVersions (   $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.

Returns

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

85  {
86  return array (
87  "4.1.0" => array(
88  "namespace" => "http://www.ilias.de/Modules/File/file/4_1",
89  "xsd_file" => "ilias_file_4_1.xsd",
90  "min" => "4.1.0",
91  "max" => "")
92  );
93  }

◆ getXmlExportTailDependencies()

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

Get tail dependencies.

Parameters
stringentity
stringtarget release
arrayids
Returns
array array of array with keys "component", entity", "ids"

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

32  {
33  $md_ids = array();
34  foreach ($a_ids as $file_id)
35  {
36  $md_ids[] = $file_id.":0:file";
37  }
38 
39  return array (
40  array(
41  "component" => "Services/MetaData",
42  "entity" => "md",
43  "ids" => $md_ids)
44  );
45  }

◆ getXmlRepresentation()

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

Get xml representation.

Parameters
stringentity
stringtarget release
stringid
Returns
string xml string

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

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

56  {
57 
58  include_once("./Modules/File/classes/class.ilObjFile.php");
59  include_once("./Modules/File/classes/class.ilFileXMLWriter.php");
60  if (ilObject::_lookupType($a_id) == "file")
61  {
62  $file = new ilObjFile($a_id, false);
63  $writer = new ilFileXMLWriter();
64  $writer->setFile($file);
65  $writer->setOmitHeader(true);
66  $writer->setAttachFileContents(ilFileXMLWriter::$CONTENT_ATTACH_COPY);
68  $writer->setFileTargetDirectories($this->getRelativeExportDirectory(),
70  $writer->start();
71  $xml.= $writer->getXml();
72  }
73 
74  return $xml;
75  }
static makeDirParents($a_dir)
Create a new directory and all parent directories.
print $file
getRelativeExportDirectory()
Get relative export directory.
Class ilObjFile.
getAbsoluteExportDirectory()
Get absolute export directory.
static _lookupType($a_id, $a_reference=false)
lookup object type
XML writer class.
+ Here is the call graph for this function:

◆ init()

ilFileExporter::init ( )

Initialisation.

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

20  {
21  }

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