TypoScriptFactory.php

Go to the documentation of this file.

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

class TypoScriptFactory implements \TYPO3\CMS\Core\SingletonInterface {

    const PROPERTY_DisableContentElement = 'disableContentElement';

    protected $localContentObject;

    protected $disableContentElement = FALSE;

    public function buildModelFromTyposcript(array $typoscript) {
        if (isset($typoscript[self::PROPERTY_DisableContentElement])) {
            $this->setDisableContentElement($typoscript[self::PROPERTY_DisableContentElement]);
        }
        $this->setLayoutHandler($typoscript);
        $form = $this->createElement('form', $typoscript);
        return $form;
    }

    public function setDisableContentElement($disableContentElement) {
        $this->disableContentElement = (bool) $disableContentElement;
    }

    public function getChildElementsByIntegerKey(\TYPO3\CMS\Form\Domain\Model\Element\AbstractElement $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 = array();
                    }
                    $this->setElementType($parentElement, $class, $elementArguments);
                }
            }
        } else {
            throw new \InvalidArgumentException('Container element with id=' . $parentElement->getElementId() . ' has no configuration which means no children.', 1333754854);
        }
    }

    public function setElementType(\TYPO3\CMS\Form\Domain\Model\Element\AbstractElement $parentElement, $class, array $arguments) {
        if (in_array($class, \TYPO3\CMS\Form\Utility\FormUtility::getInstance()->getFormObjects())) {
            $this->addElement($parentElement, $class, $arguments);
        } elseif ($this->disableContentElement === FALSE) {
            if ($class[0] === '<') {
                $key = trim(substr($class, 1));
                $typoscriptParser = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\TypoScript\\Parser\\TypoScriptParser');
                $oldArguments = $arguments;
                list($class, $arguments) = $typoscriptParser->getVal($key, $GLOBALS['TSFE']->tmpl->setup);
                if (is_array($oldArguments) && count($oldArguments)) {
                    $arguments = array_replace_recursive($arguments, $oldArguments);
                }
                $GLOBALS['TT']->incStackPointer();
                $contentObject = array(
                    'cObj' => $class,
                    'cObj.' => $arguments
                );
                $this->addElement($parentElement, 'content', $contentObject);
                $GLOBALS['TT']->decStackPointer();
            } else {
                $contentObject = array(
                    'cObj' => $class,
                    'cObj.' => $arguments
                );
                $this->addElement($parentElement, 'content', $contentObject);
            }
        }
    }

    public function addElement(\TYPO3\CMS\Form\Domain\Model\Element\AbstractElement $parentElement, $class, array $arguments = array()) {
        $element = $this->createElement($class, $arguments);
        if (method_exists($parentElement, 'addElement')) {
            $parentElement->addElement($element);
        }
    }

    public function createElement($class, array $arguments = array()) {
        $class = strtolower((string) $class);
        if ($class === 'form') {
            $className = 'TYPO3\\CMS\\Form\\Domain\\Model\\' . ucfirst($class);
        } else {
            $className = 'TYPO3\\CMS\\Form\\Domain\\Model\\Element\\' . ucfirst($class) . 'Element';
        }
        $object = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance($className);
        if ($object->getElementType() === \TYPO3\CMS\Form\Domain\Model\Element\AbstractElement::ELEMENT_TYPE_CONTENT) {
            $object->setData($arguments['cObj'], $arguments['cObj.']);
        } elseif ($object->getElementType() === \TYPO3\CMS\Form\Domain\Model\Element\AbstractElement::ELEMENT_TYPE_PLAIN) {
            $object->setProperties($arguments);
        } elseif ($object->getElementType() === \TYPO3\CMS\Form\Domain\Model\Element\AbstractElement::ELEMENT_TYPE_FORM) {
            $object->setData($arguments['data']);
            $this->reconstituteElement($object, $arguments);
        } else {
            throw new \InvalidArgumentException('Element type "' . $object->getElementType() . '" is not supported.', 1333754878);
        }
        return $object;
    }

    protected function reconstituteElement(\TYPO3\CMS\Form\Domain\Model\Element\AbstractElement $element, array $arguments = array()) {
        if (isset($arguments['value.'])) {
            $cObj = $this->getLocalConentObject();
            $arguments['value'] = $cObj->stdWrap($arguments['value'], $arguments['value.']);
        }

        $this->setAttributes($element, $arguments);
        $this->setAdditionals($element, $arguments);
        if (isset($arguments['filters.'])) {
            $this->setFilters($element, $arguments['filters.']);
        }
        $element->setLayout($arguments['layout']);
        $element->setValue($arguments['value']);
        $element->setName($arguments['name']);
        $element->setMessagesFromValidation();
        $element->setErrorsFromValidation();
        $element->checkFilterAndSetIncomingDataFromRequest();
        $this->getChildElementsByIntegerKey($element, $arguments);
    }

    public function setAttributes(\TYPO3\CMS\Form\Domain\Model\Element\AbstractElement $element, array $arguments) {
        if ($element->hasAllowedAttributes()) {
            $attributes = $element->getAllowedAttributes();
            $mandatoryAttributes = $element->getMandatoryAttributes();
            foreach ($attributes as $attribute => $value) {
                if (isset($arguments[$attribute]) || isset($arguments[$attribute . '.']) || in_array($attribute, $mandatoryAttributes) || !empty($value)) {
                    if ((string)$arguments[$attribute] !== '') {
                        $value = $arguments[$attribute];
                    } elseif (!empty($arguments[($attribute . '.')])) {
                        $value = $arguments[$attribute . '.'];
                    }
                    try {
                        $element->setAttribute($attribute, $value);
                    } catch (\Exception $exception) {
                        throw new \RuntimeException('Cannot call user function for attribute ' . ucfirst($attribute), 1333754904);
                    }
                }
            }
        } else {
            throw new \InvalidArgumentException('The element with id=' . $element->getElementId() . ' has no default attributes set.', 1333754925);
        }
    }

    public function setAdditionals(\TYPO3\CMS\Form\Domain\Model\Element\AbstractElement $element, array $arguments) {
        if (!empty($arguments)) {
            if ($element->hasAllowedAdditionals()) {
                $additionals = $element->getAllowedAdditionals();
                foreach ($additionals as $additional) {
                    if (isset($arguments[$additional . '.']) || isset($arguments[$additional])) {
                        if (isset($arguments[$additional]) && isset($arguments[$additional . '.'])) {
                            $value = $arguments[$additional . '.'];
                            $type = $arguments[$additional];
                        } elseif (isset($arguments[$additional . '.'])) {
                            $value = $arguments[$additional . '.'];
                            $type = 'TEXT';
                        } else {
                            $value['value'] = $arguments[$additional];
                            $type = 'TEXT';
                        }
                        try {
                            $element->setAdditional($additional, $type, $value);
                        } catch (\Exception $exception) {
                            throw new \RuntimeException('Cannot call user function for additional ' . ucfirst($additional), 1333754941);
                        }
                    }
                    if (isset($arguments['layout.'][$additional]) && $element->additionalIsSet($additional)) {
                        $layout = $arguments['layout.'][$additional];
                        $element->setAdditionalLayout($additional, $layout);
                    }
                }
            } else {
                throw new \InvalidArgumentException('The element with id=' . $element->getElementId() . ' has no additionals set.', 1333754962);
            }
        }
    }

    protected function setFilters(\TYPO3\CMS\Form\Domain\Model\Element\AbstractElement $element, array $arguments) {
        $keys = \TYPO3\CMS\Core\TypoScript\TemplateService::sortedKeyList($arguments);
        foreach ($keys as $key) {
            $class = $arguments[$key];
            if ((int)$key && strpos($key, '.') === FALSE) {
                $filterArguments = $arguments[$key . '.'];
                $filter = $element->makeFilter($class, $filterArguments);
                $element->addFilter($filter);
            }
        }
    }

    public function setLayoutHandler(array $typoscript) {
        $layoutHandler = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Form\\Layout');
        $layoutHandler->setLayout($this->getLayoutFromTypoScript($typoscript));
        return $layoutHandler;
    }

    public function getLayoutFromTypoScript($typoscript) {
        return !empty($typoscript['layout.']) ? $typoscript['layout.'] : array();
    }

    public function setRequestHandler($typoscript) {
        $prefix = isset($typoscript['prefix']) ? $typoscript['prefix'] : '';
        $method = isset($typoscript['method']) ? $typoscript['method'] : '';
        $requestHandler = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Form\\Request');
        // singleton
        $requestHandler->setPrefix($prefix);
        $requestHandler->setMethod($method);
        $requestHandler->storeFiles();
        return $requestHandler;
    }

    public function setRules(array $typoscript) {
        $rulesTyposcript = isset($typoscript['rules.']) ? $typoscript['rules.'] : NULL;
        $rulesClass = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Form\\Utility\\ValidatorUtility', $rulesTyposcript);
        // singleton
        if (is_array($rulesTyposcript)) {
            $keys = \TYPO3\CMS\Core\TypoScript\TemplateService::sortedKeyList($rulesTyposcript);
            foreach ($keys as $key) {
                $class = $rulesTyposcript[$key];
                if ((int)$key && strpos($key, '.') === FALSE) {
                    $elementArguments = $rulesTyposcript[$key . '.'];
                    $rule = $rulesClass->createRule($class, $elementArguments);
                    $rule->setFieldName($elementArguments['element']);
                    $breakOnError = isset($elementArguments['breakOnError']) ? $elementArguments['breakOnError'] : FALSE;
                    $rulesClass->addRule($rule, $elementArguments['element'], $breakOnError);
                }
            }
        }
        return $rulesClass;
    }

    protected function getLocalConentObject() {
        if (!isset($this->localContentObject)) {
            $this->localContentObject = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer');
        }
        return $this->localContentObject;
    }

}