ilSessionExporter Class Reference

Exporter class for sessions. More...

Inheritance diagram for ilSessionExporter:

Collaboration diagram for ilSessionExporter:

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

Protected Member Functions
	getActiveAdvMDRecords (int $a_id)

Private Attributes
ilSessionDataSet	$ds

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

Exporter class for sessions.

Author

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

Version

Id

\

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

Member Function Documentation

getActiveAdvMDRecords()

ilSessionExporter::getActiveAdvMDRecords ( int  $a_id )

protected

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

                                                       : array
    {
        $active = [];
 
        foreach (ilAdvancedMDRecord::_getActivatedRecordsByObjectType('sess') as $record_obj) {
            foreach ($record_obj->getAssignedObjectTypes() as $obj_info) {
                if ($obj_info['obj_type'] == 'sess' && $obj_info['optional'] == 0) {
                    $active[] = $record_obj->getRecordId();
                }
                // local activation
                if (
                    $obj_info['obj_type'] == 'sess' &&
                    $obj_info['optional'] == 1 &&
                    $a_id == $record_obj->getParentObject()
                ) {
                    $active[] = $record_obj->getRecordId();
                }
            }
        }
        return $active;
    }

References ilAdvancedMDRecord\_getActivatedRecordsByObjectType().

Referenced by getXmlExportTailDependencies().

Here is the call graph for this function:

Here is the caller graph for this function:

getValidSchemaVersions()

ilSessionExporter::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 115 of file class.ilSessionExporter.php.

                                                            : array
    {
        return [
            "4.1.0" => [
                "namespace" => "http://www.ilias.de/Modules/Session/sess/4_1",
                "xsd_file" => "ilias_sess_4_1.xsd",
                "uses_dataset" => true,
                "min" => "4.1.0",
                "max" => "4.4.999"
            ],
            "5.0.0" => [
                "namespace" => "http://www.ilias.de/Modules/Session/sess/5_0",
                "xsd_file" => "ilias_sess_5_0.xsd",
                "uses_dataset" => true,
                "min" => "5.0.0",
                "max" => "5.0.999"
            ],
            "5.1.0" => [
                "namespace" => "http://www.ilias.de/Modules/Session/sess/5_1",
                "xsd_file" => "ilias_sess_5_1.xsd",
                "uses_dataset" => true,
                "min" => "5.1.0",
                "max" => "5.3.999"
            ],
            "5.4.0" => [
                "namespace" => "http://www.ilias.de/Modules/Session/sess/5_1",
                "xsd_file" => "ilias_sess_5_1.xsd",
                "uses_dataset" => true,
                "min" => "5.4.0",
                "max" => "5.4.99"
            ],
            "7.0" => [
                "namespace" => "http://www.ilias.de/Modules/Session/sess/7",
                "xsd_file" => "ilias_sess_7.xsd",
                "uses_dataset" => true,
                "min" => "7.0",
                "max" => "8.99"
            ],
            "9.0" => [
                "namespace" => "http://www.ilias.de/xml/Modules/Session/sess",
                "xsd_file" => "ilias_sess_9.xsd",
                "uses_dataset" => true,
                "min" => "9.0",
                "max" => ""
            ]
        ];
    }

getXmlExportTailDependencies()

ilSessionExporter::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 39 of file class.ilSessionExporter.php.

                                                                                                          : array
    {
        $deps = [];
 
        $advmd_ids = [];
        foreach ($a_ids as $id) {
            $rec_ids = $this->getActiveAdvMDRecords($id);
            if (sizeof($rec_ids)) {
                foreach ($rec_ids as $rec_id) {
                    $advmd_ids[] = $id . ":" . $rec_id;
                }
            }
        }
        if (sizeof($advmd_ids)) {
            $deps[] = array(
                "component" => "components/ILIAS/AdvancedMetaData",
                "entity" => "advmd",
                "ids" => $advmd_ids
            );
        }
 
        $md_ids = [];
        foreach ($a_ids as $sess_id) {
            $md_ids[] = $sess_id . ":0:sess";
        }
        if ($md_ids) {
            $deps[] =
                array(
                    "component" => "components/ILIAS/MetaData",
                    "entity" => "md",
                    "ids" => $md_ids
                );
        }
 
        // service settings
        $deps[] = array(
            "component" => "components/ILIAS/ILIASObject",
            "entity" => "service_settings",
            "ids" => $a_ids);
 
        // tile image
        $deps[] = array(
            "component" => "components/ILIAS/ILIASObject",
            "entity" => "tile",
            "ids" => $a_ids);
 
        return $deps;
    }

References $id, and getActiveAdvMDRecords().

Here is the call graph for this function:

getXmlRepresentation()

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

Reimplemented from ilXmlExporter.

Definition at line 110 of file class.ilSessionExporter.php.

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

init()

ilSessionExporter::init

(

)

Reimplemented from ilXmlExporter.

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

                          : void
    {
        $this->ds = new ilSessionDataSet();
        $this->ds->initByExporter($this);
        $this->ds->setDSPrefix("ds");
    }

Field Documentation

$ds

ilSessionDataSet ilSessionExporter::$ds

private

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

---

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

• components/ILIAS/Session/classes/class.ilSessionExporter.php