Exporter class for sessions. More...

Inheritance diagram for ilSessionExporter:

Collaboration diagram for ilSessionExporter:

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

Protected Member Functions
	getActiveAdvMDRecords ($a_id)
	get activated adv md records 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 sessions.

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

Version

Id

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

Member Function Documentation

◆ getActiveAdvMDRecords()

ilSessionExporter::getActiveAdvMDRecords ( $a_id )

protected

get activated adv md records

Parameters

type $a_id

Returns: type

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

References ilAdvancedMDRecord\_getActivatedRecordsByObjectType().

Referenced by getXmlExportTailDependencies().

     {
         $active = array();
         
         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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidSchemaVersions()

ilSessionExporter::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

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

     {
         return array(
             "4.1.0" => array(
                 "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" => array(
                 "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" => array(
                 "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" => array(
                 "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" => ""),
         );
     }

◆ getXmlExportTailDependencies()

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

Get tail dependencies.

Parameters

type	$a_entity
type	$a_target_release
type	$a_ids

Returns: string

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

References $id, and getActiveAdvMDRecords().

     {
         $deps = [];
         
         $advmd_ids = array();
         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" => "Services/AdvancedMetaData",
                 "entity" => "advmd",
                 "ids" => $advmd_ids
             );
         }
         
         $md_ids = array();
         foreach ($a_ids as $sess_id) {
             $md_ids[] = $sess_id . ":0:sess";
         }
         if ($md_ids) {
             $deps[] =
                 array(
                     "component" => "Services/MetaData",
                     "entity" => "md",
                     "ids" => $md_ids
                 );
         }
 
         // service settings
         $deps[] = array(
             "component" => "Services/Object",
             "entity" => "service_settings",
             "ids" => $a_ids);
         
         return $deps;
     }

Here is the call graph for this function:

◆ getXmlRepresentation()

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

Get xml representation.

Parameters

string	entity
string	schema version
string	id

Returns: string xml string

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

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

◆ init()

ilSessionExporter::init ( )

Initialisation.

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

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

Field Documentation

◆ $ds

ilSessionExporter::$ds

private

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

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

Modules/Session/classes/class.ilSessionExporter.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getActiveAdvMDRecords()

◆ getValidSchemaVersions()

◆ getXmlExportTailDependencies()

◆ getXmlRepresentation()

◆ init()

Field Documentation

◆ $ds