ilXmlExporter Class Reference

Xml Exporter class. More...

Inheritance diagram for ilXmlExporter:

Collaboration diagram for ilXmlExporter:

Public Member Functions
	__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)

Static Public Member Functions
static	lookupExportDirectory (string $a_obj_type, int $a_obj_id, string $a_export_type='xml', string $a_entity="")

Protected Attributes
ilExport	$exp

Detailed Description

Xml Exporter class.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilXmlExporter::__construct

(

)

Definition at line 31 of file class.ilXmlExporter.php.

    {
    }

Member Function Documentation

determineSchemaVersion()

ilXmlExporter::determineSchemaVersion ( string  $a_entity, string  $a_target_release  )

final

Definition at line 122 of file class.ilXmlExporter.php.

References getValidSchemaVersions(), and ILIAS_VERSION_NUMERIC.

     : array {
        $svs = $this->getValidSchemaVersions($a_entity);
        $rsv = [];
        foreach ($svs as $k => $sv) {
            $min_version = $sv["min"] ?? "";
            $max_version = $sv["max"] ?? "";
            if (
                ($min_version === "" || version_compare($min_version, ILIAS_VERSION_NUMERIC, "<=")) &&
                ($max_version === "" || version_compare($max_version, ILIAS_VERSION_NUMERIC, ">="))
            ) {
                $rsv = $sv;
                $rsv["schema_version"] = $k;
                break;
            }
        }
        return $rsv;
    }

Here is the call graph for this function:

getAbsoluteExportDirectory()

ilXmlExporter::getAbsoluteExportDirectory

(

)

Definition at line 79 of file class.ilXmlExporter.php.

Referenced by ilStyleExporter\getXmlRepresentation(), ilContentPageExporter\getXmlRepresentation(), ilForumExporter\getXmlRepresentation(), ilIndividualAssessmentExporter\getXmlRepresentation(), ilMediaObjectsExporter\getXmlRepresentation(), ilBibliographicExporter\getXmlRepresentation(), ilDataCollectionExporter\getXmlRepresentation(), ilTestExporter\getXmlRepresentation(), and ilFileExporter\prepareExportDirectories().

                                                : string
    {
        return $this->exp->getAbsoluteExportDirectory();
    }

Here is the caller graph for this function:

getExport()

ilXmlExporter::getExport

(

)

Definition at line 40 of file class.ilXmlExporter.php.

References $exp.

Referenced by ilLearningModuleExporter\getXmlRepresentation(), ilMediaPoolExporter\init(), ilLearningModuleExporter\init(), ilSkillExporter\init(), and ilDataSet\initByExporter().

                               : ilExport
    {
        return $this->exp;
    }

Here is the caller graph for this function:

getRelativeExportDirectory()

ilXmlExporter::getRelativeExportDirectory

(

)

Definition at line 74 of file class.ilXmlExporter.php.

                                                : string
    {
        return $this->exp->getRelativeExportDirectory();
    }

getValidSchemaVersions()

ilXmlExporter::getValidSchemaVersions ( string  $a_entity )

abstract

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

Referenced by determineSchemaVersion(), and getXmlExportTailDependencies().

Here is the caller graph for this function:

getXmlExportHeadDependencies()

ilXmlExporter::getXmlExportHeadDependencies	(	string	$a_entity,
		string	$a_target_release,
		array	$a_ids
	)

Get head dependencies.

Returns

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

Definition at line 88 of file class.ilXmlExporter.php.

     : array {
        return [];
    }

getXmlExportTailDependencies()

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

Get tail dependencies.

Returns

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

Definition at line 100 of file class.ilXmlExporter.php.

References getValidSchemaVersions().

     : array {
        return array();
    }

Here is the call graph for this function:

getXmlRepresentation()

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

abstract

Referenced by lookupExportDirectory().

Here is the caller graph for this function:

init()

ilXmlExporter::init ( )

abstract

Referenced by lookupExportDirectory().

Here is the caller graph for this function:

lookupExportDirectory()

static ilXmlExporter::lookupExportDirectory ( string  $a_obj_type, int  $a_obj_id, string  $a_export_type = 'xml', string  $a_entity = ""  )

static

Definition at line 45 of file class.ilXmlExporter.php.

References ilFileUtils\getDataDir(), getXmlRepresentation(), and init().

     : string {
        $ent = ($a_entity == "")
            ? ""
            : "_" . $a_entity;

        if ($a_export_type == 'xml') {
            return ilFileUtils::getDataDir() . "/" . $a_obj_type . $ent . "_data" . "/" . $a_obj_type . "_" . $a_obj_id . "/export";
        }
        return ilFileUtils::getDataDir() . "/" . $a_obj_type . $ent . "_data" . "/" . $a_obj_type . "_" . $a_obj_id . "/export_" . $a_export_type;
    }

Here is the call graph for this function:

setExport()

ilXmlExporter::setExport

(

ilExport

$a_exp

)

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

                                              : void
    {
        $this->exp = $a_exp;
    }

setExportDirectories()

ilXmlExporter::setExportDirectories	(	string	$a_dir_relative,
		string	$a_dir_absolute
	)

Definition at line 69 of file class.ilXmlExporter.php.

                                                                                        : void
    {
        $this->exp->setExportDirectories($a_dir_relative, $a_dir_absolute);
    }

Field Documentation

$exp

ilExport ilXmlExporter::$exp

protected

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

Referenced by getExport(), and ilOrgUnitExporter\sendAndCreateSimpleExportFile().

---

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

• components/ILIAS/Export/classes/class.ilXmlExporter.php