TypoScriptConstantsViewHelper.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extensionmanager\ViewHelpers\Form;

/*
 * 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\Extensionmanager\Domain\Model\ConfigurationItem;
use TYPO3\CMS\Fluid\ViewHelpers\FormViewHelper;

class TypoScriptConstantsViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper
{
    public $viewHelperMapping = [
        'int' => 'renderIntegerField',
        'int+' => 'renderPositiveIntegerField',
        'integer' => 'renderIntegerField',
        'color' => 'renderColorPicker',
        'wrap' => 'renderWrapField',
        'offset' => 'renderOffsetField',
        'options' => 'renderOptionSelect',
        'boolean' => 'renderCheckbox',
        'user' => 'renderUserFunction',
        'small' => 'renderSmallTextField',
        'string' => 'renderTextField',
        'input' => 'renderTextField',  // only for backwards compatibility, many extensions depend on that
        'default' => 'renderTextField' // only for backwards compatibility, many extensions depend on that
    ];

    public $tagName = 'input';

    public function initializeArguments()
    {
        parent::initializeArguments();
        $this->registerArgument('name', 'string', 'Name of input tag');
        $this->registerArgument('value', 'mixed', 'Value of input tag');
        $this->registerArgument('configuration', ConfigurationItem::class, '', true);
        $this->registerUniversalTagAttributes();
    }

    public function render()
    {
        $configuration = $this->arguments['configuration'];
        if (isset($this->viewHelperMapping[$configuration->getType()]) && method_exists($this, $this->viewHelperMapping[$configuration->getType()])) {
            $input = $this->{$this->viewHelperMapping[$configuration->getType()]}($configuration);
        } else {
            $input = $this->{$this->viewHelperMapping['default']}($configuration);
        }

        return $input;
    }

    protected function renderColorPicker(ConfigurationItem $configuration)
    {
        $elementId = 'em-' . $configuration->getName();
        $elementName = $this->getName($configuration);

        // configure the field
        $this->tag->setTagName('input');
        $this->tag->addAttribute('type', 'text');
        $this->tag->addAttribute('id', $elementId);
        $this->tag->addAttribute('name', $elementName);
        $this->tag->addAttribute('data-formengine-input-name', $elementName);
        $this->tag->addAttribute('class', 'form-control');
        if ($configuration->getValue() !== null) {
            $this->tag->addAttribute('value', $configuration->getValue());
        }

        $output = '
            <div class="form-wizards-element">
                <input class="form-control t3js-color-input formengine-colorpickerelement t3js-color-picker" type="text"
                  name="' . htmlspecialchars($elementName) . '" value="' . $this->tag->getAttribute('value') . '"/>
                <script type="text/javascript">
                    require([\'TYPO3/CMS/Backend/ColorPicker\'], function(ColorPicker){ColorPicker.initialize()});
                </script>
            </div>';

        return $output;
    }

    protected function renderOffsetField(ConfigurationItem $configuration)
    {
        $this->tag->setTagName('input');
        $this->tag->addAttribute('type', 'text');
        $this->tag->addAttribute('id', 'em-' . $configuration->getName());
        $this->tag->addAttribute('name', $this->getName($configuration));
        $this->tag->addAttribute('class', 'form-control t3js-emconf-offset');
        if ($configuration->getValue() !== null) {
            $this->tag->addAttribute('value', $configuration->getValue());
        }
        return $this->tag->render();
    }

    protected function renderWrapField(ConfigurationItem $configuration)
    {
        $this->tag->setTagName('input');
        $this->tag->addAttribute('type', 'text');
        $this->tag->addAttribute('id', 'em-' . $configuration->getName());
        $this->tag->addAttribute('name', $this->getName($configuration));
        $this->tag->addAttribute('class', 'form-control t3js-emconf-wrap');
        if ($configuration->getValue() !== null) {
            $this->tag->addAttribute('value', $configuration->getValue());
        }
        return $this->tag->render();
    }

    protected function renderOptionSelect(ConfigurationItem $configuration)
    {
        $this->tag->setTagName('select');
        $this->tag->addAttribute('id', 'em-' . $configuration->getName());
        $this->tag->addAttribute('name', $this->getName($configuration));
        $this->tag->addAttribute('class', 'form-control');
        $optionValueArray = $configuration->getGeneric();
        $output = '';
        foreach ($optionValueArray as $label => $value) {
            $output .= '<option value="' . htmlspecialchars($value) . '"';
            if ($configuration->getValue() == $value) {
                $output .= ' selected="selected"';
            }
            $output .= '>' . htmlspecialchars($GLOBALS['LANG']->sL($label)) . '</option>';
        }
        $this->tag->setContent($output);
        return $this->tag->render();
    }

    protected function renderPositiveIntegerField(ConfigurationItem $configuration)
    {
        $this->tag->setTagName('input');
        $this->tag->addAttribute('type', 'number');
        $this->tag->addAttribute('id', 'em-' . $configuration->getName());
        $this->tag->addAttribute('name', $this->getName($configuration));
        $this->tag->addAttribute('class', 'form-control');
        $this->tag->addAttribute('min', '0');
        if ($configuration->getValue() !== null) {
            $this->tag->addAttribute('value', $configuration->getValue());
        }
        return $this->tag->render();
    }

    protected function renderIntegerField(ConfigurationItem $configuration)
    {
        $this->tag->setTagName('input');
        $this->tag->addAttribute('type', 'number');
        $this->tag->addAttribute('id', 'em-' . $configuration->getName());
        $this->tag->addAttribute('name', $this->getName($configuration));
        $this->tag->addAttribute('class', 'form-control');
        if ($configuration->getValue() !== null) {
            $this->tag->addAttribute('value', $configuration->getValue());
        }
        return $this->tag->render();
    }

    protected function renderTextField(ConfigurationItem $configuration)
    {
        $this->tag->setTagName('input');
        $this->tag->addAttribute('type', 'text');
        $this->tag->addAttribute('id', 'em-' . $configuration->getName());
        $this->tag->addAttribute('name', $this->getName($configuration));
        $this->tag->addAttribute('class', 'form-control');
        if ($configuration->getValue() !== null) {
            $this->tag->addAttribute('value', $configuration->getValue());
        }
        return $this->tag->render();
    }

    protected function renderSmallTextField(ConfigurationItem $configuration)
    {
        return $this->renderTextField($configuration);
    }

    public function renderCheckbox(ConfigurationItem $configuration)
    {
        $this->tag->addAttribute('type', 'checkbox');
        $this->tag->addAttribute('name', $this->getName($configuration));
        $this->tag->addAttribute('value', 1);
        $this->tag->addAttribute('id', 'em-' . $configuration->getName());
        if ($configuration->getValue() == 1) {
            $this->tag->addAttribute('checked', 'checked');
        }
        $hiddenField = $this->renderHiddenFieldForEmptyValue($configuration);
        return '<div class="checkbox">' . $hiddenField . '<label>' . $this->tag->render() . '</label></div>';
    }

    protected function renderUserFunction(ConfigurationItem $configuration)
    {
        $userFunction = $configuration->getGeneric();
        $userFunctionParams = [
            'fieldName' => $this->getName($configuration),
            'fieldValue' => $configuration->getValue(),
            'propertyName' => $configuration->getName()
        ];
        return \TYPO3\CMS\Core\Utility\GeneralUtility::callUserFunction($userFunction, $userFunctionParams, $this);
    }

    protected function getName(ConfigurationItem $configuration)
    {
        return 'tx_extensionmanager_tools_extensionmanagerextensionmanager[config][' . $configuration->getName() . '][value]';
    }

    protected function renderHiddenFieldForEmptyValue($configuration)
    {
        $hiddenFieldNames = [];
        if ($this->viewHelperVariableContainer->exists(FormViewHelper::class, 'renderedHiddenFields')) {
            $hiddenFieldNames = $this->viewHelperVariableContainer->get(FormViewHelper::class, 'renderedHiddenFields');
        }
        $fieldName = $this->getName($configuration);
        if (substr($fieldName, -2) === '[]') {
            $fieldName = substr($fieldName, 0, -2);
        }
        if (!in_array($fieldName, $hiddenFieldNames)) {
            $hiddenFieldNames[] = $fieldName;
            $this->viewHelperVariableContainer->addOrUpdate(FormViewHelper::class, 'renderedHiddenFields', $hiddenFieldNames);
            return '<input type="hidden" name="' . htmlspecialchars($fieldName) . '" value="0" />';
        }
        return '';
    }
}