JsonToTypoScript.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Form\Domain\Factory;

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

class JsonToTypoScript
{
    protected $elementId = 0;

    protected $validationRules = [];

    protected $validationRulesCounter = 1;

    public function convert($json)
    {
        $elements = json_decode((string)$json, true);
        $typoscriptArray = [];
        $typoscript = null;
        $this->convertToTyposcriptArray($elements, $typoscriptArray);
        if ($typoscriptArray['10.'] && is_array($typoscriptArray['10.']) && !empty($typoscriptArray['10.'])) {
            $typoscript = $this->typoscriptArrayToString($typoscriptArray['10.']);
        }
        return $typoscript;
    }

    protected function convertToTyposcriptArray(array $elements, array &$parent, $childrenWithParentName = false)
    {
        if (is_array($elements)) {
            $elementCounter = 10;
            foreach ($elements as $element) {
                if ($element['xtype']) {
                    $this->elementId++;
                    switch ($element['xtype']) {
                        case 'typo3-form-wizard-elements-basic-button':

                        case 'typo3-form-wizard-elements-basic-checkbox':

                        case 'typo3-form-wizard-elements-basic-fileupload':

                        case 'typo3-form-wizard-elements-basic-hidden':

                        case 'typo3-form-wizard-elements-basic-password':

                        case 'typo3-form-wizard-elements-basic-radio':

                        case 'typo3-form-wizard-elements-basic-reset':

                        case 'typo3-form-wizard-elements-basic-select':

                        case 'typo3-form-wizard-elements-basic-submit':

                        case 'typo3-form-wizard-elements-basic-textarea':

                        case 'typo3-form-wizard-elements-basic-textline':

                        case 'typo3-form-wizard-elements-predefined-email':

                        case 'typo3-form-wizard-elements-content-header':

                        case 'typo3-form-wizard-elements-content-textblock':
                            $this->getDefaultElementSetup($element, $parent, $elementCounter, $childrenWithParentName);
                            break;
                        case 'typo3-form-wizard-elements-basic-fieldset':

                        case 'typo3-form-wizard-elements-predefined-name':
                            $this->getDefaultElementSetup($element, $parent, $elementCounter);
                            $this->getContainer($element, $parent, $elementCounter);
                            break;
                        case 'typo3-form-wizard-elements-predefined-checkboxgroup':

                        case 'typo3-form-wizard-elements-predefined-radiogroup':
                            $this->getDefaultElementSetup($element, $parent, $elementCounter);
                            $this->getContainer($element, $parent, $elementCounter, true);
                            break;
                        case 'typo3-form-wizard-elements-basic-form':
                            $this->getDefaultElementSetup($element, $parent, $elementCounter);
                            $this->getContainer($element, $parent, $elementCounter);
                            $this->getForm($element, $parent, $elementCounter);
                            break;
                        default:

                    }
                }
                $elementCounter = $elementCounter + 10;
            }
        }
    }

    protected function getContainer(array $element, array &$parent, $elementCounter, $childrenWithParentName = false)
    {
        if ($element['elementContainer'] && $element['elementContainer']['items']) {
            $this->convertToTyposcriptArray($element['elementContainer']['items'], $parent[$elementCounter . '.'], $childrenWithParentName);
        }
    }

    protected function getForm(array $element, array &$parent, $elementCounter)
    {
        // @todo Put at the top of the form
        if (!empty($this->validationRules)) {
            $parent[$elementCounter . '.']['rules'] = $this->validationRules;
        }
    }

    protected function getDefaultElementSetup(array $element, array &$parent, $elementCounter, $childrenWithParentName = false)
    {
        $contentObjectType = $this->getContentObjectType($element);
        if (is_null($contentObjectType) === false) {
            $parent[$elementCounter] = $contentObjectType;
            $parent[$elementCounter . '.'] = [];
            if ($element['configuration']) {
                $this->setConfiguration($element, $parent, $elementCounter, $childrenWithParentName);
            }
        }
    }

