ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilNewsExporter Class Reference

Exporter class for news. More...

+ Inheritance diagram for ilNewsExporter:
+ Collaboration diagram for ilNewsExporter:

Public Member Functions

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

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

Detailed Description

Exporter class for news.

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

Member Function Documentation

◆ getValidSchemaVersions()

ilNewsExporter::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 80 of file class.ilNewsExporter.php.

References array.

81  {
82  return array (
83  "4.1.0" => array(
84  "namespace" => "http://www.ilias.de/Services/News/news/4_1",
85  "xsd_file" => "ilias_news_4_1.xsd",
86  "uses_dataset" => true,
87  "min" => "4.1.0",
88  "max" => "")
89  );
90  }
Create styles array
The data for the language used.

◆ getXmlExportHeadDependencies()

ilNewsExporter::getXmlExportHeadDependencies (   $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 37 of file class.ilNewsExporter.php.

References ilNewsItem\_lookupMobId(), and array.

38  {
39 
40  include_once("./Services/News/classes/class.ilNewsItem.php");
41  $mob_ids = array();
42 
43  foreach ($a_ids as $id)
44  {
45  $mob_id = ilNewsItem::_lookupMobId($id);
46  if ($mob_id > 0)
47  {
48  $mob_ids[$mob_id] = $mob_id;
49  }
50  }
51 
52  return array (
53  array(
54  "component" => "Services/MediaObjects",
55  "entity" => "mob",
56  "ids" => $mob_ids)
57  );
58  }
static _lookupMobId($a_news_id)
Lookup mob id.
Create styles array
The data for the language used.
+ Here is the call graph for this function:

◆ getXmlRepresentation()

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

Get xml representation.

Parameters
stringentity
stringtarget release
stringid
Returns
string xml string

Definition at line 68 of file class.ilNewsExporter.php.

69  {
70  return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, $a_id, "", true, true);
71  }

◆ init()

ilNewsExporter::init ( )

Initialisation.

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

21  {
22  include_once("./Services/News/classes/class.ilNewsDataSet.php");
23  $this->ds = new ilNewsDataSet();
24  $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
25  $this->ds->setDSPrefix("ds");
26  }
News data set class.

Field Documentation

◆ $ds

ilNewsExporter::$ds
private

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


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