This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. 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
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 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 ( )

Reimplemented in ilCmiXapiExporter, ilCourseExporter, ilGroupExporter, ilOrgUnitExporter, ilScormAiccExporter, ilWebResourceExporter, and ilContainerExporter.

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

34 {

35 }

Member Function Documentation

◆ determineSchemaVersion()

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

final

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

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

References ILIAS_VERSION_NUMERIC.

◆ getAbsoluteExportDirectory()

ilXmlExporter::getAbsoluteExportDirectory ( )

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

                                                : string
    {
        return $this->dir_absolute;
    }

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

Here is the caller graph for this function:

◆ getExport()

ilXmlExporter::getExport ( )

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

                               : ilExport
    {
        return $this->exp;
    }

References $exp.

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

Here is the caller graph for this function:

◆ getRelativeExportDirectory()

ilXmlExporter::getRelativeExportDirectory ( )

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

                                                : string
    {
        return $this->dir_relative;
    }

Referenced by ilFileExporter\getXmlRepresentation(), and ilForumExporter\getXmlRepresentation().

Here is the caller graph for this function:

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

Reimplemented in ilBibliographicExporter, ilBlogExporter, ilCategoryExporter, ilChatroomExporter, ilCmiXapiExporter, ilContentPageExporter, ilCourseExporter, ilDataCollectionExporter, ilExerciseExporter, ilFileExporter, ilFolderExporter, ilForumExporter, ilGlossaryExporter, ilGroupExporter, ilHTMLLearningModuleExporter, ilIndividualAssessmentExporter, ilItemGroupExporter, ilLearningModuleExporter, ilLearningSequenceExporter, ilMediaCastExporter, ilMediaPoolExporter, ilPollExporter, ilPortfolioExporter, ilScormAiccExporter, ilSessionExporter, ilSurveyExporter, ilSurveyQuestionPoolExporter, ilTestExporter, ilTestQuestionPoolExporter, ilWebResourceExporter, ilWikiExporter, ilAccessControlExporter, ilAdvancedMetaDataExporter, ilAssessmentQuestionExporter, exQuestionPoolExporter, ilCalendarExporter, ilContainerExporter, ilContainerReferenceExporter, ilCOPageExporter, ilHelpExporter, ilMediaObjectsExporter, ilMetaDataExporter, ilNewsExporter, ilNotesExporter, ilRatingExporter, ilSkillExporter, ilStyleExporter, ilTaxonomyExporter, ilUserExporter, and ilObjectExporter.

◆ 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"

Reimplemented in ilCategoryExporter, ilCourseExporter, ilDataCollectionExporter, ilFolderExporter, ilGroupExporter, ilLearningSequenceExporter, ilMediaPoolExporter, ilAccessControlExporter, ilAdvancedMetaDataExporter, ilContainerReferenceExporter, ilCOPageExporter, ilNewsExporter, and ilTaxonomyExporter.

Definition at line 91 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"

Reimplemented in ilBibliographicExporter, ilBlogExporter, ilCategoryExporter, ilChatroomExporter, ilContentPageExporter, ilCourseExporter, ilDataCollectionExporter, ilExerciseExporter, ilFileExporter, ilForumExporter, ilGlossaryExporter, ilHTMLLearningModuleExporter, ilIndividualAssessmentExporter, ilLearningModuleExporter, ilLearningSequenceExporter, ilMediaCastExporter, ilMediaPoolExporter, ilPortfolioExporter, ilSessionExporter, ilSurveyExporter, ilSurveyQuestionPoolExporter, ilTestExporter, ilTestQuestionPoolExporter, ilWebResourceExporter, ilWikiExporter, ilAdvancedMetaDataExporter, exQuestionPoolExporter, ilContainerExporter, ilCOPageExporter, ilHelpExporter, ilMediaObjectsExporter, ilTaxonomyExporter, ilUserExporter, and ilObjectExporter.

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

     : array {
        return array();
    }

◆ getXmlRepresentation()

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

abstract