    protected function getContentObjectType(array $element)
    {
        $contentObjectType = null;
        $shortXType = str_replace('typo3-form-wizard-elements-', '', $element['xtype']);
        list($category, $type) = explode('-', $shortXType);
        switch ($category) {
            case 'basic':
                $contentObjectType = strtoupper($type);
                break;
            case 'predefined':
                switch ($type) {
                case 'checkboxgroup':

                case 'radiogroup':
                    $contentObjectType = strtoupper($type);
                    break;
                case 'email':
                    $contentObjectType = 'TEXTLINE';
                    break;
                case 'name':
                    $contentObjectType = 'FIELDSET';
                }
                break;
            case 'content':
                switch ($type) {
                case 'header':

                case 'textblock':
                    $contentObjectType = strtoupper($type);
                }
            default:

        }
        return $contentObjectType;
    }

    protected function setConfiguration(array $element, array &$parent, $elementCounter, $childrenWithParentName = false)
    {
        foreach ($element['configuration'] as $key => $value) {
            switch ($key) {
                case 'attributes':
                    $this->setAttributes($value, $parent, $elementCounter, $childrenWithParentName);
                    break;
                case 'confirmation':
                    $this->setConfirmation($value, $parent, $elementCounter);
                    break;
                case 'filters':
                    $this->setFilters($value, $parent, $elementCounter);
                    break;
                case 'label':
                    $this->setLabel($value, $parent, $elementCounter);
                    break;
                case 'layout':
                    $this->setLayout($element, $value, $parent, $elementCounter);
                    break;
                case 'legend':
                    $this->setLegend($value, $parent, $elementCounter);
                    break;
                case 'options':
                    $this->setOptions($element, $value, $parent, $elementCounter);
                    break;
                case 'postProcessor':
                    $this->setPostProcessor($value, $parent, $elementCounter);
                    break;
                case 'prefix':
                    $this->setPrefix($value, $parent, $elementCounter);
                    break;
                case 'validation':
                    $this->setValidationRules($element, $value);
                    break;
                case 'various':
                    $this->setVarious($element, $value, $parent, $elementCounter);
                    break;
                default:

            }
        }
    }

    protected function setAttributes(array $attributes, array &$parent, $elementCounter, $childrenWithParentName = false)
    {
        foreach ($attributes as $key => $value) {
            if ($key === 'name' && $value === '' && !$childrenWithParentName) {
                $value = $this->elementId;
            }
            if ($value != '') {
                $parent[$elementCounter . '.'][$key] = $value;
            }
        }
    }

    protected function setConfirmation($confirmation, array &$parent, $elementCounter)
    {
        $parent[$elementCounter . '.']['confirmation'] = $confirmation;
    }

    protected function setFilters(array $filters, array &$parent, $elementCounter)
    {
        if (!empty($filters)) {
            $parent[$elementCounter . '.']['filters'] = [];
            $filterCounter = 1;
            foreach ($filters as $name => $filterConfiguration) {
                $parent[$elementCounter . '.']['filters'][$filterCounter] = $name;
                $parent[$elementCounter . '.']['filters'][$filterCounter . '.'] = $filterConfiguration;
                $filterCounter++;
            }
        }
    }

    protected function setLabel(array $label, array &$parent, $elementCounter)
    {
        if ($label['value'] != '') {
            $parent[$elementCounter . '.']['label.']['value'] = $label['value'];
        }
    }

    protected function setLayout(array $element, $value, array &$parent, $elementCounter)
    {
        switch ($element['xtype']) {
            case 'typo3-form-wizard-elements-basic-button':

            case 'typo3-form-wizard-elements-basic-fileupload':

            case 'typo3-form-wizard-elements-basic-password':

            case 'typo3-form-wizard-elements-basic-reset':

            case 'typo3-form-wizard-elements-basic-submit':

            case 'typo3-form-wizard-elements-basic-textline':
                if ($value === 'back') {
                    $parent[$elementCounter . '.']['layout'] = '<input />' . LF . '<label />';
                }
                break;
            case 'typo3-form-wizard-elements-basic-checkbox':

            case 'typo3-form-wizard-elements-basic-radio':
                if ($value === 'front') {
                    $parent[$elementCounter . '.']['layout'] = '<label />' . LF . '<input />';
                }
                break;
            case 'typo3-form-wizard-elements-basic-select':
                if ($value === 'back') {
                    $parent[$elementCounter . '.']['layout'] = '<select>' . LF . '<elements />' . LF . '</select>' . LF . '<label />';
                }
                break;
            case 'typo3-form-wizard-elements-basic-textarea':
                if ($value === 'back') {
                    $parent[$elementCounter . '.']['layout'] = '<textarea />' . LF . '<label />';
                }
                break;
            default:

        }
    }

