9.5/_checkbox_element_8php_source.html

<?php

declare(strict_types = 1);

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\Backend\Form\NodeFactory;

use ‪TYPO3\CMS\Core\Imaging\Icon;

use ‪TYPO3\CMS\Core\Imaging\IconRegistry;

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

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


class ‪CheckboxElement extends ‪AbstractFormElement

{

    private ‪$iconRegistry;


    protected ‪$defaultFieldInformation = [

        'tcaDescription' => [

            'renderType' => 'tcaDescription',

        ],

    ];


    protected ‪$defaultFieldWizard = [

        'localizationStateSelector' => [

            'renderType' => 'localizationStateSelector',

        ],

        'otherLanguageContent' => [

            'renderType' => 'otherLanguageContent',

            'after' => [

                'localizationStateSelector'

            ],

        ],

        'defaultLanguageDifferences' => [

            'renderType' => 'defaultLanguageDifferences',

            'after' => [

                'otherLanguageContent',

            ],

        ],

    ];


    public function ‪__construct(‪NodeFactory ‪$nodeFactory, array ‪$data)

    {

        parent::__construct(‪$nodeFactory, ‪$data);

        $this->iconRegistry = GeneralUtility::makeInstance(IconRegistry::class);

    }


    public function ‪render(): array

    {

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


        $elementHtml = '';

        $disabled = false;

        if ($this->data['parameterArray']['fieldConf']['config']['readOnly']) {

            $disabled = true;

        }

        // Traversing the array of items

        $items = $this->data['parameterArray']['fieldConf']['config']['items'];


        $numberOfItems = \count($items);

        if ($numberOfItems === 0) {

            $items[] = ['', ''];

            $numberOfItems = 1;

        }

        $formElementValue = (int)$this->data['parameterArray']['itemFormElValue'];

        $cols = (int)$this->data['parameterArray']['fieldConf']['config']['cols'];

        if ($cols > 1) {

            [$colClass, $colClear] = $this->‪calculateColumnMarkup($cols);

            $elementHtml .= '<div class="checkbox-row row">';

            $counter = 0;

            // $itemKey is important here, because items could have been removed via TSConfig

            foreach ($items as $itemKey => $itemDefinition) {

                $label = $itemDefinition[0];

                $elementHtml .=

                    '<div class="checkbox-column ' . $colClass . '">'

                    . $this->‪renderSingleCheckboxElement($label, $itemKey, $formElementValue, $numberOfItems, $this->data['parameterArray'], $disabled) .

                    '</div>';

                ++$counter;

                if ($counter < $numberOfItems && !empty($colClear)) {

                    foreach ($colClear as $rowBreakAfter => $clearClass) {

                        if ($counter % $rowBreakAfter === 0) {

                            $elementHtml .= '<div class="clearfix ' . $clearClass . '"></div>';

                        }

                    }

                }

            }

            $elementHtml .= '</div>';

        } else {

            $counter = 0;

            foreach ($items as $itemKey => $itemDefinition) {

                $label = $itemDefinition[0];

                $elementHtml .= $this->‪renderSingleCheckboxElement($label, $counter, $formElementValue, $numberOfItems, $this->data['parameterArray'], $disabled);

                ++$counter;

            }

        }

        if (!$disabled) {

            $elementHtml .= '<input type="hidden" name="' . htmlspecialchars($this->data['parameterArray']['itemFormElName']) . '" value="' . htmlspecialchars((string)$formElementValue) . '" />';

        }


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

        $fieldInformationHtml = $fieldInformationResult['html'];

        $resultArray = $this->‪mergeChildReturnIntoExistingResult($resultArray, $fieldInformationResult, 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-wizards-wrap">';

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

        $html[] =           $elementHtml;

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

        if (!$disabled && !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 ‪renderSingleCheckboxElement($label, $itemCounter, $formElementValue, $numberOfItems, $additionalInformation, $disabled): string

    {

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

        $inline = !empty($config['cols']) && $config['cols'] === 'inline';

        $invert = isset($config['items'][$itemCounter]['invertStateDisplay']) && $config['items'][$itemCounter]['invertStateDisplay'] === true;

        $checkboxParameters = $this->‪checkBoxParams(

            $additionalInformation['itemFormElName'],

            $formElementValue,

            $itemCounter,

            $numberOfItems,

            implode('', $additionalInformation['fieldChangeFunc'])

        );

        $uniqueId = ‪StringUtility::getUniqueId('_');

        $checkboxId = $additionalInformation['itemFormElID'] . '_' . $itemCounter . $uniqueId;


        $iconIdentifierChecked = !empty($config['items'][$itemCounter]['iconIdentifierChecked']) ? $config['items'][$itemCounter]['iconIdentifierChecked'] : 'actions-check';

        if (!$this->iconRegistry->isRegistered($iconIdentifierChecked)) {

            $iconIdentifierChecked = 'actions-check';

        }

        $iconIdentifierUnchecked = !empty($config['items'][$itemCounter]['iconIdentifierUnchecked']) ? $config['items'][$itemCounter]['iconIdentifierUnchecked'] : 'empty-empty';

        if (!$this->iconRegistry->isRegistered($iconIdentifierUnchecked)) {

            $iconIdentifierUnchecked = 'empty-empty';

        }

        $iconChecked = $this->iconFactory->getIcon($iconIdentifierChecked, ‪Icon::SIZE_SMALL)->render('inline');

        $iconUnchecked = $this->iconFactory->getIcon($iconIdentifierUnchecked, ‪Icon::SIZE_SMALL)->render('inline');


        return '

            <div class="checkbox checkbox-type-icon-toggle' . ($invert ? ' checkbox-invert' : '') . ($inline ? ' checkbox-inline' : '') . (!$disabled ? '' : ' disabled') . '">

                <input type="checkbox"

                    class="checkbox-input"

                    value="1"

                    data-formengine-input-name="' . htmlspecialchars($additionalInformation['itemFormElName']) . '"

                    ' . $checkboxParameters . '

                    ' . ($disabled ? ' disabled="disabled"' : '') . '

                    id="' . $checkboxId . '" />

                <label class="checkbox-label" for="' . $checkboxId . '">

                    <span class="checkbox-label-icon">

                        <span class="checkbox-label-icon-checked">' . ($invert ? $iconUnchecked : $iconChecked) . '</span>

                        <span class="checkbox-label-icon-unchecked">' . ($invert ? $iconChecked : $iconUnchecked) . '</span>

                    </span>

                    <span class="checkbox-label-text">' . $this->‪appendValueToLabelInDebugMode(($label ? htmlspecialchars($label) : '&nbsp;'), $formElementValue) . '</span>

                </label>

            </div>';

    }

}