Reimplemented in ilBibliographicExporter, ilBlogExporter, ilCategoryExporter, ilChatroomExporter, ilCmiXapiExporter, ilContentPageExporter, ilCourseExporter, ilDataCollectionExporter, ilExerciseExporter, ilFileExporter, ilFolderExporter, ilForumExporter, ilGlossaryExporter, ilGroupExporter, ilHTMLLearningModuleExporter, ilIndividualAssessmentExporter, ilItemGroupExporter, ilLearningModuleExporter, ilLearningSequenceExporter, ilMediaCastExporter, ilMediaPoolExporter, ilPollExporter, ilPortfolioExporter, ilScormAiccExporter, ilSessionExporter, ilSurveyExporter, ilSurveyQuestionPoolExporter, ilTestExporter, ilTestQuestionPoolExporter, ilWebResourceExporter, ilWikiExporter, ilAccessControlExporter, ilAdvancedMetaDataExporter, ilAssessmentQuestionExporter, exQuestionPoolExporter, ilCalendarExporter, ilContainerExporter, ilContainerReferenceExporter, ilCOPageExporter, ilHelpExporter, ilMediaObjectsExporter, ilMetaDataExporter, ilNewsExporter, ilNotesExporter, ilRatingExporter, ilSkillExporter, ilStyleExporter, ilTaxonomyExporter, ilUserExporter, and ilObjectExporter.

◆ init()

ilXmlExporter::init ( )

abstract

Reimplemented in ilBibliographicExporter, ilBlogExporter, ilCategoryExporter, ilChatroomExporter, ilCmiXapiExporter, ilContentPageExporter, ilCourseExporter, ilDataCollectionExporter, ilExerciseExporter, ilFileExporter, ilFolderExporter, ilForumExporter, ilGlossaryExporter, ilGroupExporter, ilHTMLLearningModuleExporter, ilIndividualAssessmentExporter, ilItemGroupExporter, ilLearningModuleExporter, ilLearningSequenceExporter, ilMediaCastExporter, ilMediaPoolExporter, ilPollExporter, ilPortfolioExporter, ilScormAiccExporter, ilSessionExporter, ilSurveyExporter, ilSurveyQuestionPoolExporter, ilTestExporter, ilTestQuestionPoolExporter, ilWebResourceExporter, ilWikiExporter, ilAccessControlExporter, ilAdvancedMetaDataExporter, ilAssessmentQuestionExporter, exQuestionPoolExporter, ilCalendarExporter, ilContainerExporter, ilContainerReferenceExporter, ilHelpExporter, ilMediaObjectsExporter, ilMetaDataExporter, ilNewsExporter, ilNotesExporter, ilObjectExporter, ilRatingExporter, ilSkillExporter, ilStyleExporter, ilTaxonomyExporter, and ilUserExporter.

◆ lookupExportDirectory()

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

static

Reimplemented in ilTestQuestionPoolExporter.

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

     : 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;
    }

References ilFileUtils\getDataDir().

Here is the call graph for this function:

◆ setExport()

ilXmlExporter::setExport ( ilExport $a_exp )

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

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

◆ setExportDirectories()

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

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

                                                                                        : void
    {
        $this->dir_relative = $a_dir_relative;
        $this->dir_absolute = $a_dir_absolute;
    }

Field Documentation

◆ $dir_absolute

string ilXmlExporter::$dir_absolute = ""

protected

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

◆ $dir_relative

string ilXmlExporter::$dir_relative = ""

protected

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

◆ $exp

ilExport ilXmlExporter::$exp

protected

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

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

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

Services/Export/classes/class.ilXmlExporter.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ determineSchemaVersion()

◆ getAbsoluteExportDirectory()

◆ getExport()

◆ getRelativeExportDirectory()

◆ getValidSchemaVersions()

◆ getXmlExportHeadDependencies()

◆ getXmlExportTailDependencies()

◆ getXmlRepresentation()

◆ init()

◆ lookupExportDirectory()

◆ setExport()

◆ setExportDirectories()

Field Documentation

◆ $dir_absolute

◆ $dir_relative

◆ $exp