class.ilXmlExporter.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

abstract class ilXmlExporter
{
    protected string $dir_relative = "";
    protected string $dir_absolute = "";
    protected ilExport $exp;

    public function __construct()
    {
    }

    public function setExport(ilExport $a_exp): void
    {
        $this->exp = $a_exp;
    }

    public function getExport(): ilExport
    {
        return $this->exp;
    }

    public static function lookupExportDirectory(
        string $a_obj_type,
        int $a_obj_id,
        string $a_export_type = 'xml',
        string $a_entity = ""
    ): string {
        $ent = ($a_entity == "")
            ? ""
            : "_" . $a_entity;

        if ($a_export_type == 'xml') {
            return ilFileUtils::getDataDir() . "/" . $a_obj_type . $ent . "_data" . "/" . $a_obj_type . "_" . $a_obj_id . "/export";
        }
        return ilFileUtils::getDataDir() . "/" . $a_obj_type . $ent . "_data" . "/" . $a_obj_type . "_" . $a_obj_id . "/export_" . $a_export_type;
    }

    abstract public function getXmlRepresentation(
        string $a_entity,
        string $a_schema_version,
        string $a_id
    ): string;

    abstract public function init(): void;

    public function setExportDirectories(string $a_dir_relative, string $a_dir_absolute): void
    {
        $this->dir_relative = $a_dir_relative;
        $this->dir_absolute = $a_dir_absolute;
    }

    public function getRelativeExportDirectory(): string
    {
        return $this->dir_relative;
    }

    public function getAbsoluteExportDirectory(): string
    {
        return $this->dir_absolute;
    }

    public function getXmlExportHeadDependencies(
        string $a_entity,
        string $a_target_release,
        array $a_ids
    ): array {
        return [];
    }

    public function getXmlExportTailDependencies(
        string $a_entity,
        string $a_target_release,
        array $a_ids
    ): array {
        return array();
    }

    abstract public function getValidSchemaVersions(string $a_entity): array;

    final public function determineSchemaVersion(
        string $a_entity,
        string $a_target_release
    ): array {
        $svs = $this->getValidSchemaVersions($a_entity);
        $found = false;
        $rsv = [];
        foreach ($svs as $k => $sv) {
            if (!$found) {
                if (version_compare($sv["min"], ILIAS_VERSION_NUMERIC, "<=")
                    && ($sv["max"] == "" || version_compare($sv["max"], ILIAS_VERSION_NUMERIC, ">="))) {
                    $rsv = $sv;
                    $rsv["schema_version"] = $k;
                    $found = true;
                }
            }
        }
        return $rsv;
    }
}