ScaffoldProvider.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\Repository\Utilities;

use ILIAS\MetaData\Elements\ElementInterface;
use ILIAS\MetaData\Paths\FactoryInterface as PathFactoryInterface;
use ILIAS\MetaData\Paths\Navigator\NavigatorFactoryInterface;
use ILIAS\MetaData\Elements\Structure\StructureSetInterface;
use ILIAS\MetaData\Elements\Scaffolds\ScaffoldFactory;

class ScaffoldProvider implements ScaffoldProviderInterface
{
    protected ScaffoldFactory $scaffold_factory;
    protected PathFactoryInterface $path_factory;
    protected NavigatorFactoryInterface $navigator_factory;
    protected StructureSetInterface $structure;

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

    public function getScaffoldsForElement(
        ElementInterface $element
    ): \Generator {
        $navigator = $this->navigator_factory->structureNavigator(
            $this->path_factory->toElement($element),
            $this->structure->getRoot()
        );
        $structure_element = $navigator->elementAtFinalStep();

        $sub_names = [];
        foreach ($element->getSubElements() as $sub) {
            $sub_names[] = $sub->getDefinition()->name();
        }

        $previous_sub = null;
        foreach ($structure_element->getSubElements() as $sub) {
            $sub = $sub->getDefinition();
            if (
                isset($previous_sub) &&
                (!$previous_sub->unique() || !in_array($previous_sub->name(), $sub_names))
            ) {
                yield $sub->name() => $this->scaffold_factory->scaffold($previous_sub);
            }
            $previous_sub = $sub;
        }
        if (
            isset($previous_sub) &&
            (!$previous_sub->unique() || !in_array($previous_sub->name(), $sub_names))
        ) {
            yield '' => $this->scaffold_factory->scaffold($previous_sub);
        }
    }
}