DictionaryInitiator.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\Structure\Dictionaries;

use ILIAS\MetaData\Structure\Dictionaries\Tags\TagInterface;
use ILIAS\MetaData\Elements\Structure\StructureElementInterface;
use ILIAS\MetaData\Paths\FactoryInterface as PathFactoryInterface;
use ILIAS\MetaData\Structure\Dictionaries\Tags\TagAssignmentInterface;
use ILIAS\MetaData\Structure\Dictionaries\Tags\TagAssignment;
use ILIAS\MetaData\Elements\Structure\StructureSetInterface;
use ILIAS\MetaData\Paths\Navigator\NavigatorFactoryInterface;

abstract class DictionaryInitiator
{
    protected PathFactoryInterface $path_factory;

    protected NavigatorFactoryInterface $navigator_factory;

    private StructureSetInterface $structure;

    private array $tag_assignments = [];

    public function __construct(
        PathFactoryInterface $path_factory,
        NavigatorFactoryInterface $navigator_factory,
        StructureSetInterface $structure
    ) {
        $this->path_factory = $path_factory;
        $this->navigator_factory = $navigator_factory;
        $this->structure = $structure;
    }

    final protected function addTagToElement(
        TagInterface $tag,
        StructureElementInterface $element
    ): void {
        $this->tag_assignments[] = new TagAssignment(
            $this->path_factory->toElement($element),
            $tag
        );
    }

    final protected function getTagAssignments(): \Generator
    {
        yield from $this->tag_assignments;
    }

    final protected function getStructure(): StructureSetInterface
    {
        return $this->structure;
    }
}