class.ilCourseExporter.php

Go to the documentation of this file.

<?php

declare(strict_types=0);
class ilCourseExporter extends ilXmlExporter
{
    public const ENTITY_OBJECTIVE = 'objectives';
    public const ENTITY_MAIN = 'crs';

    protected ilXmlWriter $writer;
    protected ilLogger $logger;

    public function __construct()
    {
        global $DIC;
        $this->logger = $DIC->logger()->crs();
    }

    public function init(): void
    {
    }

    public function getXmlExportHeadDependencies(string $a_entity, string $a_target_release, array $a_ids): array
    {
        if ($a_entity != self::ENTITY_MAIN) {
            return array();
        }

        // always trigger container because of co-page(s)
        return array(
            array(
                'component' => 'components/ILIAS/Container',
                'entity' => 'struct',
                'ids' => $a_ids
            )
        );
    }

    protected function getActiveAdvMDRecords(int $a_id): array
    {
        $active = [];
        foreach (ilAdvancedMDRecord::_getActivatedRecordsByObjectType('crs') as $record_obj) {
            foreach ($record_obj->getAssignedObjectTypes() as $obj_info) {
                if ($obj_info['obj_type'] == 'crs' && $obj_info['optional'] == 0) {
                    $active[] = $record_obj->getRecordId();
                }
                // local activation
                if (
                    $obj_info['obj_type'] == 'crs' &&
                    $obj_info['optional'] == 1 &&
                    $a_id == $record_obj->getParentObject()
                ) {
                    $active[] = $record_obj->getRecordId();
                }
            }
        }
        return $active;
    }


    public function getXmlExportTailDependencies(string $a_entity, string $a_target_release, array $a_ids): array
    {
        if ($a_entity !== self::ENTITY_MAIN) {
            return [];
        }

        $dependencies = [];
        $obj_id = 0;
        foreach ($a_ids as $id) {
            $obj_id = $id;
        }

        $dependencies[] = [
            'component' => 'components/ILIAS/Course',
            'entity' => self::ENTITY_OBJECTIVE,
            'ids' => $obj_id
        ];

        $page_ids = [];
        foreach (ilCourseObjective::_getObjectiveIds($obj_id) as $objective_id) {
            foreach (ilLOPage::getAllPages('lobj', $objective_id) as $page_id) {
                $page_ids[] = ('lobj:' . $page_id['id']);
            }
        }

        if ($page_ids !== []) {
            $dependencies[] = [
                'component' => 'components/ILIAS/COPage',
                'entity' => 'pg',
                'ids' => $page_ids
            ];
        }

        $advmd_ids = [];
        foreach ($a_ids as $id) {
            $rec_ids = $this->getActiveAdvMDRecords($id);
            foreach ($rec_ids as $rec_id) {
                $advmd_ids[] = $id . ":" . $rec_id;
            }
        }

        if ($advmd_ids !== []) {
            $dependencies[] = [
                "component" => "components/ILIAS/AdvancedMetaData",
                "entity" => "advmd",
                "ids" => $advmd_ids
            ];
        }

        $md_ids = [];
        foreach ($a_ids as $crs_id) {
            $md_ids[] = $crs_id . ":0:crs";
        }
        if ($md_ids !== []) {
            $dependencies[] = [
                    "component" => "components/ILIAS/MetaData",
                    "entity" => "md",
                    "ids" => $md_ids
            ];
        }
        return $dependencies;
    }

    public function getXmlRepresentation(string $a_entity, string $a_schema_version, string $a_id): string
    {
        $refs = ilObject::_getAllReferences((int) $a_id);
        $course_ref_id = end($refs);
        $course = ilObjectFactory::getInstanceByRefId($course_ref_id, false);

        // begin-patch optes_lok_export
        if ($a_entity == self::ENTITY_OBJECTIVE) {
            try {
                $writer = new ilLOXmlWriter($course_ref_id);
                $writer->write();
                return $writer->getXml();
            } catch (Exception $ex) {
                $this->logger->error('Export failed with message: ' . $ex->getMessage());
                // and throw
                throw $ex;
            }
        }
        // end-patch optes_lok_export

        if (!$course instanceof ilObjCourse) {
            $this->logger->warning($a_id . ' is not id of course instance.');
            return '';
        }

        $this->writer = new ilCourseXMLWriter($course);
        $this->writer->setMode(ilCourseXMLWriter::MODE_EXPORT);
        $this->writer->start();
        return $this->writer->xmlDumpMem(false);
    }

    public function getValidSchemaVersions(string $a_entity): array
    {
        return [
            "10.0" => [
                "namespace" => 'http://www.ilias.de/Modules/Course/crs/10',
                "xsd_file" => 'ilias_crs_10.xsd',
                "uses_dataset" => false,
                "min" => "10.0",
                "max" => ""
            ],
            "9.0" => [
                "namespace" => 'http://www.ilias.de/Modules/Course/crs/9',
                "xsd_file" => 'ilias_crs_9_0.xsd',
                "uses_dataset" => false,
                "min" => "9.0",
                "max" => ""
            ],
            "4.1.0" => [
                "namespace" => "http://www.ilias.de/Modules/Course/crs/4_1",
                "xsd_file" => "ilias_course_4_1.xsd",
                "uses_dataset" => false,
                "min" => "4.1.0",
                "max" => "4.4.999"
            ],
            "5.0.0" => [
                "namespace" => "http://www.ilias.de/Modules/Course/crs/5_0",
                "xsd_file" => "ilias_crs_5_0.xsd",
                "uses_dataset" => false,
                "min" => "5.0.0",
                "max" => ""
            ]
        ];
    }
}