ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilXmlExporter Class Reference

Xml Exporter class. More...

+ Inheritance diagram for ilXmlExporter:
+ Collaboration diagram for ilXmlExporter:

Public Member Functions

 __construct ()
 Constructor. More...
 
 setExport (ilExport $a_exp)
 Set export object. More...
 
 getExport ()
 Get export. 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...
 

Static Public Member Functions

static lookupExportDirectory ($a_obj_type, $a_obj_id, $a_export_type='xml', $a_entity="")
 export directory lookup More...
 

Protected Attributes

 $dir_relative
 
 $dir_absolute
 
 $exp
 

Detailed Description

Xml Exporter class.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 11 of file class.ilXmlExporter.php.

Constructor & Destructor Documentation

◆ __construct()

ilXmlExporter::__construct ( )

Constructor.

Parameters

return

Reimplemented in ilCourseExporter, ilFolderExporter, ilGroupExporter, ilWebResourceExporter, ilAccessControlExporter, and ilContainerExporter.

Definition at line 23 of file class.ilXmlExporter.php.

24 {
25
26 }

Member Function Documentation

◆ determineSchemaVersion()

ilXmlExporter::determineSchemaVersion (   $a_entity,
  $a_target_release 
)
final

Determine schema version.

Parameters

return

Definition at line 160 of file class.ilXmlExporter.php.

161 {
162 $svs = $this->getValidSchemaVersions($a_entity);
163 $found = false;
164 foreach ($svs as $k => $sv)
165 {
166 if (!$found)
167 {
168 if (version_compare($sv["min"], ILIAS_VERSION_NUMERIC, "<=")
169 && ($sv["max"] == "" || version_compare($sv["max"], ILIAS_VERSION_NUMERIC, ">=")))
170 {
171 $rsv = $sv;
172 $rsv["schema_version"] = $k;
173 $found = true;
174 }
175 }
176 }
177
178 return $rsv;
179 }
getValidSchemaVersions($a_entity)
Returns schema versions that the component can export to.
const ILIAS_VERSION_NUMERIC

References getValidSchemaVersions(), and ILIAS_VERSION_NUMERIC.

+ Here is the call graph for this function:

◆ getAbsoluteExportDirectory()

ilXmlExporter::getAbsoluteExportDirectory ( )

◆ getExport()

ilXmlExporter::getExport ( )

Get export.

Returns
ilExport export object

Definition at line 43 of file class.ilXmlExporter.php.

44 {
45 return $this->exp;
46 }

References $exp.

Referenced by ilLearningModuleExporter\getXmlRepresentation(), ilLearningModuleExporter\init(), ilMediaPoolExporter\init(), and ilCOPageExporter\init().

+ Here is the caller graph for this function:

◆ getRelativeExportDirectory()

ilXmlExporter::getRelativeExportDirectory ( )

Get relative export directory.

Returns
string relative directory

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

96 {
98 }

References $dir_relative.

Referenced by ilFileExporter\getXmlRepresentation(), and ilForumExporter\getXmlRepresentation().

+ Here is the caller graph for this function:

◆ getValidSchemaVersions()

ilXmlExporter::getValidSchemaVersions (   $a_entity)
abstract

◆ getXmlExportHeadDependencies()

ilXmlExporter::getXmlExportHeadDependencies (   $a_entity,
  $a_target_release,
  $a_ids 
)

Get head dependencies.

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

Reimplemented in ilCategoryExporter, ilCourseExporter, ilDataCollectionExporter, ilFolderExporter, ilGroupExporter, ilMediaPoolExporter, ilAccessControlExporter, ilAdvancedMetaDataExporter, ilContainerReferenceExporter, ilCOPageExporter, ilNewsExporter, and ilTaxonomyExporter.

Definition at line 118 of file class.ilXmlExporter.php.

119 {
120 return array();
121 }

◆ getXmlExportTailDependencies()

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

◆ getXmlRepresentation()

◆ init()

◆ lookupExportDirectory()

static ilXmlExporter::lookupExportDirectory (   $a_obj_type,
  $a_obj_id,
  $a_export_type = 'xml',
  $a_entity = "" 
)
static

export directory lookup

Returns
string export directory

Reimplemented in ilTestQuestionPoolExporter.

Definition at line 52 of file class.ilXmlExporter.php.

53 {
54 $ent = ($a_entity == "")
55 ? ""
56 : "_".$a_entity;
57
58 if($a_export_type == 'xml')
59 {
60 return ilUtil::getDataDir()."/".$a_obj_type.$ent."_data"."/".$a_obj_type."_".$a_obj_id."/export";
61 }
62 return ilUtil::getDataDir()."/".$a_obj_type.$ent."_data"."/".$a_obj_type."_".$a_obj_id."/export_".$a_export_type;
63 }
static getDataDir()
get data directory (outside webspace)

References ilUtil\getDataDir().

+ Here is the call graph for this function:

◆ setExport()

ilXmlExporter::setExport ( ilExport  $a_exp)

Set export object.

Parameters
ilExport$a_expexport object

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

34 {
35 $this->exp = $a_exp;
36 }

◆ setExportDirectories()

ilXmlExporter::setExportDirectories (   $a_dir_relative,
  $a_dir_absolute 
)

Export directories.

Parameters
stringrelative directory
stringabsolute directory

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

85 {
86 $this->dir_relative = $a_dir_relative;
87 $this->dir_absolute = $a_dir_absolute;
88 }

Field Documentation

◆ $dir_absolute

ilXmlExporter::$dir_absolute
protected

Definition at line 14 of file class.ilXmlExporter.php.

Referenced by getAbsoluteExportDirectory().

◆ $dir_relative

ilXmlExporter::$dir_relative
protected

Definition at line 13 of file class.ilXmlExporter.php.

Referenced by getRelativeExportDirectory().

◆ $exp

ilXmlExporter::$exp
protected

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