class.ilDataCollectionExporter.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilDataCollectionExporter extends ilXmlExporter
{
    protected ilDataCollectionDataSet $ds;
    protected ilDBInterface $db;

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

    public function getValidSchemaVersions(string $a_entity): array
    {
        return [
            '4.5.0' => [
                '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' => [
                'namespace' => 'https://www.ilias.de/Modules/DataCollection/dcl/4_5',
                'xsd_file" => "ilias_dcl_4_5.xsd',
                'uses_dataset' => true,
                'min' => '8.13',
                'max' => '',
            ],
        ];
    }

    public function getXmlRepresentation(string $a_entity, string $a_schema_version, string $a_id): 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);
    }

    public function getXmlExportHeadDependencies(string $a_entity, string $a_target_release, array $a_ids): array
    {
        $dependencies = [
            ilDclDatatype::INPUTFORMAT_FILEUPLOAD => [
                'component' => 'Modules/File',
                'entity' => 'file',
                'ids' => [],
            ],
            ilDclDatatype::INPUTFORMAT_MOB => [
                'component' => 'Services/MediaObjects',
                'entity' => 'mob',
                'ids' => [],
            ],
        ];

        // 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 = [];
        if (count($dependencies[ilDclDatatype::INPUTFORMAT_FILEUPLOAD]['ids'])) {
            $return[] = $dependencies[ilDclDatatype::INPUTFORMAT_FILEUPLOAD];
        }
        if (count($dependencies[ilDclDatatype::INPUTFORMAT_MOB]['ids'])) {
            $return[] = $dependencies[ilDclDatatype::INPUTFORMAT_MOB];
        }

        return $return;
    }

    public function getXmlExportTailDependencies(string $a_entity, string $a_target_release, array $a_ids): array
    {
        $page_object_ids = [];
        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 [
                [
                    'component' => 'Services/COPage',
                    'entity' => 'pg',
                    'ids' => $page_object_ids,
                ],
            ];
        }

        return [];
    }
}