ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilHTMLLearningModuleExporter Class Reference

Exporter class for html learning modules. More...

+ Inheritance diagram for ilHTMLLearningModuleExporter:
+ Collaboration diagram for ilHTMLLearningModuleExporter:

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 html learning modules.

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

Member Function Documentation

◆ getValidSchemaVersions()

ilHTMLLearningModuleExporter::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 82 of file class.ilHTMLLearningModuleExporter.php.

83  {
84  return array(
85  "4.1.0" => array(
86  "namespace" => "http://www.ilias.de/Modules/HTMLLearningModule/htlm/4_1",
87  "xsd_file" => "ilias_htlm_4_1.xsd",
88  "uses_dataset" => true,
89  "min" => "4.1.0",
90  "max" => "")
91  );
92  }

◆ getXmlExportTailDependencies()

ilHTMLLearningModuleExporter::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 37 of file class.ilHTMLLearningModuleExporter.php.

References $id.

38  {
39  $deps = [];
40  $md_ids = [];
41  foreach ($a_ids as $id) {
42  $md_ids[] = $id . ":0:htlm";
43  }
44 
45  $deps[] = [
46  "component" => "Services/MetaData",
47  "entity" => "md",
48  "ids" => $md_ids
49  ];
50 
51  // service settings
52  $deps[] = [
53  "component" => "Services/Object",
54  "entity" => "common",
55  "ids" => $a_ids
56  ];
57 
58  return $deps;
59  }
if(!array_key_exists('StateId', $_REQUEST)) $id

◆ getXmlRepresentation()

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

Get xml representation.

Parameters
stringentity
stringtarget release
stringid
Returns
string xml string

Definition at line 69 of file class.ilHTMLLearningModuleExporter.php.

70  {
71  $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
72  return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, $a_id, "", true, true);
73  }

◆ init()

ilHTMLLearningModuleExporter::init ( )

Initialisation.

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

21  {
22  include_once("./Modules/HTMLLearningModule/classes/class.ilHTMLLearningModuleDataSet.php");
23  $this->ds = new ilHTMLLearningModuleDataSet();
24  $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
25  $this->ds->setDSPrefix("ds");
26  }
HTML learning module data set class.

Field Documentation

◆ $ds

ilHTMLLearningModuleExporter::$ds
private

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


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