Xml Exporter class. More...

Inheritance diagram for ilXmlExporter:

Collaboration diagram for ilXmlExporter:

Public Member Functions
	__construct ()
	Constructor. More...

	setExport (ilExport $a_exp)
	Set export object. More...

	getExport ()
	Get export. More...

	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml representation. More...

	init ()

	setExportDirectories ($a_dir_relative, $a_dir_absolute)
	Export directories. More...

	getRelativeExportDirectory ()
	Get relative export directory. More...

	getAbsoluteExportDirectory ()
	Get absolute export directory. More...

	getXmlExportHeadDependencies ($a_entity, $a_target_release, $a_ids)
	Get head dependencies. More...

	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail dependencies. More...

	getValidSchemaVersions ($a_entity)
	Returns schema versions that the component can export to. More...

	determineSchemaVersion ($a_entity, $a_target_release)
	Determine schema version. More...

Static Public Member Functions
static	lookupExportDirectory ($a_obj_type, $a_obj_id, $a_export_type='xml', $a_entity="")
	export directory lookup More...

Protected Attributes
	$dir_relative

	$dir_absolute

	$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 11 of file class.ilXmlExporter.php.

Constructor & Destructor Documentation

◆ __construct()

ilXmlExporter::__construct ( )

Constructor.

Parameters

return

Reimplemented in ilCmiXapiExporter, ilCourseExporter, ilFolderExporter, ilGroupExporter, ilScormAiccExporter, ilWebResourceExporter, ilAccessControlExporter, and ilContainerExporter.

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

24 {

25 }

Member Function Documentation

◆ determineSchemaVersion()

ilXmlExporter::determineSchemaVersion	(	$a_entity,
		$a_target_release
	)

final

Determine schema version.

Parameters

return

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

    {
        $svs = $this->getValidSchemaVersions($a_entity);
        $found = false;
        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 getValidSchemaVersions(), and ILIAS_VERSION_NUMERIC.

Here is the call graph for this function:

◆ getAbsoluteExportDirectory()

ilXmlExporter::getAbsoluteExportDirectory ( )

Get absolute export directory.

Returns: string absolute directory

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

    {
        return $this->dir_absolute;
    }

References $dir_absolute.

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

Here is the caller graph for this function:

◆ getExport()

ilXmlExporter::getExport ( )

Get export.

Returns: ilExport export object

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

    {
        return $this->exp;
    }

References $exp.

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

Here is the caller graph for this function:

◆ getRelativeExportDirectory()

ilXmlExporter::getRelativeExportDirectory ( )

Get relative export directory.

Returns: string relative directory

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

    {
        return $this->dir_relative;
    }

References $dir_relative.

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

Here is the caller graph for this function:

◆ getValidSchemaVersions()

ilXmlExporter::getValidSchemaVersions ( $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" => "")
    );

Returns: array

Reimplemented in ilBibliographicExporter, ilBlogExporter, ilCategoryExporter, ilChatroomExporter, ilCmiXapiExporter, ilContentPageExporter, ilCourseExporter, ilDataCollectionExporter, ilExerciseExporter, ilExternalFeedExporter, ilFileExporter, ilFolderExporter, ilForumExporter, ilGlossaryExporter, ilGroupExporter, ilHTMLLearningModuleExporter, ilindividualAssessmentExporter, ilItemGroupExporter, ilLearningModuleExporter, 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, ilObjectExporter, ilRatingExporter, ilSkillExporter, ilStyleExporter, ilTaxonomyExporter, ilUserExporter, and ilLearningSequenceExporter.

Referenced by determineSchemaVersion().

Here is the caller graph for this function:

◆ getXmlExportHeadDependencies()

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

Get head dependencies.

Parameters

string	entity
string	target release
array	ids

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

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

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

    {
        return array();
    }

◆ getXmlExportTailDependencies()

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

Get tail dependencies.

Parameters

string	entity
string	target release
array	ids

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

Reimplemented in 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, ilObjectExporter, ilSkillExporter, ilTaxonomyExporter, and ilUserExporter.

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

    {
        return array();
    }

◆ getXmlRepresentation()

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

abstract

Get xml representation.

Parameters

string	entity
string	schema version
string	id

Returns: string xml string

Reimplemented in ilBibliographicExporter, ilBlogExporter, ilCategoryExporter, ilChatroomExporter, ilCmiXapiExporter, ilContentPageExporter, ilCourseExporter, ilDataCollectionExporter, ilExerciseExporter, ilExternalFeedExporter, ilFileExporter, ilFolderExporter, ilForumExporter, ilGlossaryExporter, ilGroupExporter, ilHTMLLearningModuleExporter, ilindividualAssessmentExporter, ilItemGroupExporter, ilLearningModuleExporter, 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, ilObjectExporter, ilRatingExporter, ilSkillExporter, ilStyleExporter, ilTaxonomyExporter, ilUserExporter, and ilLearningSequenceExporter.

◆ init()

ilXmlExporter::init ( )

abstract

Reimplemented in ilBibliographicExporter, ilBlogExporter, ilCategoryExporter, ilChatroomExporter, ilCmiXapiExporter, ilContentPageExporter, ilCourseExporter, ilDataCollectionExporter, ilExerciseExporter, ilExternalFeedExporter, 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	(	$a_obj_type,
		$a_obj_id,
		$a_export_type = `'xml'`,
		$a_entity = `""`
	)

static

export directory lookup

Returns: string export directory

Reimplemented in ilTestQuestionPoolExporter.

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

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

References ilUtil\getDataDir().

Here is the call graph for this function:

◆ setExport()

ilXmlExporter::setExport ( ilExport $a_exp )

Set export object.

Parameters

ilExport $a_exp export object

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

    {
        $this->exp = $a_exp;
    }

◆ setExportDirectories()

ilXmlExporter::setExportDirectories	(	$a_dir_relative,
		$a_dir_absolute
	)

Export directories.

Parameters

string	relative directory
string	absolute directory

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

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

Field Documentation

◆ $dir_absolute

ilXmlExporter::$dir_absolute

protected

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

Referenced by getAbsoluteExportDirectory().

◆ $dir_relative

ilXmlExporter::$dir_relative

protected

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

Referenced by getRelativeExportDirectory().

◆ $exp

ilXmlExporter::$exp

protected

Definition at line 15 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