ilDataCollectionExporter Class Reference

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

Inheritance diagram for ilDataCollectionExporter:

Collaboration diagram for ilDataCollectionExporter:

Public Member Functions
	init ()
	getValidSchemaVersions (string $a_entity)
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	getXmlExportHeadDependencies (string $a_entity, string $a_target_release, array $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 (string $a_entity, string $a_target_release, array $a_ids)
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 Attributes
ilDataCollectionDataSet	$ds
ilDBInterface	$db
Protected Attributes inherited from ilXmlExporter
string	$dir_relative = ""
string	$dir_absolute = ""
ilExport	$exp

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="")

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

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

Member Function Documentation

getValidSchemaVersions()

ilDataCollectionExporter::getValidSchemaVersions

(

string

$a_entity

)

Parameters

string

$a_entity

Returns

array

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

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

getXmlExportHeadDependencies()

ilDataCollectionExporter::getXmlExportHeadDependencies	(	string	$a_entity,
		string	$a_target_release,
		array	$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

string	$a_entity
string	$a_target_release
array	$a_ids

Returns

array

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

References ilDclDatatype\INPUTFORMAT_FILE, ilDclDatatype\INPUTFORMAT_MOB, and ILIAS\Repository\int().

                                                                                                          : array
    {
        $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;
    }

Here is the call graph for this function:

getXmlExportTailDependencies()

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

Parameters

string	$a_entity
string	$a_target_release
array	$a_ids

Returns

array

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

                                                                                                          : array
    {
        $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	(	string	$a_entity,
		string	$a_schema_version,
		string	$a_id
	)

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

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

                                                                                                  : string
    {
        ilFileUtils::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 24 of file class.ilDataCollectionExporter.php.

References $DIC, and $ilDB.

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

Field Documentation

$db

ilDBInterface ilDataCollectionExporter::$db

protected

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

$ds

ilDataCollectionDataSet ilDataCollectionExporter::$ds

protected

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

---

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

• Modules/DataCollection/classes/class.ilDataCollectionExporter.php