ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
ilHelpExporter Class Reference

Exporter class for help system information. More...

+ Inheritance diagram for ilHelpExporter:
+ Collaboration diagram for ilHelpExporter:

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...
 
 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 help system information.

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

Member Function Documentation

◆ getValidSchemaVersions()

ilHelpExporter::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 87 of file class.ilHelpExporter.php.

88  {
89  return array (
90  "4.3.0" => array(
91  "namespace" => "http://www.ilias.de/Services/Help/help/4_3",
92  "xsd_file" => "ilias_help_4_3.xsd",
93  "uses_dataset" => true,
94  "min" => "4.3.0",
95  "max" => "")
96  );
97  }

◆ getXmlExportTailDependencies()

ilHelpExporter::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 36 of file class.ilHelpExporter.php.

References ilLMObject\getObjectList().

37  {
38  if ($a_entity == "help")
39  {
40  $lm_node_ids = array();
41  include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
42  foreach($a_ids as $lm_id)
43  {
44  $chaps = ilLMObject::getObjectList($lm_id, "st");
45  foreach ($chaps as $chap)
46  {
47  $lm_node_ids[] = $chap["obj_id"];
48  }
49  }
50 
51  return array (
52  array(
53  "component" => "Services/Help",
54  "entity" => "help_map",
55  "ids" => $lm_node_ids),
56  array(
57  "component" => "Services/Help",
58  "entity" => "help_tooltip",
59  "ids" => $a_ids)
60  );
61  }
62 
63  return array();
64  }
getObjectList($lm_id, $type="")
static
+ Here is the call graph for this function:

◆ getXmlRepresentation()

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

Get xml representation.

Parameters
stringentity
stringtarget release
stringid
Returns
string xml string

Definition at line 75 of file class.ilHelpExporter.php.

76  {
77  return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, $a_id, "", true, true);
78  }

◆ init()

ilHelpExporter::init ( )

Initialisation.

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

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

Field Documentation

◆ $ds

ilHelpExporter::$ds
private

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


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