interface/modules/zend_modules/library/Zend/Console/Prompt/Char.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 class Char extends AbstractPrompt
  13 {
  14     /**
  15      * @var string
  16      */
  17     protected $promptText = 'Please select one option ';
  18
  19     /**
  20      * @var bool
  21      */
  22     protected $allowEmpty = false;
  23
  24     /**
  25      * @var string
  26      */
  27     protected $allowedChars = 'yn';
  28
  29     /**
  30      * @var bool
  31      */
  32     protected $ignoreCase = true;
  33
  34     /**
  35      * @var bool
  36      */
  37     protected $echo = true;
  38
  39     /**
  40      * Ask the user for a single key stroke
  41      *
  42      * @param string $promptText   The prompt text to display in console
  43      * @param string $allowedChars A list of allowed chars (i.e. "abc12345")
  44      * @param bool   $ignoreCase   If true, case will be ignored and prompt will always return lower-cased response
  45      * @param bool   $allowEmpty   Is empty response allowed?
  46      * @param bool   $echo         Display the selection after user presses key
  47      */
  48     public function __construct(
  49         $promptText = 'Please hit a key',
  50         $allowedChars = '0123456789abcdefghijklmnopqrstuvwxyz',
  51         $ignoreCase = true,
  52         $allowEmpty = false,
  53         $echo = true
  54     ) {
  55
  56         $this->setPromptText($promptText);
  57         $this->setAllowEmpty($allowEmpty);
  58         $this->setIgnoreCase($ignoreCase);
  59
  60         if (null != $allowedChars) {
  61             if ($this->ignoreCase) {
  62                 $this->setAllowedChars(strtolower($allowedChars));
  63             } else {
  64                 $this->setAllowedChars($allowedChars);
  65             }
  66         }
  67
  68         $this->setEcho($echo);
  69     }
  70
  71     /**
  72      * Show the prompt to user and return a single char.
  73      *
  74      * @return string
  75      */
  76     public function show()
  77     {
  78         $this->getConsole()->write($this->promptText);
  79         $mask = $this->getAllowedChars();
  80
  81         /**
  82          * Normalize the mask if case is irrelevant
  83          */
  84         if ($this->ignoreCase) {
  85             $mask = strtolower($mask);   // lowercase all
  86             $mask .= strtoupper($mask);  // uppercase and append
  87             $mask = str_split($mask);    // convert to array
  88             $mask = array_unique($mask); // remove duplicates
  89             $mask = implode("", $mask);   // convert back to string
  90         }
  91
  92         /**
  93          * Read char from console
  94          */
  95         $char = $this->getConsole()->readChar($mask);
  96
  97         if ($this->echo) {
  98             echo trim($char)."\n";
  99         } else {
 100             if ($this->promptText) {
 101                 echo "\n";  // skip to next line but only if we had any prompt text
 102             }
 103         }
 104
 105         return $this->lastResponse = $char;
 106     }
 107
 108     /**
 109      * @param bool $allowEmpty
 110      */
 111     public function setAllowEmpty($allowEmpty)
 112     {
 113         $this->allowEmpty = (bool) $allowEmpty;
 114     }
 115
 116     /**
 117      * @return bool
 118      */
 119     public function getAllowEmpty()
 120     {
 121         return $this->allowEmpty;
 122     }
 123
 124     /**
 125      * @param string $promptText
 126      */
 127     public function setPromptText($promptText)
 128     {
 129         $this->promptText = $promptText;
 130     }
 131
 132     /**
 133      * @return string
 134      */
 135     public function getPromptText()
 136     {
 137         return $this->promptText;
 138     }
 139
 140     /**
 141      * @param string $allowedChars
 142      */
 143     public function setAllowedChars($allowedChars)
 144     {
 145         $this->allowedChars = $allowedChars;
 146     }
 147
 148     /**
 149      * @return string
 150      */
 151     public function getAllowedChars()
 152     {
 153         return $this->allowedChars;
 154     }
 155
 156     /**
 157      * @param bool $ignoreCase
 158      */
 159     public function setIgnoreCase($ignoreCase)
 160     {
 161         $this->ignoreCase = (bool) $ignoreCase;
 162     }
 163
 164     /**
 165      * @return bool
 166      */
 167     public function getIgnoreCase()
 168     {
 169         return $this->ignoreCase;
 170     }
 171
 172     /**
 173      * @param bool $echo
 174      */
 175     public function setEcho($echo)
 176     {
 177         $this->echo = (bool) $echo;
 178     }
 179
 180     /**
 181      * @return bool
 182      */
 183     public function getEcho()
 184     {
 185         return $this->echo;
 186     }
 187 }