khusseini / PimcoreRadBrickBundle

src/AreabrickRenderer.php

<?php

namespace Khusseini\PimcoreRadBrickBundle;

use Pimcore\Model\Document\Tag;
use Pimcore\Model\Document\Tag\Area\Info;
use Pimcore\Templating\Renderer\TagRenderer;

class AreabrickRenderer
{
    /**
     * @var AreabrickConfigurator
     */
    private $configurator;

    /**
     * @var TagRenderer
     */
    private $tagRenderer;

    public function __construct(
        AreabrickConfigurator $areabrickConfigurator,
        TagRenderer $tagRenderer
    ) {
        $this->configurator = $areabrickConfigurator;
        $this->tagRenderer = $tagRenderer;
    }

    public function getConfigurator(): AreabrickConfigurator
    {
        return $this->configurator;
    }

    public function render(string $name, Info $info)
    {
        $configurator = $this->getConfigurator();
        if (!$configurator->hasAreabrickConfig($name)) {
            throw new \InvalidArgumentException(sprintf('Areabrick \'%s\' has no configuration.', $name));
        }

        $context = new Context($info->getView(), $info->getRequest());

        $renderArguments = $this
            ->getConfigurator()
            ->compileAreaBrick($name, $context);

        $this->processRenderArguments(
            $info,
            $renderArguments
        );
    }

    /**
     * @param Iterator<RenderArgument> $renderArguments

The type Khusseini\PimcoreRadBrickBundle\Iterator was not found. Did you mean Iterator? If so, make sure to prefix the type with \.

     */
    public function processRenderArguments(
        Info $info,
        \Iterator $renderArguments,
        \ArrayAccess $container = null,
        \ArrayAccess $referencesContainer = null,
        string $parentName = ''
    ): void {
        if (!$container) {
            $container = $info->getView();
        }

        if (!$referencesContainer) {
            $referencesContainer = new \ArrayObject();
        }

        foreach ($renderArguments as $name => $renderArgument) {
            $referenceId = $parentName ? $parentName.'_'.$name : $name;

            if ('null' === $renderArgument->getType()) {
                continue;
            }

            if ('collection' === $renderArgument->getType()) {
                $tag = new \ArrayObject();
                $this->processRenderArguments(
                    $info,
                    new \ArrayIterator($renderArgument->getValue()),
                    $tag,
                    $referencesContainer,
                    $referenceId
                );
                $tag = (array) $tag;
            } elseif ('editable' === $renderArgument->getType()) {
                $tag = $this->renderArgument($info, $renderArgument, $referenceId);
            } elseif ('reference' === $renderArgument->getType()) {
                $reference = $renderArgument->getValue();
                $tag = $referencesContainer[$reference];
            } else {
                $tag = $renderArgument->getValue();
            }

            $referencesContainer[$referenceId] = $tag;
            $container[$name] = $tag;
        }
    }

    protected function renderArgument(Info $info, RenderArgument $renderArgument, string $nameOverride = ''): ?Tag
    {
        $config = $renderArgument->getValue();

        if (!\is_array($config)
            || !isset($config['type'])
        ) {
            return null;
        }

        if (!isset($config['options'])) {
            $config['options'] = [];
        }

        return $this

The expression return $this->tagRenderer->render($info->getDocument(), $config['type'], $nameOverride ?: $renderArgument->getName(), $config['options']) could return the type string which is incompatible with the type-hinted return Pimcore\Model\Document\Tag|null. Consider adding an additional type-check to rule them out.

            ->tagRenderer
            ->render(
                $info->getDocument(),
                $config['type'],
                $nameOverride ?: $renderArgument->getName(),
                $config['options']
            );
    }

    public function getAreabrickConfig(string $name): array
    {
        $configurator = $this->getConfigurator();
        $configurator->resolveAreaBrickConfig($name);

        return $configurator->getAreabrickConfig($name);
    }
}