ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
ilMediaPoolExporter Class Reference

Export2 class for media pools. More...

+ Inheritance diagram for ilMediaPoolExporter:
+ Collaboration diagram for ilMediaPoolExporter:

Public Member Functions

 init ()
 Initialisation. 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...
 
 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...
 

Private Attributes

 $ds
 

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

Export2 class for media pools.

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.ilMediaPoolExporter.php.

Member Function Documentation

◆ getValidSchemaVersions()

ilMediaPoolExporter::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 113 of file class.ilMediaPoolExporter.php.

114  {
115  return array (
116  "4.1.0" => array(
117  "namespace" => "http://www.ilias.de/Modules/MediaPool/mep/4_1",
118  "xsd_file" => "ilias_mep_4_1.xsd",
119  "uses_dataset" => true,
120  "min" => "4.1.0",
121  "max" => "")
122  );
123  }

◆ getXmlExportHeadDependencies()

ilMediaPoolExporter::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"

Definition at line 36 of file class.ilMediaPoolExporter.php.

References ilObjMediaPool\getAllMobIds().

37  {
38  include_once("./Modules/MediaPool/classes/class.ilObjMediaPool.php");
39  include_once("./Modules/MediaPool/classes/class.ilMediaPoolItem.php");
40  $pg_ids = array();
41  $mob_ids = array();
42 
43  foreach ($a_ids as $id)
44  {
45  $m_ids = ilObjMediaPool::getAllMobIds($id);
46  foreach ($m_ids as $m)
47  {
48  $mob_ids[] = $m;
49  }
50  }
51 
52  return array (
53  array(
54  "component" => "Services/MediaObjects",
55  "entity" => "mob",
56  "ids" => $mob_ids)
57  );
58  }
getAllMobIds($a_id)
Get all media object ids.
+ Here is the call graph for this function:

◆ getXmlExportTailDependencies()

ilMediaPoolExporter::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 69 of file class.ilMediaPoolExporter.php.

References ilMediaPoolItem\getIdsForType().

70  {
71  include_once("./Modules/MediaPool/classes/class.ilObjMediaPool.php");
72  include_once("./Modules/MediaPool/classes/class.ilMediaPoolItem.php");
73  $pg_ids = array();
74  $mob_ids = array();
75 
76  foreach ($a_ids as $id)
77  {
78  $pages = ilMediaPoolItem::getIdsForType($id, "pg");
79  foreach ($pages as $p)
80  {
81  $pg_ids[] = "mep:".$p;
82  }
83  }
84 
85  return array (
86  array(
87  "component" => "Services/COPage",
88  "entity" => "pg",
89  "ids" => $pg_ids)
90  );
91  }
static getIdsForType($a_id, $a_type)
Get all ids for type.
+ Here is the call graph for this function:

◆ getXmlRepresentation()

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

Get xml representation.

Parameters
stringentity
stringschema version
stringid
Returns
string xml string

Definition at line 101 of file class.ilMediaPoolExporter.php.

102  {
103  return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, $a_id, "", true, true);
104  }

◆ init()

ilMediaPoolExporter::init ( )

Initialisation.

Definition at line 20 of file class.ilMediaPoolExporter.php.

21  {
22  include_once("./Modules/MediaPool/classes/class.ilMediaPoolDataSet.php");
23  $this->ds = new ilMediaPoolDataSet();
24  $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
25  $this->ds->setDSPrefix("ds");
26  }
Media Pool Data set class.

Field Documentation

◆ $ds

ilMediaPoolExporter::$ds
private

Definition at line 15 of file class.ilMediaPoolExporter.php.


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