BaseElement.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\Elements\Base;

use ILIAS\MetaData\Structure\Definitions\Definition;
use ILIAS\MetaData\Elements\NoID;
use ILIAS\MetaData\Structure\Definitions\DefinitionInterface;

abstract class BaseElement implements BaseElementInterface
{
    private array $sub_elements = [];
    private ?BaseElement $super_element = null;
    private DefinitionInterface $definition;
    private int|NoID $md_id;

    public function __construct(
        int|NoID $md_id,
        DefinitionInterface $definition,
        BaseElement ...$sub_elements
    ) {
        foreach ($sub_elements as $sub_element) {
            $this->addSubElement($sub_element);
        }
        $this->definition = $definition;
        $this->md_id = $md_id;
    }

    public function __clone()
    {
        if (!is_null($this->super_element)) {
            $this->setSuperElement(null);
        }
        $map = function (BaseElement $arg) {
            $arg = clone $arg;
            $arg->setSuperElement($this);
            return $arg;
        };
        $this->sub_elements = array_map(
            $map,
            $this->sub_elements
        );
    }

    public function getMDID(): int|NoID
    {
        return $this->md_id;
    }

    public function getSubElements(): \Generator
    {
        yield from $this->sub_elements;
    }

    protected function addSubElement(BaseElement $sub_element): void
    {
        $sub_element->setSuperElement($this);
        $this->sub_elements[] = $sub_element;
    }

    protected function orderSubElements(string ...$names_in_order): void
    {
        $sub_elements_by_name = [];
        foreach ($this->sub_elements as $sub_element) {
            $sub_elements_by_name[$sub_element->getDefinition()->name()][] = $sub_element;
        }

        $reordered_sub_elements = [];
        foreach ($names_in_order as $name) {
            $reordered_sub_elements = array_merge(
                $reordered_sub_elements,
                $sub_elements_by_name[$name] ?? []
            );
        }

        $this->sub_elements = $reordered_sub_elements;
    }

    public function getSuperElement(): ?BaseElement
    {
        return $this->super_element;
    }

    protected function setSuperElement(?BaseElement $super_element): void
    {
        if ($this->isRoot()) {
            throw new \ilMDElementsException(
                'Metadata root can not have a super element.'
            );
        }
        $this->super_element = $super_element;
    }

    public function isRoot(): bool
    {
        return $this->getMDID() === NoID::ROOT;
    }

    public function getDefinition(): DefinitionInterface
    {
        return $this->definition;
    }
}