TypoScriptToJsonConverter.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Form\Utility;

/*
 * 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!
 */

use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Form\Domain\Model\Json\AbstractJsonElement;

class TypoScriptToJsonConverter
{
    protected $registeredElementNames = [
        'BUTTON',
        'CHECKBOX',
        'CHECKBOXGROUP',
        'FIELDSET',
        'FILEUPLOAD',
        'HEADER',
        'HIDDEN',
        'IMAGEBUTTON',
        'OPTGROUP',
        'OPTION',
        'PASSWORD',
        'RADIO',
        'RADIOGROUP',
        'RESET',
        'SELECT',
        'SUBMIT',
        'TEXTAREA',
        'TEXTBLOCK',
        'TEXTLINE'
    ];

    protected $nameMapping = [
        'checkboxgroup' => 'CheckboxGroup',
        'radiogroup' => 'RadioGroup',
    ];

    protected $validationRules;

    public function convert(array $typoscript)
    {
        $this->setValidationRules($typoscript);
        $jsonObject = $this->createElement('form', $typoscript);
        return $jsonObject;
    }

    public function createElement($class, array $arguments = [])
    {
        $class = strtolower((string)$class);
        if (!empty($this->nameMapping[$class])) {
            $class = $this->nameMapping[$class];
        }
        $className = 'TYPO3\\CMS\\Form\\Domain\\Model\Json\\' . ucfirst($class) . 'JsonElement';
        $this->addValidationRules($arguments);

        if (!class_exists($className)) {
            throw new \RuntimeException('Class "' . $className . '" does not exist', 1440779351);
        }

        $object = GeneralUtility::makeInstance($className);
        $object->setParameters($arguments);
        if ($object->childElementsAllowed()) {
            $this->getChildElementsByIntegerKey($object, $arguments);
        }
        return $object;
    }

    protected function getChildElementsByIntegerKey(AbstractJsonElement $parentElement, array $typoscript)
    {
        if (is_array($typoscript)) {
            $keys = \TYPO3\CMS\Core\TypoScript\TemplateService::sortedKeyList($typoscript);
            foreach ($keys as $key) {
                $class = $typoscript[$key];
                if ((int)$key && strpos($key, '.') === false) {
                    if (isset($typoscript[$key . '.'])) {
                        $elementArguments = $typoscript[$key . '.'];
                    } else {
                        $elementArguments = [];
                    }
                    $this->setElementType($parentElement, $class, $elementArguments);
                }
            }
        }
    }

    private function setElementType(AbstractJsonElement $parentElement, $class, array $arguments)
    {
        if (in_array($class, $this->registeredElementNames)) {
            if (strstr($arguments['class'], 'predefined-name')) {
                $class = 'NAME';
            }
            $this->addElement($parentElement, $class, $arguments);
        }
    }

    public function addElement(AbstractJsonElement $parentElement, $class, array $arguments)
    {
        try {
            $element = $this->createElement($class, $arguments);
            $parentElement->addElement($element);
        } catch (\RuntimeException $exception) {
            // Catch missing classes or element types
            // There are elements that can be used the
            // TypoScript-like declaration, which don't
            // have a counterpart in the ExtJS wizard.
        }
    }

    protected function setValidationRules(array $typoscript)
    {
        if (isset($typoscript['rules.']) && is_array($typoscript['rules.'])) {
            $this->validationRules = $typoscript['rules.'];
        }
    }

    protected function addValidationRules(array &$arguments)
    {
        if (!empty($this->validationRules) && isset($arguments['name'])) {
            foreach ($this->validationRules as $key => $ruleName) {
                if ((int)$key && strpos($key, '.') === false) {
                    if (isset($this->validationRules[$key . '.'])) {
                        $ruleConfiguration = $this->validationRules[$key . '.'];
                        if (isset($ruleConfiguration['element']) && $ruleConfiguration['element'] === $arguments['name']) {
                            $arguments['validation'][$ruleName] = $ruleConfiguration;
                        }
                    }
                }
            }
        }
    }
}