9.5/_abstract_composite_renderable_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Form\Domain\Model\Renderable;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It originated from the Neos.Form package (www.neos.io)

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


use ‪TYPO3\CMS\Form\Domain\Model\Exception\FormDefinitionConsistencyException;


abstract class ‪AbstractCompositeRenderable extends ‪AbstractRenderable implements ‪CompositeRenderableInterface

{


    protected ‪$renderables = [];


    protected function ‪addRenderable(‪RenderableInterface $renderable)

    {

        if ($renderable->‪getParentRenderable() !== null) {

            throw new ‪FormDefinitionConsistencyException(sprintf('The renderable with identifier "%s" is already added to another element (element identifier: "%s").', $renderable->‪getIdentifier(), $renderable->‪getParentRenderable()->‪getIdentifier()), 1325665144);

        }

        $renderable->‪setIndex(count($this->renderables));

        $renderable->‪setParentRenderable($this);

        $this->renderables[] = $renderable;

    }


    protected function ‪moveRenderableBefore(‪RenderableInterface $renderableToMove, ‪RenderableInterface $referenceRenderable)

    {

        if ($renderableToMove->‪getParentRenderable() !== $referenceRenderable->‪getParentRenderable() || $renderableToMove->‪getParentRenderable() !== $this) {

            throw new ‪FormDefinitionConsistencyException('Moved renderables need to be part of the same parent element.', 1326089744);

        }


        $reorderedRenderables = [];

        $i = 0;

        foreach ($this->renderables as $renderable) {

            if ($renderable === $renderableToMove) {

                continue;

            }


            if ($renderable === $referenceRenderable) {

                $reorderedRenderables[] = $renderableToMove;

                $renderableToMove->‪setIndex($i);

                $i++;

            }

            $reorderedRenderables[] = $renderable;

            $renderable->setIndex($i);

            $i++;

        }

        $this->renderables = $reorderedRenderables;

    }


    protected function ‪moveRenderableAfter(‪RenderableInterface $renderableToMove, ‪RenderableInterface $referenceRenderable)

    {

        if ($renderableToMove->‪getParentRenderable() !== $referenceRenderable->‪getParentRenderable() || $renderableToMove->‪getParentRenderable() !== $this) {

            throw new ‪FormDefinitionConsistencyException('Moved renderables need to be part of the same parent element.', 1477083145);

        }


        $reorderedRenderables = [];

        $i = 0;

        foreach ($this->renderables as $renderable) {

            if ($renderable === $renderableToMove) {

                continue;

            }


            $reorderedRenderables[] = $renderable;

            $renderable->setIndex($i);

            $i++;


            if ($renderable === $referenceRenderable) {

                $reorderedRenderables[] = $renderableToMove;

                $renderableToMove->‪setIndex($i);

                $i++;

            }

        }

        $this->renderables = $reorderedRenderables;

    }


    public function ‪getRenderablesRecursively(): array

    {

        ‪$renderables = [];

        foreach ($this->renderables as $renderable) {

            ‪$renderables[] = $renderable;

            if ($renderable instanceof ‪CompositeRenderableInterface) {

                ‪$renderables = array_merge(‪$renderables, $renderable->getRenderablesRecursively());

            }

        }

        return ‪$renderables;

    }


    protected function ‪removeRenderable(‪RenderableInterface $renderableToRemove)

    {

        if ($renderableToRemove->‪getParentRenderable() !== $this) {

            throw new ‪FormDefinitionConsistencyException('The renderable to be removed must be part of the calling parent renderable.', 1326090127);

        }


        $updatedRenderables = [];

        foreach ($this->renderables as $renderable) {

            if ($renderable === $renderableToRemove) {

                continue;

            }


            $updatedRenderables[] = $renderable;

        }

        $this->renderables = $updatedRenderables;


        $renderableToRemove->‪onRemoveFromParentRenderable();

    }


    public function ‪registerInFormIfPossible()

    {

        parent::registerInFormIfPossible();

        foreach ($this->renderables as $renderable) {

            $renderable->registerInFormIfPossible();

        }

    }


    public function ‪onRemoveFromParentRenderable()

    {

        foreach ($this->renderables as $renderable) {

            $renderable->onRemoveFromParentRenderable();

        }

        parent::onRemoveFromParentRenderable();

    }

}