ilObjectExporter 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 ilObjectExporter:

Collaboration diagram for ilObjectExporter:

Public Member Functions
	init ()
	getXmlExportTailDependencies (string $entity, string $target_release, array $ids)
	Get tail dependencies. More...
	getXmlRepresentation (string $entity, string $schema_version, string $id)
	getValidSchemaVersions (string $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
ilObjectDataSet	$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
string	$dir_relative = ""
string	$dir_absolute = ""
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 object related data (please note that title and description are usually included in the specific object exporter classes, this class takes care of additional general object related data (e.g. translations)

Author

Alex Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

getValidSchemaVersions()

ilObjectExporter::getValidSchemaVersions

(

string

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

Definition at line 59 of file class.ilObjectExporter.php.

                                                          : array
    {
        return [
            "5.4.0" => [
                "namespace" => "http://www.ilias.de/Services/Object/obj/5_4",
                "xsd_file" => "ilias_obj_5_4.xsd",
                "uses_dataset" => true,
                "min" => "5.4.0",
                "max" => ""
            ],
            "5.1.0" => [
                "namespace" => "http://www.ilias.de/Services/Object/obj/5_1",
                "xsd_file" => "ilias_obj_5_1.xsd",
                "uses_dataset" => true,
                "min" => "5.1.0",
                "max" => "5.3.99"
            ],
            "4.4.0" => [
                "namespace" => "http://www.ilias.de/Services/Object/obj/4_4",
                "xsd_file" => "ilias_obj_4_4.xsd",
                "uses_dataset" => true,
                "min" => "4.4.0",
                "max" => "5.0.99"
            ]
        ];
    }

getXmlExportTailDependencies()

ilObjectExporter::getXmlExportTailDependencies	(	string	$entity,
		string	$target_release,
		array	$ids
	)

Get tail dependencies.

Returns

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

Definition at line 43 of file class.ilObjectExporter.php.

                                                                                                    : array
    {
        return array();
    }

getXmlRepresentation()

ilObjectExporter::getXmlRepresentation	(	string	$entity,
		string	$schema_version,
		string	$id
	)

Definition at line 48 of file class.ilObjectExporter.php.

                                                                                            : string
    {
        $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
        return $this->ds->getXmlRepresentation($entity, $schema_version, [$id], "", true, true);
    }

init()

ilObjectExporter::init

(

)

Definition at line 32 of file class.ilObjectExporter.php.

                          : void
    {
        $this->ds = new ilObjectDataSet();
        $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
        $this->ds->setDSPrefix("ds");
    }

Field Documentation

$ds

ilObjectDataSet ilObjectExporter::$ds

private

Definition at line 30 of file class.ilObjectExporter.php.

---

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

• Services/Object/classes/class.ilObjectExporter.php