FormUtility.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\Configuration;

class FormUtility
{
    public static function create(Configuration $configuration)
    {
        $formUtility = self::getObjectManager()->get(self::class);
        $formUtility->setConfiguration($configuration);
        return $formUtility;
    }

    protected $configuration;

    public function setConfiguration(Configuration $configuration)
    {
        $this->configuration = $configuration;
    }

    public function renderItem($configuration, $type = null, $defaultMessage = '')
    {
        if ($this->configuration->getContentElementRendering()) {
            $renderedMessage = null;
            if ($type !== null) {
                if (is_array($configuration)) {
                    /* Direct cObject rendering */
                    $value = $configuration;
                } else {
                    /* got only a string, no rendering required */
                    $renderedMessage = $type;
                }
            } else {
                if ($configuration !== null) {
                    /* Render the "short syntax"
                     * The wizard write things like label.value
                     * The previous version of EXT:form interpreted this
                     * as a TEXT content object, so we do the same
                     *  */
                    $type = 'TEXT';
                    if (is_array($configuration)) {
                        $value = $configuration;
                    } else {
                        $value['value'] = $configuration;
                    }
                } else {
                    /* return the default message
                     * If $type === NULL and $configuration === NULL
                     * return the default message (if set).
                     * */
                    $renderedMessage = $defaultMessage;
                }
            }
            if ($renderedMessage === null) {
                $renderedMessage = $GLOBALS['TSFE']->cObj->cObjGetSingle(
                    $type,
                    $value
                );
            }
        } else {
            if ($type !== null) {
                if ($configuration !== null) {
                    /* the wizard write things like label.value = some text
                     * so we need the handle that, even content object rendering
                     * is not allowed.
                     *  */
                    if (isset($configuration['value'])) {
                        $renderedMessage = $configuration['value'];
                    } else {
                        $renderedMessage = $defaultMessage;
                    }
                } else {
                    // string, no rendering required
                    $renderedMessage = $type;
                }
            } else {
                $renderedMessage = $defaultMessage;
                if (
                    is_array($configuration)
                    && isset($configuration['value'])
                ) {
                    $renderedMessage = $configuration['value'];
                }
            }
        }
        return $renderedMessage;
    }

    public function renderArrayItems(array &$arrayToRender = [])
    {
        foreach ($arrayToRender as $attributeName => &$attributeValue) {
            $attributeNameWithoutDot = rtrim($attributeName, '.');
            if (
                isset($arrayToRender[$attributeNameWithoutDot])
                && isset($arrayToRender[$attributeNameWithoutDot . '.'])
            ) {
                $attributeValue = $this->renderItem(
                    $arrayToRender[$attributeNameWithoutDot . '.'],
                    $arrayToRender[$attributeNameWithoutDot]
                );
                unset($arrayToRender[$attributeNameWithoutDot . '.']);
            } elseif (
                !isset($arrayToRender[$attributeNameWithoutDot])
                && isset($arrayToRender[$attributeNameWithoutDot . '.'])
            ) {
                $this->renderArrayItems($attributeValue);
            }
        }
    }

    public function sanitizeNameAttribute($name)
    {
        if (!empty($name)) {
            // Change spaces into hyphens
            $name = preg_replace('/\\s/', '-', $name);
                // Remove non-word characters
            $name = preg_replace('/[^a-zA-Z0-9_\\-]+/', '', $name);
        }
        return $name;
    }

    public function sanitizeIdAttribute($id)
    {
        if (!empty($id)) {
            // Change spaces into hyphens
            $attribute = preg_replace('/\\s/', '-', $id);
            // Change first non-letter to field-
            if (preg_match('/^([^a-zA-Z]{1})/', $attribute)) {
                $id = 'field-' . $attribute;
            }
            // Remove non-word characters
            $id = preg_replace('/([^a-zA-Z0-9_:\\-\\.]*)/', '', $id);
        }
        return $id;
    }

    public static function getObjectManager()
    {
        return GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class);
    }
}