AlwaysReturnKeyOfChoiceQuestion.php

<?php

namespace Matthias\SymfonyConsoleForm\Console\Helper\Question;

use InvalidArgumentException;
use Symfony\Component\Console\Question\ChoiceQuestion;
use Symfony\Component\Form\ChoiceList\View\ChoiceView;

final class AlwaysReturnKeyOfChoiceQuestion extends ChoiceQuestion
{
    /**
     * @var ChoiceView[]
     */
    private $choiceViews;

    /**
     * @var bool
     */
    private $_multiselect = false;

    /**
     * @var string
     */
    private $_errorMessage = 'Value "%s" is invalid';

    /**
     * @param string $question    The question to ask to the user
     * @param array  $choiceViews The list of available choices
     * @param mixed  $default     The default answer to return
     */
    public function __construct($question, array $choiceViews, $default = null)
    {
        $this->assertFlatChoiceViewsArray($choiceViews);

        $this->choiceViews = $choiceViews;

        parent::__construct($question, $this->prepareChoices(), $default);

        $this->setAutocompleterValues($this->prepareAutocompleteValues());
    }

    /**
     * @param bool $multiselect
     */
    public function setMultiselect(bool $multiselect): static
    {
        $this->_multiselect = $multiselect;

        return parent::setMultiselect($multiselect);
    }

    /**
     * @param string $errorMessage
     */
    public function setErrorMessage(string $errorMessage): static
    {
        $this->_errorMessage = $errorMessage;

        return parent::setErrorMessage($errorMessage);
    }

    /**
     * @return callable|null
     */
    public function getValidator(): ?callable
    {
        return function ($selected) {
            // Collapse all spaces.
            $selectedChoices = str_replace(' ', '', $selected);

            if ($this->_multiselect) {
                // Check for a separated comma values
                if (!preg_match('/^[a-zA-Z0-9_-]+(?:,[a-zA-Z0-9_-]+)*$/', $selectedChoices)) {
                    throw new InvalidArgumentException(sprintf($this->_errorMessage, $selected));
                }
                $selectedChoices = explode(',', $selectedChoices);
            } else {
                $selectedChoices = [$selected];
            }

            $selectedKeys = [];

            foreach ($selectedChoices as $selectedValue) {
                $selectedKeys[] = $this->resolveChoiceViewValue($selectedValue);
            }

            if ($this->_multiselect) {
                return $selectedKeys;
            }

            return current($selectedKeys);
        };
    }

    /**
     * @param string $selectedValue The selected value
     *
     * @throws InvalidArgumentException
     *
     * @return string The corresponding value of the ChoiceView
     */
    private function resolveChoiceViewValue($selectedValue)
    {
        foreach ($this->choiceViews as $choiceView) {
            if (in_array($selectedValue, [$choiceView->data, $choiceView->value, $choiceView->label])) {
                return $choiceView->value;
            }
        }

        throw new InvalidArgumentException(sprintf($this->_errorMessage, $selectedValue));
    }

    /**
     * @return array
     */
    private function prepareChoices()
    {
        $choices = [];
        foreach ($this->choiceViews as $choiceView) {
            $label = $choiceView->label;
            $data = $choiceView->data;
            if ($data != $choiceView->value && $this->canBeConvertedToString($data)) {
                $label .= ' (<comment>' . $data . '</comment>)';
            }

            $choices[$choiceView->value] = $label;
        }

        return $choices;
    }

    /**
     * @return array
     */
    private function prepareAutocompleteValues()
    {
        $autocompleteValues = [];

        foreach ($this->choiceViews as $choiceView) {
            $autocompleteValues[] = $choiceView->value;

            $data = $choiceView->data;
            if ($this->canBeConvertedToString($data)) {
                $autocompleteValues[] = (string)$data;
            }

            $autocompleteValues[] = $choiceView->label;
        }

        return $autocompleteValues;
    }

    /**
     * @param array $choiceViews
     *
     * @throws InvalidArgumentException
     */
    private function assertFlatChoiceViewsArray(array $choiceViews)
    {
        foreach ($choiceViews as $choiceView) {
            if (!$choiceView instanceof ChoiceView) {
                throw new InvalidArgumentException('Only a flat choice hierarchy is supported');
            }
        }
    }

    /**
     * @param mixed $value
     * @return bool
     */
    private function canBeConvertedToString($value)
    {
        return $value === null || is_scalar($value) || (\is_object($value) && method_exists($value, '__toString'));
    }
}