class ChoiceQuestion in Zircon Profile 8

Represents a choice question.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\Console\Question\Question
  • class \Symfony\Component\Console\Question\ChoiceQuestion

4 files declare their use of ChoiceQuestion

QuestionHelper.php in vendor/symfony/console/Helper/QuestionHelper.php

QuestionHelperTest.php in vendor/symfony/console/Tests/Helper/QuestionHelperTest.php

SymfonyQuestionHelper.php in vendor/symfony/console/Helper/SymfonyQuestionHelper.php

SymfonyStyle.php in vendor/symfony/console/Style/SymfonyStyle.php

File

vendor/symfony/console/Question/ChoiceQuestion.php, line 19

Namespace

Symfony\Component\Console\Question

class ChoiceQuestion extends Question {
  private $choices;
  private $multiselect = false;
  private $prompt = ' > ';
  private $errorMessage = 'Value "%s" is invalid';

  /**
   * Constructor.
   *
   * @param string $question The question to ask to the user
   * @param array  $choices  The list of available choices
   * @param mixed  $default  The default answer to return
   */
  public function __construct($question, array $choices, $default = null) {
    parent::__construct($question, $default);
    $this->choices = $choices;
    $this
      ->setValidator($this
      ->getDefaultValidator());
    $this
      ->setAutocompleterValues($choices);
  }

  /**
   * Returns available choices.
   *
   * @return array
   */
  public function getChoices() {
    return $this->choices;
  }

  /**
   * Sets multiselect option.
   *
   * When multiselect is set to true, multiple choices can be answered.
   *
   * @param bool $multiselect
   *
   * @return ChoiceQuestion The current instance
   */
  public function setMultiselect($multiselect) {
    $this->multiselect = $multiselect;
    $this
      ->setValidator($this
      ->getDefaultValidator());
    return $this;
  }

  /**
   * Gets the prompt for choices.
   *
   * @return string
   */
  public function getPrompt() {
    return $this->prompt;
  }

  /**
   * Sets the prompt for choices.
   *
   * @param string $prompt
   *
   * @return ChoiceQuestion The current instance
   */
  public function setPrompt($prompt) {
    $this->prompt = $prompt;
    return $this;
  }

  /**
   * Sets the error message for invalid values.
   *
   * The error message has a string placeholder (%s) for the invalid value.
   *
   * @param string $errorMessage
   *
   * @return ChoiceQuestion The current instance
   */
  public function setErrorMessage($errorMessage) {
    $this->errorMessage = $errorMessage;
    $this
      ->setValidator($this
      ->getDefaultValidator());
    return $this;
  }

  /**
   * Returns the default answer validator.
   *
   * @return callable
   */
  private function getDefaultValidator() {
    $choices = $this->choices;
    $errorMessage = $this->errorMessage;
    $multiselect = $this->multiselect;
    $isAssoc = $this
      ->isAssoc($choices);
    return function ($selected) use ($choices, $errorMessage, $multiselect, $isAssoc) {

      // Collapse all spaces.
      $selectedChoices = str_replace(' ', '', $selected);
      if ($multiselect) {

        // Check for a separated comma values
        if (!preg_match('/^[a-zA-Z0-9_-]+(?:,[a-zA-Z0-9_-]+)*$/', $selectedChoices, $matches)) {
          throw new \InvalidArgumentException(sprintf($errorMessage, $selected));
        }
        $selectedChoices = explode(',', $selectedChoices);
      }
      else {
        $selectedChoices = array(
          $selected,
        );
      }
      $multiselectChoices = array();
      foreach ($selectedChoices as $value) {
        $results = array();
        foreach ($choices as $key => $choice) {
          if ($choice === $value) {
            $results[] = $key;
          }
        }
        if (count($results) > 1) {
          throw new \InvalidArgumentException(sprintf('The provided answer is ambiguous. Value should be one of %s.', implode(' or ', $results)));
        }
        $result = array_search($value, $choices);
        if (!$isAssoc) {
          if (false !== $result) {
            $result = $choices[$result];
          }
          elseif (isset($choices[$value])) {
            $result = $choices[$value];
          }
        }
        elseif (false === $result && isset($choices[$value])) {
          $result = $value;
        }
        if (false === $result) {
          throw new \InvalidArgumentException(sprintf($errorMessage, $value));
        }
        $multiselectChoices[] = (string) $result;
      }
      if ($multiselect) {
        return $multiselectChoices;
      }
      return current($multiselectChoices);
    };
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ChoiceQuestion::$choices	private	property
ChoiceQuestion::$errorMessage	private	property
ChoiceQuestion::$multiselect	private	property
ChoiceQuestion::$prompt	private	property
ChoiceQuestion::getChoices	public	function	Returns available choices.
ChoiceQuestion::getDefaultValidator	private	function	Returns the default answer validator.
ChoiceQuestion::getPrompt	public	function	Gets the prompt for choices.
ChoiceQuestion::setErrorMessage	public	function	Sets the error message for invalid values.
ChoiceQuestion::setMultiselect	public	function	Sets multiselect option.
ChoiceQuestion::setPrompt	public	function	Sets the prompt for choices.
ChoiceQuestion::__construct	public	function	Constructor. Overrides Question::__construct
Question::$attempts	private	property
Question::$autocompleterValues	private	property
Question::$default	private	property
Question::$hidden	private	property
Question::$hiddenFallback	private	property
Question::$normalizer	private	property
Question::$question	private	property
Question::$validator	private	property
Question::getAutocompleterValues	public	function	Gets values for the autocompleter.
Question::getDefault	public	function	Returns the default answer.
Question::getMaxAttempts	public	function	Gets the maximum number of attempts.
Question::getNormalizer	public	function	Gets the normalizer for the response.
Question::getQuestion	public	function	Returns the question.
Question::getValidator	public	function	Gets the validator for the question.
Question::isAssoc	protected	function
Question::isHidden	public	function	Returns whether the user response must be hidden.
Question::isHiddenFallback	public	function	In case the response can not be hidden, whether to fallback on non-hidden question or not.
Question::setAutocompleterValues	public	function	Sets values for the autocompleter.
Question::setHidden	public	function	Sets whether the user response must be hidden or not.
Question::setHiddenFallback	public	function	Sets whether to fallback on non-hidden question if the response can not be hidden.
Question::setMaxAttempts	public	function	Sets the maximum number of attempts.
Question::setNormalizer	public	function	Sets a normalizer for the response.
Question::setValidator	public	function	Sets a validator for the question.