class.ilContainerReferenceImporter.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

abstract class ilContainerReferenceImporter extends ilXmlImporter
{
    protected ?ilContainerReference $ref = null;

    public function init(): void
    {
    }

    protected function initReference(int $a_ref_id = 0): void
    {
        $ref = ilObjectFactory::getInstanceByRefId($a_ref_id, true);
        $this->ref = $ref;
    }

    abstract protected function getType(): string;

    abstract protected function initParser(string $a_xml): ilContainerReferenceXmlParser;

    protected function getReference(): ilContainerReference
    {
        return $this->ref;
    }

    public function importXmlRepresentation(
        string $a_entity,
        string $a_id,
        string $a_xml,
        ilImportMapping $a_mapping
    ): void {
        global $DIC;

        $objDefinition = $DIC["objDefinition"];
        $log = $DIC->logger()->root();

        if ($new_id = $a_mapping->getMapping('components/ILIAS/Container', 'objs', $a_id)) {
            $refs = ilObject::_getAllReferences((int) $new_id);
            $this->initReference(end($refs));
        }
        // Mapping for containers without subitems
        elseif ($new_id = $a_mapping->getMapping('components/ILIAS/Container', 'refs', '0')) {
            $this->initReference((int) $new_id);
        } elseif (!$this->getReference() instanceof ilContainerReference) {
            $this->initReference();
            $this->getReference()->create();
        }

        try {
            $parser = $this->initParser($a_xml);
            $parser->setImportMapping($a_mapping);
            $parser->setReference($this->getReference());
            $parser->setMode(ilContainerReferenceXmlParser::MODE_UPDATE);
            $parser->startParsing();

            $a_mapping->addMapping(
                $objDefinition->getComponentForType($this->getType()),
                $this->getType(),
                $a_id,
                (string) $this->getReference()->getId()
            );
        } catch (ilSaxParserException | Exception $e) {
            $log->error(__METHOD__ . ': Parsing failed with message, "' . $e->getMessage() . '".');
        }
    }
}