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

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

        {
                return array (
                        "4.3.0" => array(
                                "namespace" => "http://www.ilias.de/Services/Help/help/4_3",
                                "xsd_file" => "ilias_help_4_3.xsd",
                                "uses_dataset" => true,
                                "min" => "4.3.0",
                                "max" => "")
                );
        }

getXmlExportTailDependencies()

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

Get tail dependencies.

Parameters

string	entity
string	target release
array	ids

Returns

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

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

References ilLMObject\getObjectList().

        {
                if ($a_target_release == "4.3.0")
                {
                        if ($a_entity == "help")
                        {
                                $lm_node_ids = array();
                                include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                                foreach($a_ids as $lm_id)
                                {
                                        $chaps = ilLMObject::getObjectList($lm_id, "st");
                                        foreach ($chaps as $chap)
                                        {
                                                $lm_node_ids[] = $chap["obj_id"];
                                        }
                                }
                                        
                                return array (
                                        array(
                                                "component" => "Services/Help",
                                                "entity" => "help_map",
                                                "ids" => $lm_node_ids),
                                        array(
                                                "component" => "Services/Help",
                                                "entity" => "help_tooltip",
                                                "ids" => $a_ids)
                                        );
                        }
                }
                
                return array();
        }

Here is the call graph for this function:

getXmlRepresentation()

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

Get xml representation.

Parameters

string	entity
string	target release
string	id

Returns

string xml string

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

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

init()

ilHelpExporter::init

(

)

Initialisation.

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

        {
                include_once("./Services/Help/classes/class.ilHelpDataSet.php");
                $this->ds = new ilHelpDataSet();
                $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
                $this->ds->setDSPrefix("ds");
        }

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:

• Services/Help/classes/class.ilHelpExporter.php