<?php
declare(strict_types=1);
namespace FluidTYPO3\Flux\ViewHelpers\Field;

/*
 * This file is part of the FluidTYPO3/Flux project under GPLv2 or later.
 *
 * For the full copyright and license information, please read the
 * LICENSE.md file that was distributed with this source code.
 */

use FluidTYPO3\Flux\Form\Field\Select;
use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;

/**
 * Select-type FlexForm field ViewHelper
 *
 * ### Choosing one of two items
 *
 * Items are given in CSV mode:
 *
 *     <flux:field.select name="settings.position" items="left,right" default="left"/>
 *
 * ### Items with labels
 *
 * If you want to display labels that are different than the values itself,
 * use an object in `items`:
 *
 *      <flux:field.select name="settings.position"
 *                         items="{
 *                                0:{0:'On the left side',1:'left'},
 *                                1:{0:'On the right side',1:'right'}
 *                                }"
 *                        />
 *
 * You can translate those labels by putting a LLL reference in the first property:
 *
 *     LLL:EXT:extname/Resources/Private/Language/locallang.xlf:flux.example.fields.items.foo'
 *
 * ### Links
 *
 * * [TCA Reference: type "select"](https://docs.typo3.org/typo3cms/TCAReference/stable/Reference/Columns/Select/)
 */
class SelectViewHelper extends AbstractMultiValueFieldViewHelper
{
    public function initializeArguments(): void
    {
        parent::initializeArguments();
        $this->overrideArgument(
            'items',
            'mixed',
            'Items for the selector; array / CSV / Traversable / Query supported',
            true
        );
        $this->registerArgument(
            'renderType',
            'string',
            'Rendering type as applies in FormEngine/TCA',
            false,
            'selectSingle'
        );
        $this->registerArgument(
            'showIconTable',
            'boolean',
            'If TRUE shows the option icons as table beneath the select',
            false,
            false
        );
    }

    public static function getComponent(RenderingContextInterface $renderingContext, iterable $arguments): Select
    {
        /** @var array $arguments */
        /** @var Select $component */
        $component = static::getPreparedComponent(Select::class, $renderingContext, $arguments);
        $component->setRenderType($arguments['renderType']);
        $component->setShowIconTable($arguments['showIconTable']);
        return $component;
    }
}