ilUserExporter Class Reference

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) More...

Inheritance diagram for ilUserExporter:

Collaboration diagram for ilUserExporter:

Public Member Functions
	init ()
	Initialisation. More...
	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail dependencies. More...
	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml representation. More...
	getValidSchemaVersions ($a_entity)
	Returns schema versions that the component can export to. More...
Public Member Functions inherited from ilXmlExporter
	__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...

Private Attributes
	$ds

Additional Inherited Members
Static Public Member Functions inherited from ilXmlExporter
static	lookupExportDirectory ($a_obj_type, $a_obj_id, $a_export_type='xml', $a_entity="")
	export directory lookup More...
Protected Attributes inherited from ilXmlExporter
	$dir_relative
	$dir_absolute
	$exp

Detailed Description

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

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

Version

Id

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

Member Function Documentation

getValidSchemaVersions()

ilUserExporter::getValidSchemaVersions

(

$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.

Returns

Reimplemented from ilXmlExporter.

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

    {
        return array(
            "4.3.0" => array(
                "namespace" => "http://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" => array(
                "namespace" => "http://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" => array(
                "namespace" => "http://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" => array(
                "namespace" => "http://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	(		$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 from ilXmlExporter.

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

    {
        if ($a_entity == "personal_data") {
            include_once("./Services/Calendar/classes/class.ilCalendarCategories.php");
            $cal_ids = array();
            foreach ($a_ids as $user_id) {
                foreach (ilCalendarCategories::lookupPrivateCategories($user_id) as $ct) {
                    $cal_ids[] = $ct["cat_id"];
                }
            }
            
            return array(
                array(
                    "component" => "Services/User",
                    "entity" => "usr_profile",
                    "ids" => $a_ids),
                array(
                    "component" => "Services/User",
                    "entity" => "usr_multi",
                    "ids" => $a_ids),
                array(
                    "component" => "Services/User",
                    "entity" => "usr_setting",
                    "ids" => $a_ids),
                array(
                    "component" => "Services/Notes",
                    "entity" => "user_notes",
                    "ids" => $a_ids),
                array(
                    "component" => "Services/Calendar",
                    "entity" => "calendar",
                    "ids" => $cal_ids)
                );
        }
        
        return parent::getXmlExportTailDependencies($a_entity, $a_target_release, $a_ids);
    }

References ilCalendarCategories\lookupPrivateCategories().

Here is the call graph for this function:

getXmlRepresentation()

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

Get xml representation.

Parameters

string	entity
string	target release
string	id

Returns

string xml string

Reimplemented from ilXmlExporter.

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

    {
        $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
        return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, $a_id, "", true, true);
    }

init()

ilUserExporter::init

(

)

Initialisation.

Reimplemented from ilXmlExporter.

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

    {
        include_once("./Services/User/classes/class.ilUserDataSet.php");
        $this->ds = new ilUserDataSet();
        $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
        $this->ds->setDSPrefix("ds");
    }

Field Documentation

$ds

ilUserExporter::$ds

private

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

---

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

• Services/User/classes/class.ilUserExporter.php