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)

Protected Attributes
ILIAS Help InternalDomainService	$help_domain
Protected Attributes inherited from ilXmlExporter
ilExport	$exp

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="")

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

                                                            : array
    {
        return array(
            "10.0" => array(
                "namespace" => "https://www.ilias.de/Services/Help/help/10_0",
                "xsd_file" => "ilias_help_10.xsd",
                "uses_dataset" => true,
                "min" => "10.0",
                "max" => ""),
            "4.3.0" => array(
                "namespace" => "https://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	(	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 39 of file class.ilHelpExporter.php.

     : array {
        if ($a_entity === "help") {
            $lm_node_ids = array();
            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" => "components/ILIAS/Help",
                    "entity" => "help_map",
                    "ids" => $lm_node_ids),
                array(
                    "component" => "components/ILIAS/Help",
                    "entity" => "help_tooltip",
                    "ids" => $a_ids)
                );
        }
 
        if ($a_entity === "gdtr") {
            $res = [];
            // step pages
            $pg_ids = [];
            $step_ids = [];
            foreach ($a_ids as $id) {
                foreach ($this->help_domain->guidedTour()->step()->getStepsOfTour((int) $id) as $step) {
                    $pg_ids[] = "gdtr:" . $step->getId();
                    $step_ids[] = $step->getId();
                }
            }
            if (count($pg_ids)) {
                $res[] = [
                    "component" => "components/ILIAS/Help",
                    "entity" => "gdtr_step",
                    "ids" => $step_ids];
                $res[] = array(
                    "component" => "components/ILIAS/COPage",
                    "entity" => "pg",
                    "ids" => $pg_ids
                );
            }
            return $res;
        }
 
 
        return array();
    }

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

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

init()

ilHelpExporter::init

(

)

Reimplemented from ilXmlExporter.

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

                          : void
    {
        global $DIC;
 
        $this->ds = new ilHelpDataSet();
        $this->ds->initByExporter($this);
        $this->ds->setDSPrefix("ds");
        $this->help_domain = $DIC->help()->internal()->domain();
    }

References $DIC.

Field Documentation

$ds

ilHelpDataSet ilHelpExporter::$ds

private

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

$help_domain

ILIAS Help InternalDomainService ilHelpExporter::$help_domain

protected

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

---

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

• components/ILIAS/Help/Export/class.ilHelpExporter.php