9.5/_select_single_box_element_8php_source.html

<?php

namespace ‪TYPO3\CMS\Backend\Form\Element;


/*

 * 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\Core\Utility\MathUtility;

use ‪TYPO3\CMS\Core\Utility\StringUtility;


class ‪SelectSingleBoxElement extends ‪AbstractFormElement

{

    protected ‪$defaultFieldInformation = [

        'tcaDescription' => [

            'renderType' => 'tcaDescription',

        ],

    ];


    protected ‪$defaultFieldControl = [

        'resetSelection' => [

            'renderType' => 'resetSelection',

        ],

    ];


    protected ‪$defaultFieldWizard = [

        'localizationStateSelector' => [

            'renderType' => 'localizationStateSelector',

        ],

        'otherLanguageContent' => [

            'renderType' => 'otherLanguageContent',

            'after' => [

                'localizationStateSelector'

            ],

        ],

        'defaultLanguageDifferences' => [

            'renderType' => 'defaultLanguageDifferences',

            'after' => [

                'otherLanguageContent',

            ],

        ],

    ];


    public function ‪render()

    {

        $languageService = $this->‪getLanguageService();

        $resultArray = $this->‪initializeResultArray();


        $parameterArray = $this->data['parameterArray'];

        // Field configuration from TCA:

        $config = $parameterArray['fieldConf']['config'];

        $selectItems = $parameterArray['fieldConf']['config']['items'];

        $disabled = !empty($config['readOnly']);


        // Get values in an array (and make unique, which is fine because there can be no duplicates anyway):

        $itemArray = array_flip($parameterArray['itemFormElValue']);

        $width = $this->‪formMaxWidth($this->defaultInputWidth);


        $optionElements = [];

        foreach ($selectItems as $i => $item) {

            $value = $item[1];

            $attributes = [];

            // Selected or not by default

            if (isset($itemArray[$value])) {

                $attributes['selected'] = 'selected';

                unset($itemArray[$value]);

            }

            // Non-selectable element

            if ((string)$value === '--div--') {

                $attributes['disabled'] = 'disabled';

                $attributes['class'] = 'formcontrol-select-divider';

            }

            $optionElements[] = $this->‪renderOptionElement($value, $item[0], $attributes);

        }


        $selectElement = $this->‪renderSelectElement($optionElements, $parameterArray, $config);


        $fieldInformationResult = $this->‪renderFieldInformation();

        $fieldInformationHtml = $fieldInformationResult['html'];

        $resultArray = $this->‪mergeChildReturnIntoExistingResult($resultArray, $fieldInformationResult, false);


        $fieldControlResult = $this->‪renderFieldControl();

        $fieldControlHtml = $fieldControlResult['html'];

        $resultArray = $this->‪mergeChildReturnIntoExistingResult($resultArray, $fieldControlResult, false);


        $fieldWizardResult = $this->‪renderFieldWizard();

        $fieldWizardHtml = $fieldWizardResult['html'];

        $resultArray = $this->‪mergeChildReturnIntoExistingResult($resultArray, $fieldWizardResult, false);


        $html = [];

        $html[] = '<div class="formengine-field-item t3js-formengine-field-item">';

        $html[] = $fieldInformationHtml;

        $html[] =   '<div class="form-control-wrap" style="max-width: ' . $width . 'px">';

        $html[] =       '<div class="form-wizards-wrap form-wizards-aside">';

        $html[] =           '<div class="form-wizards-element">';

        if (!$disabled) {

            // Add an empty hidden field which will send a blank value if all items are unselected.

            $html[] =           '<input type="hidden" name="' . htmlspecialchars($parameterArray['itemFormElName']) . '" value="">';

        }

        $html[] =               $selectElement;

        $html[] =           '</div>';

        if (!$disabled) {

            if (!empty($fieldControlHtml)) {

                $html[] =       '<div class="form-wizards-items-aside">';

                $html[] =           $fieldControlHtml;

                $html[] =       '</div>';

                $html[] =   '</div>';

            }

            $html[] =   '<p>';

            $html[] =       '<em>' . htmlspecialchars($languageService->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.holdDownCTRL')) . '</em>';

            $html[] =   '</p>';

            if (!empty($fieldWizardHtml)) {

                $html[] = '<div class="form-wizards-items-bottom">';

                $html[] = $fieldWizardHtml;

                $html[] = '</div>';

            }

        }

        $html[] =   '</div>';

        $html[] = '</div>';


        $resultArray['html'] = implode(LF, $html);

        return $resultArray;

    }


    protected function ‪renderSelectElement(array $optionElements, array $parameterArray, array $config)

    {

        $selectItems = $parameterArray['fieldConf']['config']['items'];

        $size = (int)$config['size'];

        $cssPrefix = $size === 1 ? 'tceforms-select' : 'tceforms-multiselect';


        if ($config['autoSizeMax']) {

            $size = ‪MathUtility::forceIntegerInRange(

                count($selectItems) + 1,

                ‪MathUtility::forceIntegerInRange($size, 1),

                $config['autoSizeMax']

            );

        }


        $attributes = [

            'name' => $parameterArray['itemFormElName'] . '[]',

            'multiple' => 'multiple',

            'onchange' => implode('', $parameterArray['fieldChangeFunc']),

            'id' => ‪StringUtility::getUniqueId($cssPrefix),

            'class' => 'form-control ' . $cssPrefix,

            'data-formengine-validation-rules' => $this->‪getValidationDataAsJsonString($config),

        ];

        if ($size) {

            $attributes['size'] = $size;

        }

        if ($config['readOnly']) {

            $attributes['disabled'] = 'disabled';

        }


        $html = [];

        $html[] = '<select ' . GeneralUtility::implodeAttributes($attributes, true) . '>';

        $html[] =   implode(LF, $optionElements);

        $html[] = '</select>';


        return implode(LF, $html);

    }


    protected function ‪renderOptionElement($value, $label, array $attributes = [])

    {

        $attributes['value'] = $value;

        $html = [

            '<option ' . GeneralUtility::implodeAttributes($attributes, true) . '>',

                htmlspecialchars($this->‪appendValueToLabelInDebugMode($label, $value), ENT_COMPAT, 'UTF-8', false),

            '</option>'


        ];


        return implode('', $html);

    }

}