9.5/_select_view_helper_8php_source.html

<?php

namespace ‪TYPO3\CMS\Fluid\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!

 */


class ‪SelectViewHelper extends ‪\TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper

{

    protected ‪$tagName = 'select';


    protected ‪$selectedValue;


    public function ‪initializeArguments()

    {

        parent::initializeArguments();

        $this->registerUniversalTagAttributes();

        $this->registerTagAttribute('size', 'string', 'Size of input field');

        $this->registerTagAttribute('disabled', 'string', 'Specifies that the input element should be disabled when the page loads');

        $this->registerArgument('options', 'array', 'Associative array with internal IDs as key, and the values are displayed in the select box. Can be combined with or replaced by child f:form.select.* nodes.');

        $this->registerArgument('optionsAfterContent', 'boolean', 'If true, places auto-generated option tags after those rendered in the tag content. If false, automatic options come first.', false, false);

        $this->registerArgument('optionValueField', 'string', 'If specified, will call the appropriate getter on each object to determine the value.');

        $this->registerArgument('optionLabelField', 'string', 'If specified, will call the appropriate getter on each object to determine the label.');

        $this->registerArgument('sortByOptionLabel', 'boolean', 'If true, List will be sorted by label.', false, false);

        $this->registerArgument('selectAllByDefault', 'boolean', 'If specified options are selected if none was set before.', false, false);

        $this->registerArgument('errorClass', 'string', 'CSS class to set if there are errors for this ViewHelper', false, 'f3-form-error');

        $this->registerArgument('prependOptionLabel', 'string', 'If specified, will provide an option at first position with the specified label.');

        $this->registerArgument('prependOptionValue', 'string', 'If specified, will provide an option at first position with the specified value.');

        $this->registerArgument('multiple', 'boolean', 'If set multiple options may be selected.', false, false);

        $this->registerArgument('required', 'boolean', 'If set no empty value is allowed.', false, false);

    }


    public function ‪render()

    {

        if (isset($this->arguments['required']) && $this->arguments['required']) {

            $this->tag->addAttribute('required', 'required');

        }

        $name = $this->‪getName();

        if (isset($this->arguments['multiple']) && $this->arguments['multiple']) {

            $this->tag->addAttribute('multiple', 'multiple');

            $name .= '[]';

        }

        $this->tag->addAttribute('name', $name);

        $options = $this->‪getOptions();


        $viewHelperVariableContainer = $this->renderingContext->getViewHelperVariableContainer();


        $this->‪addAdditionalIdentityPropertiesIfNeeded();

        $this->‪setErrorClassAttribute();

        $content = '';


        // register field name for token generation.

        $this->‪registerFieldNameForFormTokenGeneration($name);

        // in case it is a multi-select, we need to register the field name

        // as often as there are elements in the box

        if (isset($this->arguments['multiple']) && $this->arguments['multiple']) {

            $content .= $this->‪renderHiddenFieldForEmptyValue();

            // Register the field name additional times as required by the total number of

            // options. Since we already registered it once above, we start the counter at 1

            // instead of 0.

            $optionsCount = count($options);

            for ($i = 1; $i < $optionsCount; $i++) {

                $this->‪registerFieldNameForFormTokenGeneration($name);

            }

            // save the parent field name so that any child f:form.select.option

            // tag will know to call registerFieldNameForFormTokenGeneration

            // this is the reason why "self::class" is used instead of static::class (no LSB)

            $viewHelperVariableContainer->addOrUpdate(

                self::class,

                'registerFieldNameForFormTokenGeneration',

                $name

            );

        }


        $viewHelperVariableContainer->addOrUpdate(self::class, 'selectedValue', $this->‪getSelectedValue());

        $prependContent = $this->‪renderPrependOptionTag();

        $tagContent = $this->‪renderOptionTags($options);

        $childContent = $this->renderChildren();

        $viewHelperVariableContainer->remove(self::class, 'selectedValue');

        $viewHelperVariableContainer->remove(self::class, 'registerFieldNameForFormTokenGeneration');

        if (isset($this->arguments['optionsAfterContent']) && $this->arguments['optionsAfterContent']) {

            $tagContent = $childContent . $tagContent;

        } else {

            $tagContent .= $childContent;

        }

        $tagContent = $prependContent . $tagContent;


        $this->tag->forceClosingTag(true);

        $this->tag->setContent($tagContent);

        $content .= $this->tag->render();

        return $content;

    }


    protected function ‪renderPrependOptionTag()

    {

        ‪$output = '';

        if ($this->hasArgument('prependOptionLabel')) {

            $value = $this->hasArgument('prependOptionValue') ? $this->arguments['prependOptionValue'] : '';

            $label = $this->arguments['prependOptionLabel'];

            ‪$output .= $this->‪renderOptionTag($value, $label, false) . LF;

        }

        return ‪$output;

    }


