Inheritance diagram for ilDataCollectionExporter:

Collaboration diagram for ilDataCollectionExporter:

Public Member Functions
	init ()

	getValidSchemaVersions ($a_entity)

	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)

	getXmlExportHeadDependencies ($a_entity, $a_target_release, $a_ids)
	MOB/File fieldtypes objects are head dependencies They must be exported and imported first, so the new DC has the new IDs of those objects available. More...

	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)

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 Attributes
	$ds

	$db

Protected Attributes inherited from ilXmlExporter
	$dir_relative

	$dir_absolute

	$exp

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

Detailed Description

Class ilDataCollectionExporter.

Author: Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 9 of file class.ilDataCollectionExporter.php.

Member Function Documentation

◆ getValidSchemaVersions()

ilDataCollectionExporter::getValidSchemaVersions ( $a_entity )

Parameters

string $a_entity

Returns: array

Definition at line 37 of file class.ilDataCollectionExporter.php.

     {
         return array(
             '4.5.0' => array(
                 'namespace' => 'http://www.ilias.de/Modules/DataCollection/dcl/4_5',
                 'xsd_file" => "ilias_dcl_4_5.xsd',
                 'uses_dataset' => true,
                 'min' => '4.5.0',
                 'max' => '',
             ),
         );
     }

◆ getXmlExportHeadDependencies()

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

MOB/File fieldtypes objects are head dependencies They must be exported and imported first, so the new DC has the new IDs of those objects available.

Parameters

$a_entity
$a_target_release
$a_ids

Returns: array

Definition at line 70 of file class.ilDataCollectionExporter.php.

References ilDclDatatype\INPUTFORMAT_FILE, and ilDclDatatype\INPUTFORMAT_MOB.

     {
         $dependencies = array(
             ilDclDatatype::INPUTFORMAT_FILE => array(
                 'component' => 'Modules/File',
                 'entity' => 'file',
                 'ids' => array(),
             ),
             ilDclDatatype::INPUTFORMAT_MOB => array(
                 'component' => 'Services/MediaObjects',
                 'entity' => 'mob',
                 'ids' => array(),
             ),
         );
 
         // Direct SQL query is faster than looping over objects
         foreach ($a_ids as $dcl_obj_id) {
             $sql = "SELECT stloc2.value AS ext_id, f." . $this->db->quoteIdentifier('datatype_id') . " FROM il_dcl_stloc2_value AS stloc2 "
                 . "INNER JOIN il_dcl_record_field AS rf ON (rf." . $this->db->quoteIdentifier('id') . " = stloc2." . $this->db->quoteIdentifier('record_field_id') . ") "
                 . "INNER JOIN il_dcl_field AS f ON (rf." . $this->db->quoteIdentifier('field_id') . " = f." . $this->db->quoteIdentifier('id') . ") " . "INNER JOIN il_dcl_table AS t ON (t."
                 . $this->db->quoteIdentifier('id') . " = f." . $this->db->quoteIdentifier('table_id') . ") "
                 . "WHERE t." . $this->db->quoteIdentifier('obj_id') . " = " . $this->db->quote($dcl_obj_id, 'integer') . " " . "AND f.datatype_id IN ("
                 . implode(',', array_keys($dependencies)) . ") AND stloc2." . $this->db->quoteIdentifier('value') . " IS NOT NULL";
             $set = $this->db->query($sql);
             while ($rec = $this->db->fetchObject($set)) {
                 $dependencies[$rec->datatype_id]['ids'][] = (int) $rec->ext_id;
             }
         }
 
         // Return external dependencies/IDs if there are any
         $return = array();
         if (count($dependencies[ilDclDatatype::INPUTFORMAT_FILE]['ids'])) {
             $return[] = $dependencies[ilDclDatatype::INPUTFORMAT_FILE];
         }
         if (count($dependencies[ilDclDatatype::INPUTFORMAT_MOB]['ids'])) {
             $return[] = $dependencies[ilDclDatatype::INPUTFORMAT_MOB];
         }
 
         return $return;
     }

◆ getXmlExportTailDependencies()

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

Parameters

$a_entity
$a_target_release
$a_ids

Returns: array

Definition at line 119 of file class.ilDataCollectionExporter.php.

     {
         $page_object_ids = array();
         foreach ($a_ids as $dcl_obj_id) {
             // If a DCL table has a detail view, we need to export the associated page objects!
             $sql = "SELECT page_id FROM page_object "
                 . "WHERE parent_type = " . $this->db->quote('dclf', 'text') . " AND parent_id = " . $this->db->quote($dcl_obj_id, 'integer');
             $set = $this->db->query($sql);
             while ($rec = $this->db->fetchObject($set)) {
                 $page_object_ids[] = "dclf:" . $rec->page_id;
             }
         }
         if (count($page_object_ids)) {
             return array(
                 array(
                     'component' => 'Services/COPage',
                     'entity' => 'pg',
                     'ids' => $page_object_ids,
                 ),
             );
         }
 
         return array();
     }

◆ getXmlRepresentation()

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

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

References ilXmlExporter\getAbsoluteExportDirectory(), and ilUtil\makeDirParents().

     {
         ilUtil::makeDirParents($this->getAbsoluteExportDirectory());
         $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
 
         return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, $a_id, '', true, true);
     }

Here is the call graph for this function:

◆ init()

ilDataCollectionExporter::init ( )

Definition at line 22 of file class.ilDataCollectionExporter.php.

References $DIC, and $ilDB.

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $this->ds = new ilDataCollectionDataSet();
         $this->ds->setDSPrefix('ds');
         $this->db = $ilDB;
     }

Field Documentation

◆ $db

ilDataCollectionExporter::$db

protected

Definition at line 19 of file class.ilDataCollectionExporter.php.

◆ $ds

ilDataCollectionExporter::$ds

protected

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

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

Modules/DataCollection/classes/class.ilDataCollectionExporter.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getValidSchemaVersions()

◆ getXmlExportHeadDependencies()

◆ getXmlExportTailDependencies()

◆ getXmlRepresentation()

◆ init()

Field Documentation

◆ $db

◆ $ds