ilCmiXapiExporter Class Reference

Inheritance diagram for ilCmiXapiExporter:

Collaboration diagram for ilCmiXapiExporter:

Public Member Functions
	__construct ()
	init ()
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	Get xml representation. More...
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get tail dependencies. More...
	getValidSchemaVersions (string $a_entity)
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)

Data Fields
const	ENTITY = 'cmix'
const	SCHEMA_VERSION = '5.1.0'

Private Attributes
ilCmiXapiDataSet	$_dataset = null

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

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

Constructor & Destructor Documentation

__construct()

ilCmiXapiExporter::__construct

(

)

Reimplemented from ilXmlExporter.

Definition at line 38 of file class.ilCmiXapiExporter.php.

    {
        parent::__construct();
        $this->_dataset = new ilCmiXapiDataSet();
        //todo check
        $this->_dataset->initByExporter($this);
        $this->_dataset->setDSPrefix("ds");
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

getValidSchemaVersions()

ilCmiXapiExporter::getValidSchemaVersions

(

string

$a_entity

)

Returns

array<string, array<string, string|bool>>

Reimplemented from ilXmlExporter.

Definition at line 84 of file class.ilCmiXapiExporter.php.

                                                            : array
    {
        return array(
            "5.1.0" => array(
                "namespace" => "http://www.ilias.de/Modules/CmiXapi/cmix/5_1",
                "xsd_file" => "xml/ilias_cmix_5_1.xsd",
                "uses_dataset" => true,
                "min" => "5.1.0",
                "max" => "")
        );
    }

getXmlExportTailDependencies()

ilCmiXapiExporter::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 59 of file class.ilCmiXapiExporter.php.

     : array {
        $dependencies = [];
 
        $md_ids = [];
        foreach ($a_ids as $id) {
            $md_ids[] = $id . ":0:cmix";
        }
        if ($md_ids !== []) {
            $dependencies[] = [
                "component" => "components/ILIAS/MetaData",
                "entity" => "md",
                "ids" => $md_ids
            ];
        }
 
        return $dependencies;
    }

References $id.

getXmlRepresentation()

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

Get xml representation.

Reimplemented from ilXmlExporter.

Definition at line 54 of file class.ilCmiXapiExporter.php.

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

init()

ilCmiXapiExporter::init

(

)

Reimplemented from ilXmlExporter.

Definition at line 47 of file class.ilCmiXapiExporter.php.

                          : void
    {
    }

Field Documentation

$_dataset

ilCmiXapiDataSet ilCmiXapiExporter::$_dataset = null

private

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

ENTITY

const ilCmiXapiExporter::ENTITY = 'cmix'

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

SCHEMA_VERSION

const ilCmiXapiExporter::SCHEMA_VERSION = '5.1.0'

Definition at line 33 of file class.ilCmiXapiExporter.php.

---

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

• components/ILIAS/CmiXapi/classes/class.ilCmiXapiExporter.php