    protected function ‪renderOptionTags($options)

    {

        ‪$output = '';

        foreach ($options as $value => $label) {

            $isSelected = $this->‪isSelected($value);

            ‪$output .= $this->‪renderOptionTag($value, $label, $isSelected) . LF;

        }

        return ‪$output;

    }


    protected function ‪getOptions()

    {

        if (!is_array($this->arguments['options']) && !$this->arguments['options'] instanceof \Traversable) {

            return [];

        }

        $options = [];

        $optionsArgument = $this->arguments['options'];

        foreach ($optionsArgument as $key => $value) {

            if (is_object($value) || is_array($value)) {

                if ($this->hasArgument('optionValueField')) {

                    $key = ‪\TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($value, $this->arguments['optionValueField']);

                    if (is_object($key)) {

                        if (method_exists($key, '__toString')) {

                            $key = (string)$key;

                        } else {

                            throw new \TYPO3Fluid\Fluid\Core\ViewHelper\Exception('Identifying value for object of class "' . get_class($value) . '" was an object.', 1247827428);

                        }

                    }

                } elseif ($this->persistenceManager->getIdentifierByObject($value) !== null) {

                    // @todo use $this->persistenceManager->isNewObject() once it is implemented

                    $key = $this->persistenceManager->getIdentifierByObject($value);

                } elseif (method_exists($value, '__toString')) {

                    $key = (string)$value;

                } else {

                    throw new \TYPO3Fluid\Fluid\Core\ViewHelper\Exception('No identifying value for object of class "' . get_class($value) . '" found.', 1247826696);

                }

                if ($this->hasArgument('optionLabelField')) {

                    $value = ‪\TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($value, $this->arguments['optionLabelField']);

                    if (is_object($value)) {

                        if (method_exists($value, '__toString')) {

                            $value = (string)$value;

                        } else {

                            throw new \TYPO3Fluid\Fluid\Core\ViewHelper\Exception('Label value for object of class "' . get_class($value) . '" was an object without a __toString() method.', 1247827553);

                        }

                    }

                } elseif (method_exists($value, '__toString')) {

                    $value = (string)$value;

                } elseif ($this->persistenceManager->getIdentifierByObject($value) !== null) {

                    // @todo use $this->persistenceManager->isNewObject() once it is implemented

                    $value = $this->persistenceManager->getIdentifierByObject($value);

                }

            }

            $options[$key] = $value;

        }

        if ($this->arguments['sortByOptionLabel']) {

            asort($options, SORT_LOCALE_STRING);

        }

        return $options;

    }


    protected function ‪isSelected($value)

    {

        ‪$selectedValue = $this->‪getSelectedValue();

        if ($value === ‪$selectedValue || (string)$value === ‪$selectedValue) {

            return true;

        }

        if ($this->hasArgument('multiple')) {

            if (‪$selectedValue === null && $this->arguments['selectAllByDefault'] === true) {

                return true;

            }

            if (is_array(‪$selectedValue) && in_array($value, ‪$selectedValue)) {

                return true;

            }

        }

        return false;

    }


    protected function ‪getSelectedValue()

    {

        $this->‪setRespectSubmittedDataValue(true);

        $value = $this->‪getValueAttribute();

        if (!is_array($value) && !$value instanceof \Traversable) {

            return $this->‪getOptionValueScalar($value);

        }

        $selectedValues = [];

        foreach ($value as $selectedValueElement) {

            $selectedValues[] = $this->‪getOptionValueScalar($selectedValueElement);

        }

        return $selectedValues;

    }


    protected function ‪getOptionValueScalar($valueElement)

    {

        if (is_object($valueElement)) {

            if ($this->hasArgument('optionValueField')) {

                return \TYPO3\CMS\Extbase\Reflection\ObjectAccess::getPropertyPath($valueElement, $this->arguments['optionValueField']);

            }

            // @todo use $this->persistenceManager->isNewObject() once it is implemented

            if ($this->persistenceManager->getIdentifierByObject($valueElement) !== null) {

                return $this->persistenceManager->getIdentifierByObject($valueElement);

            }

            return (string)$valueElement;

        }

        return $valueElement;

    }


    protected function ‪renderOptionTag($value, $label, $isSelected)

    {

        ‪$output = '<option value="' . htmlspecialchars($value) . '"';

        if ($isSelected) {

            ‪$output .= ' selected="selected"';

        }

        ‪$output .= '>' . htmlspecialchars($label) . '</option>';

        return ‪$output;

    }

}