class.ilLearningSequenceExporter.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilLearningSequenceExporter extends ilXmlExporter
{
    protected ilSetting $settings;

    public function init(): void
    {
        global $DIC;
        $this->settings = $DIC["ilSetting"];
    }

    public function getXmlRepresentation(string $a_entity, string $a_schema_version, string $a_id): string
    {
        $writer = $this->getWriter((int) $a_id);
        $writer->start();

        return $writer->getXml();
    }

    protected function getWriter(int $obj_id): ilLearningSequenceXMLWriter
    {
        if ($type = ilObject::_lookupType($obj_id) != "lso") {
            throw new Exception("Wrong type " . $type . " for lso export.");
        }

        $ref_ids = ilObject::_getAllReferences($obj_id);
        $ls_ref_id = end($ref_ids);

        $ls_object = ilObjectFactory::getInstanceByRefId($ls_ref_id, false);
        if (!$ls_object) {
            throw new Exception("Object for ref id " . $ls_ref_id . " not found.");
        }

        $lp_settings = new ilLPObjSettings($obj_id);

        return new ilLearningSequenceXMLWriter(
            $ls_object,
            $this->settings,
            $lp_settings
        );
    }

    public function getValidSchemaVersions(string $a_entity): array
    {
        return [
            "9.0.0" => [
                "namespace" => "http://www.ilias.de/Modules/LearningSequence/lso/9_0",
                "xsd_file" => "ilias_lso_9_0.xsd",
                "uses_dataset" => false,
                "min" => "9.0",
                "max" => ""
            ]
        ];
    }

    public function getXmlExportHeadDependencies(string $a_entity, string $a_target_release, array $a_ids): array
    {
        return [
            [
                'component' => 'components/ILIAS/Container',
                'entity' => 'struct',
                'ids' => $a_ids
            ]
        ];
    }

    public function getXmlExportTailDependencies(string $a_entity, string $a_target_release, array $a_ids): array
    {
        $res = [];
        if ($a_entity == "lso") {
            // service settings
            $res[] = [
                "component" => "components/ILIAS/ILIASObject",
                "entity" => "common",
                "ids" => $a_ids
            ];
        }

        // container pages
        foreach ($a_ids as $id) {
            if (ilContainerPage::_exists(LSOPageType::INTRO->value, (int) $id)) {
                $res[] = [
                    "component" => "components/ILIAS/COPage",
                    "entity" => "pg",
                    "ids" => [LSOPageType::INTRO->value . ":" . $id]
                ];
            }

            if (ilContainerPage::_exists(LSOPageType::EXTRO->value, (int) $id)) {
                $res[] = [
                    "component" => "components/ILIAS/COPage",
                    "entity" => "pg",
                    "ids" => [LSOPageType::EXTRO->value . ":" . $id]
                ];
            }
        }

        return $res;
    }
}