This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilUserExporter:

Collaboration diagram for ilUserExporter:

Public Member Functions
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get tail dependencies. More...

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

	getValidSchemaVersions (string $a_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
ilUserDataSet	$data_set

ilUserExportConfig	$export_config

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

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 user data Note: this is currently NOT used for the classic user export/import It is mainly used for export personsl user data from the personal desktop (settings, profile, calendar entries)

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 26 of file class.ilUserExporter.php.

Member Function Documentation

◆ getValidSchemaVersions()

ilUserExporter::getValidSchemaVersions ( string $a_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. 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 from ilXmlExporter.

Definition at line 83 of file class.ilUserExporter.php.

                                                            : array // Missing array type.
    {
        return [
            "4.3.0" => [
                "namespace" => "https://www.ilias.de/Services/User/usr/4_3",
                "xsd_file" => "ilias_usr_4_3.xsd",
                "uses_dataset" => true,
                "min" => "4.3.0",
                "max" => "4.4.99"],
            "5.1.0" => [
                "namespace" => "https://www.ilias.de/Services/User/usr/5_1",
                "xsd_file" => "ilias_usr_5_1.xsd",
                "uses_dataset" => true,
                "min" => "5.1.0",
                "max" => "5.1.99"],
            "5.2.0" => [
                "namespace" => "https://www.ilias.de/Services/User/usr/5_2",
                "xsd_file" => "ilias_usr_5_2.xsd",
                "uses_dataset" => true,
                "min" => "5.2.0",
                "max" => "5.2.99"],
            "5.3.0" => [
                "namespace" => "https://www.ilias.de/Services/User/usr/5_3",
                "xsd_file" => "ilias_usr_5_3.xsd",
                "uses_dataset" => true,
                "min" => "5.3.0",
                "max" => ""]
        ];
    }

◆ getXmlExportTailDependencies()

ilUserExporter::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 40 of file class.ilUserExporter.php.

                                                                                                          : array // Missing array type.
    {
        if ($a_entity === 'usr' && $this->export_config->getExportType() === 'personal_data') {
            $cal_ids = [];
            foreach ($a_ids as $user_id) {
                foreach (ilCalendarCategories::lookupPrivateCategories($user_id) as $ct) {
                    $cal_ids[] = $ct["cat_id"];
                }
            }
 
            return [
                [
                    "component" => "components/ILIAS/User",
                    "entity" => "usr_profile",
                    "ids" => $a_ids],
                [
                    "component" => "components/ILIAS/User",
                    "entity" => "usr_multi",
                    "ids" => $a_ids],
                [
                    "component" => "components/ILIAS/User",
                    "entity" => "usr_setting",
                    "ids" => $a_ids],
                [
                    "component" => "components/ILIAS/Notes",
                    "entity" => "user_notes",
                    "ids" => $a_ids],
                [
                    "component" => "components/ILIAS/Calendar",
                    "entity" => "calendar",
                    "ids" => $cal_ids]
                ];
        }
 
        return parent::getXmlExportTailDependencies($a_entity, $a_target_release, $a_ids);
    }

References $user_id, and ilCalendarCategories\lookupPrivateCategories().

Here is the call graph for this function:

◆ getXmlRepresentation()

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

Reimplemented from ilXmlExporter.

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

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

Field Documentation

◆ $data_set

ilUserDataSet ilUserExporter::$data_set

private

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

◆ $export_config

ilUserExportConfig ilUserExporter::$export_config

private

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

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

components/ILIAS/User/classes/class.ilUserExporter.php

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getValidSchemaVersions()

◆ getXmlExportTailDependencies()

◆ getXmlRepresentation()

Field Documentation

◆ $data_set

◆ $export_config