ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilHelpExporter Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

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

Public Member Functions

 init ()
 
 getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
 Get tail dependencies. More...
 
 getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
 
 getValidSchemaVersions (string $a_entity)
 Returns schema versions that the component can export to. More...
 
- Public Member Functions inherited from ilXmlExporter
 __construct ()
 
 setExport (ilExport $a_exp)
 
 getExport ()
 
 getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
 
 init ()
 
 setExportDirectories (string $a_dir_relative, string $a_dir_absolute)
 
 getRelativeExportDirectory ()
 
 getAbsoluteExportDirectory ()
 
 getXmlExportHeadDependencies (string $a_entity, string $a_target_release, array $a_ids)
 Get head dependencies. More...
 
 getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
 Get tail dependencies. More...
 
 getValidSchemaVersions (string $a_entity)
 Returns schema versions that the component can export to. More...
 
 determineSchemaVersion (string $a_entity, string $a_target_release)
 

Private Attributes

ilHelpDataSet $ds
 

Additional Inherited Members

- Static Public Member Functions inherited from ilXmlExporter
static lookupExportDirectory (string $a_obj_type, int $a_obj_id, string $a_export_type='xml', string $a_entity="")
 
- Protected Attributes inherited from ilXmlExporter
ilExport $exp
 

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Exporter class for help system information

Author
Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

◆ getValidSchemaVersions()

ilHelpExporter::getValidSchemaVersions ( string  $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. Example: return array ( "4.1.0" => array( "namespace" => "http://www.ilias.de/Services/MetaData/md/4_1", "xsd_file" => "ilias_md_4_1.xsd", "min" => "4.1.0", "max" => "") );

Reimplemented from ilXmlExporter.

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

72 : array
73 {
74 return array(
75 "10.0" => array(
76 "namespace" => "https://www.ilias.de/Services/Help/help/10_0",
77 "xsd_file" => "ilias_help_10.xsd",
78 "uses_dataset" => true,
79 "min" => "10.0",
80 "max" => ""),
81 "4.3.0" => array(
82 "namespace" => "https://www.ilias.de/Services/Help/help/4_3",
83 "xsd_file" => "ilias_help_4_3.xsd",
84 "uses_dataset" => true,
85 "min" => "4.3.0",
86 "max" => "")
87 );
88 }

◆ getXmlExportTailDependencies()

ilHelpExporter::getXmlExportTailDependencies ( string  $a_entity,
string  $a_target_release,
array  $a_ids 
)

Get tail dependencies.

Returns
array array of array with keys "component", entity", "ids"

Reimplemented from ilXmlExporter.

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

39 : array {
40 if ($a_entity === "help") {
41 $lm_node_ids = array();
42 foreach ($a_ids as $lm_id) {
43 $chaps = ilLMObject::getObjectList($lm_id, "st");
44 foreach ($chaps as $chap) {
45 $lm_node_ids[] = $chap["obj_id"];
46 }
47 }
48
49 return array(
50 array(
51 "component" => "components/ILIAS/Help",
52 "entity" => "help_map",
53 "ids" => $lm_node_ids),
54 array(
55 "component" => "components/ILIAS/Help",
56 "entity" => "help_tooltip",
57 "ids" => $a_ids)
58 );
59 }
60
61 return array();
62 }
static getObjectList(int $lm_id, string $type="")

References ilLMObject\getObjectList().

+ Here is the call graph for this function:

◆ getXmlRepresentation()

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

Reimplemented from ilXmlExporter.

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

68 : string {
69 return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, [$a_id], "", true, true);
70 }

◆ init()

ilHelpExporter::init ( )

Reimplemented from ilXmlExporter.

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

28 : void
29 {
30 $this->ds = new ilHelpDataSet();
31 $this->ds->initByExporter($this);
32 $this->ds->setDSPrefix("ds");
33 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

Field Documentation

◆ $ds

ilHelpDataSet ilHelpExporter::$ds
private

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


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