LOMReader.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\Structure\Definitions;

use ILIAS\MetaData\Elements\Data\Type;

class LOMReader implements ReaderInterface
{
    protected array $definition_array;
    protected int $depth = 0;

    public function __construct(
        int $depth = 0,
        ?array $definition_array = null
    ) {
        if ($this->depth > 20) {
            throw new \ilMDStructureException('LOM Structure is nested to deep.');
        }
        if (!is_null($definition_array)) {
            $this->definition_array = $definition_array;
            return;
        }
        $this->definition_array = $this->getDefinitionArray();
        $this->depth = $depth;
    }

    protected function getDefinitionArray(): array
    {
        return require(__DIR__ . "/../../../StructureDefinition/LOMStructure.php");
    }

    public function definition(): DefinitionInterface
    {
        return new Definition(
            $this->name(),
            $this->unique(),
            $this->dataType()
        );
    }

    public function subDefinitions(): \Generator
    {
        $sub_definitions = $this->definition_array['sub'] ?? [];
        foreach ($this->definition_array['sub'] as $sub_definition) {
            $reader = new LOMReader(
                $this->depth + 1,
                $sub_definition
            );
            yield $reader;
        }
    }

    protected function name(): string
    {
        if (!isset($this->definition_array['name'])) {
            $this->throwStructureException('missing name');
        }
        return $this->definition_array['name'];
    }

    protected function unique(): bool
    {
        if (!isset($this->definition_array['unique'])) {
            $this->throwStructureException('missing unique');
        }
        return (bool) $this->definition_array['unique'];
    }

    protected function dataType(): Type
    {
        if (
            !isset($this->definition_array['type']) ||
            is_null($type = $this->definition_array['type'])
        ) {
            $this->throwStructureException('invalid data type');
        }
        return $type;
    }

    protected function throwStructureException(string $error): void
    {
        throw new \ilMDStructureException(
            'LOM definition is invalid:' . $error
        );
    }
}