    protected function setLegend(array $legend, array &$parent, $elementCounter)
    {
        if ($legend['value'] != '') {
            $parent[$elementCounter . '.']['legend.']['value'] = $legend['value'];
        }
    }

    protected function setOptions(array $element, array $options, array &$parent, $elementCounter)
    {
        if (is_array($options) && $element['xtype'] === 'typo3-form-wizard-elements-basic-select') {
            $optionCounter = 10;
            foreach ($options as $option) {
                $parent[$elementCounter . '.'][$optionCounter] = 'OPTION';
                $parent[$elementCounter . '.'][$optionCounter . '.']['text'] = $option['text'];
                if (isset($option['attributes'])) {
                    $parent[$elementCounter . '.'][$optionCounter . '.'] += $option['attributes'];
                }
                $optionCounter = $optionCounter + 10;
            }
        }
    }

    protected function setPostProcessor(array $postProcessors, array &$parent, $elementCounter)
    {
        if (!empty($postProcessors)) {
            $parent[$elementCounter . '.']['postProcessor'] = [];
            $postProcessorCounter = 1;
            foreach ($postProcessors as $name => $postProcessorConfiguration) {
                $parent[$elementCounter . '.']['postProcessor'][$postProcessorCounter] = $name;
                $parent[$elementCounter . '.']['postProcessor'][$postProcessorCounter . '.'] = $postProcessorConfiguration;
                $postProcessorCounter++;
            }
        }
    }

    protected function setPrefix($prefix, array &$parent, $elementCounter)
    {
        $parent[$elementCounter . '.']['prefix'] = $prefix;
    }

    protected function setValidationRules(array $element, array $validationRules)
    {
        foreach ($validationRules as $name => $ruleConfiguration) {
            if (isset($element['configuration']['attributes']['name']) && $element['configuration']['attributes']['name'] != '') {
                $ruleConfiguration['element'] = $element['configuration']['attributes']['name'];
            } elseif (isset($element['configuration']['various']['name']) && $element['configuration']['various']['name'] != '') {
                $ruleConfiguration['element'] = $element['configuration']['various']['name'];
            } else {
                $ruleConfiguration['element'] = $this->elementId;
            }
            $this->validationRules[$this->validationRulesCounter] = $name;
            $this->validationRules[$this->validationRulesCounter . '.'] = $ruleConfiguration;
            $this->validationRulesCounter++;
        }
    }

    protected function setVarious(array $element, array $various, array &$parent, $elementCounter)
    {
        foreach ($various as $key => $value) {
            switch ($key) {
                case 'headingSize':

                case 'content':

                case 'text':

                case 'name':
                    $parent[$elementCounter . '.'][$key] = (string)$value;
                    break;
            }
        }
    }

    protected function typoscriptArrayToString(array $typoscriptArray, $addKey = '', $tabCount = -1)
    {
        $typoscript = '';
        if ($addKey != '') {
            $typoscript .= str_repeat(TAB, $tabCount) . str_replace('.', '', $addKey) . ' {' . LF;
        }
        $tabCount++;
        foreach ($typoscriptArray as $key => $value) {
            if (!is_array($value)) {
                if (strstr($value, LF)) {
                    $typoscript .= str_repeat(TAB, $tabCount) . $key . ' (' . LF;
                    if ($key !== 'text') {
                        $value = str_replace(LF, LF . str_repeat(TAB, ($tabCount + 1)), $value);
                        $typoscript .= str_repeat(TAB, ($tabCount + 1)) . $value . LF;
                    } else {
                        $typoscript .= $value . LF;
                    }
                    $typoscript .= str_repeat(TAB, $tabCount) . ')' . LF;
                } else {
                    $typoscript .= str_repeat(TAB, $tabCount) . $key . ' = ' . $value . LF;
                }
            } else {
                $typoscript .= $this->typoscriptArrayToString($value, $key, $tabCount);
            }
        }
        if ($addKey != '') {
            $tabCount--;
            $typoscript .= str_repeat(TAB, $tabCount) . '}' . LF;
        }
        return $typoscript;
    }
}