class.ilContainerReferenceExporter.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

abstract class ilContainerReferenceExporter extends ilXmlExporter
{
    public function getXmlExportHeadDependencies(string $a_entity, string $a_target_release, array $a_ids): array
    {
        global $DIC;

        $log = $DIC->logger()->root();

        $eo = ilExportOptions::getInstance();

        $obj_id = end($a_ids);

        $log->debug(__METHOD__ . ': ' . $obj_id);
        if ($eo->getOption(ilExportOptions::KEY_ROOT) != $obj_id) {
            return [];
        }
        if (count(ilExportOptions::getInstance()->getSubitemsForExport()) > 1) {
            return [
                [
                    'component' => 'components/ILIAS/Container',
                    'entity' => 'struct',
                    'ids' => $a_ids
                ]
            ];
        }
        return [];
    }

    abstract protected function initWriter(ilContainerReference $ref): ilContainerReferenceXmlWriter;

    public function getXmlRepresentation(string $a_entity, string $a_schema_version, string $a_id): string
    {
        global $DIC;

        $log = $DIC->logger()->root();

        $refs = ilObject::_getAllReferences((int) $a_id);
        $ref_ref_id = end($refs);
        $ref = ilObjectFactory::getInstanceByRefId($ref_ref_id, false);

        if (!$ref instanceof ilContainerReference) {
            $log->debug(__METHOD__ . $a_id . ' is not instance of type category!');
            return '';
        }
        $writer = $this->initWriter($ref);
        $writer->setMode(ilContainerReferenceXmlWriter::MODE_EXPORT);
        $writer->export(false);
        return $writer->getXml();
    }

    public function getValidSchemaVersions(string $a_entity): array
    {
        return [
            "4.3.0" => [
                "namespace" => "https://www.ilias.de/Modules/CategoryReference/catr/4_3",
                "xsd_file" => "ilias_catr_4_3.xsd",
                "uses_dataset" => false,
                "min" => "4.3.0",
                "max" => ""
            ]
        ];
    }

    public function init(): void
    {
    }
}