interface/modules/zend_modules/library/Zend/Console/Prompt/Select.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Console\Prompt;
  11
  12 use Zend\Console\Exception;
  13
  14 class Select extends Char
  15 {
  16     /**
  17      * @var string
  18      */
  19     protected $promptText = 'Please select an option';
  20
  21     /**
  22      * @var bool
  23      */
  24     protected $ignoreCase = true;
  25
  26     /**
  27      * @var array
  28      */
  29     protected $options = array();
  30
  31     /**
  32      * Ask the user to select one of pre-defined options
  33      *
  34      * @param string    $promptText     The prompt text to display in console
  35      * @param array     $options        Allowed options
  36      * @param bool      $allowEmpty     Allow empty (no) selection?
  37      * @param bool      $echo           True to display selected option?
  38      * @throws Exception\BadMethodCallException if no options available
  39      */
  40     public function __construct(
  41         $promptText = 'Please select one option',
  42         $options = array(),
  43         $allowEmpty = false,
  44         $echo = false
  45     ) {
  46         if ($promptText !== null) {
  47             $this->setPromptText($promptText);
  48         }
  49
  50         if (!count($options)) {
  51             throw new Exception\BadMethodCallException(
  52                 'Cannot construct a "select" prompt without any options'
  53             );
  54         }
  55
  56         $this->setOptions($options);
  57
  58         if ($allowEmpty !== null) {
  59             $this->setAllowEmpty($allowEmpty);
  60         }
  61
  62         if ($echo !== null) {
  63             $this->setEcho($echo);
  64         }
  65
  66     }
  67
  68     /**
  69      * Show a list of options and prompt the user to select one of them.
  70      *
  71      * @return string       Selected option
  72      */
  73     public function show()
  74     {
  75         // Show prompt text and available options
  76         $console = $this->getConsole();
  77         $console->writeLine($this->promptText);
  78         foreach ($this->options as $k => $v) {
  79             $console->writeLine('  ' . $k . ') ' . $v);
  80         }
  81
  82         //  Prepare mask
  83         $mask = implode("", array_keys($this->options));
  84         if ($this->allowEmpty) {
  85             $mask .= "\r\n";
  86         }
  87
  88         // Prepare other params for parent class
  89         $this->setAllowedChars($mask);
  90         $oldPrompt        = $this->promptText;
  91         $oldEcho          = $this->echo;
  92         $this->echo       = false;
  93         $this->promptText = null;
  94
  95         // Retrieve a single character
  96         $response = parent::show();
  97
  98         // Restore old params
  99         $this->promptText = $oldPrompt;
 100         $this->echo       = $oldEcho;
 101
 102         // Display selected option if echo is enabled
 103         if ($this->echo) {
 104             if (isset($this->options[$response])) {
 105                 $console->writeLine($this->options[$response]);
 106             } else {
 107                 $console->writeLine();
 108             }
 109         }
 110
 111         $this->lastResponse = $response;
 112         return $response;
 113     }
 114
 115     /**
 116      * Set allowed options
 117      *
 118      * @param array|\Traversable $options
 119      * @throws Exception\BadMethodCallException
 120      */
 121     public function setOptions($options)
 122     {
 123         if (!is_array($options) && !$options instanceof \Traversable) {
 124             throw new Exception\BadMethodCallException(
 125                 'Please specify an array or Traversable object as options'
 126             );
 127         }
 128
 129         if (!is_array($options)) {
 130             $this->options = array();
 131             foreach ($options as $k => $v) {
 132                 $this->options[$k] = $v;
 133             }
 134         } else {
 135             $this->options = $options;
 136         }
 137     }
 138
 139     /**
 140      * @return array
 141      */
 142     public function getOptions()
 143     {
 144         return $this->options;
 145     }
 146 }