ArrayFormFactory.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * 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!
 */
 
/*
 * Inspired by and partially taken from the Neos.Form package (www.neos.io)
 */
 
namespace ‪TYPO3\CMS\Form\Domain\Factory;
 
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Form\Domain\Configuration\ConfigurationService;
use ‪TYPO3\CMS\Form\Domain\Exception\IdentifierNotValidException;
use ‪TYPO3\CMS\Form\Domain\Exception\RenderingException;
use ‪TYPO3\CMS\Form\Domain\Exception\UnknownCompositRenderableException;
use ‪TYPO3\CMS\Form\Domain\Model\FormDefinition;
use ‪TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection;
use ‪TYPO3\CMS\Form\Domain\Model\Renderable\CompositeRenderableInterface;
 
class ‪ArrayFormFactory extends ‪AbstractFormFactory
{
    public function ‪build(array $configuration, string $prototypeName = null): ‪FormDefinition
    {
        if (empty($prototypeName)) {
            $prototypeName = $configuration['prototypeName'] ?? 'standard';
        }
        $persistenceIdentifier = $configuration['persistenceIdentifier'] ?? null;
 
        if ($configuration['invalid'] ?? false) {
            throw new ‪RenderingException($configuration['label'], 1529710560);
        }
 
        $prototypeConfiguration = GeneralUtility::makeInstance(ConfigurationService::class)
            ->getPrototypeConfiguration($prototypeName);
 
        $form = GeneralUtility::makeInstance(
            FormDefinition::class,
            $configuration['identifier'],
            $prototypeConfiguration,
            'Form',
            $persistenceIdentifier
        );
        if (isset($configuration['renderables'])) {
            foreach ($configuration['renderables'] as $pageConfiguration) {
                $this->‪addNestedRenderable($pageConfiguration, $form);
            }
        }
 
        unset($configuration['persistenceIdentifier']);
        unset($configuration['prototypeName']);
        unset($configuration['renderables']);
        unset($configuration['type']);
        unset($configuration['identifier']);
        $form->setOptions($configuration);
 
        $this->‪triggerFormBuildingFinished($form);
 
        return $form;
    }
 
    protected function ‪addNestedRenderable(array $nestedRenderableConfiguration, ‪CompositeRenderableInterface $parentRenderable)
    {
        if (!isset($nestedRenderableConfiguration['identifier'])) {
            throw new ‪IdentifierNotValidException('Identifier not set.', 1329289436);
        }
        if ($parentRenderable instanceof ‪FormDefinition) {
            $renderable = $parentRenderable->createPage($nestedRenderableConfiguration['identifier'], $nestedRenderableConfiguration['type']);
        } elseif ($parentRenderable instanceof ‪AbstractSection) {
            $renderable = $parentRenderable->createElement($nestedRenderableConfiguration['identifier'], $nestedRenderableConfiguration['type']);
        } else {
            throw new ‪UnknownCompositRenderableException('Unknown composit renderable "' . get_class($parentRenderable) . '"', 1479593622);
        }
 
        if (isset($nestedRenderableConfiguration['renderables']) && is_array($nestedRenderableConfiguration['renderables'])) {
            $childRenderables = $nestedRenderableConfiguration['renderables'];
        } else {
            $childRenderables = [];
        }
 
        unset($nestedRenderableConfiguration['type']);
        unset($nestedRenderableConfiguration['identifier']);
        unset($nestedRenderableConfiguration['renderables']);
 
        $renderable->setOptions($nestedRenderableConfiguration);
 
        if ($renderable instanceof ‪CompositeRenderableInterface) {
            foreach ($childRenderables as $elementConfiguration) {
                $this->‪addNestedRenderable($elementConfiguration, $renderable);
            }
        }
 
        return $renderable;
    }
}