interface/modules/zend_modules/library/Zend/Console/Prompt/Number.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 Number extends Line
  13 {
  14     /**
  15      * @var string
  16      */
  17     protected $promptText = 'Please enter a number: ';
  18
  19     /**
  20      * @var bool
  21      */
  22     protected $allowFloat = false;
  23
  24     /**
  25      * @var int
  26      */
  27     protected $min;
  28
  29     /**
  30      * @var int
  31      */
  32     protected $max;
  33
  34     /**
  35      * Ask the user for a number.
  36      *
  37      * @param string    $promptText     The prompt text to display in console
  38      * @param bool      $allowEmpty     Is empty response allowed?
  39      * @param bool      $allowFloat     Are floating (non-decimal) numbers allowed?
  40      * @param int   $min            Minimum value (inclusive)
  41      * @param int   $max            Maximum value (inclusive)
  42      */
  43     public function __construct(
  44         $promptText = 'Please enter a number: ',
  45         $allowEmpty = false,
  46         $allowFloat = false,
  47         $min = null,
  48         $max = null
  49     ) {
  50         if ($promptText !== null) {
  51             $this->setPromptText($promptText);
  52         }
  53
  54         if ($allowEmpty !== null) {
  55             $this->setAllowEmpty($allowEmpty);
  56         }
  57
  58         if ($min !== null) {
  59             $this->setMin($min);
  60         }
  61
  62         if ($max !== null) {
  63             $this->setMax($max);
  64         }
  65
  66         if ($allowFloat !== null) {
  67             $this->setAllowFloat($allowFloat);
  68         }
  69     }
  70
  71     /**
  72      * Show the prompt to user and return the answer.
  73      *
  74      * @return mixed
  75      */
  76     public function show()
  77     {
  78         /**
  79          * Ask for a number and validate it.
  80          */
  81         do {
  82             $valid = true;
  83             $number = parent::show();
  84             if ($number === "" && !$this->allowEmpty) {
  85                 $valid = false;
  86             } elseif ($number === "") {
  87                 $number = null;
  88             } elseif (!is_numeric($number)) {
  89                 $this->getConsole()->writeLine("$number is not a number\n");
  90                 $valid = false;
  91             } elseif (!$this->allowFloat && (round($number) != $number)) {
  92                 $this->getConsole()->writeLine("Please enter a non-floating number, i.e. " . round($number) . "\n");
  93                 $valid = false;
  94             } elseif ($this->max !== null && $number > $this->max) {
  95                 $this->getConsole()->writeLine("Please enter a number not greater than " . $this->max . "\n");
  96                 $valid = false;
  97             } elseif ($this->min !== null && $number < $this->min) {
  98                 $this->getConsole()->writeLine("Please enter a number not smaller than " . $this->min . "\n");
  99                 $valid = false;
 100             }
 101         } while (!$valid);
 102
 103         /**
 104          * Cast proper type
 105          */
 106         if ($number !== null) {
 107             $number = $this->allowFloat ? (double) $number : (int) $number;
 108         }
 109
 110         return $this->lastResponse = $number;
 111     }
 112
 113     /**
 114      * @param  bool $allowEmpty
 115      */
 116     public function setAllowEmpty($allowEmpty)
 117     {
 118         $this->allowEmpty = $allowEmpty;
 119     }
 120
 121     /**
 122      * @return bool
 123      */
 124     public function getAllowEmpty()
 125     {
 126         return $this->allowEmpty;
 127     }
 128
 129     /**
 130      * @param int $maxLength
 131      */
 132     public function setMaxLength($maxLength)
 133     {
 134         $this->maxLength = $maxLength;
 135     }
 136
 137     /**
 138      * @return int
 139      */
 140     public function getMaxLength()
 141     {
 142         return $this->maxLength;
 143     }
 144
 145     /**
 146      * @param string $promptText
 147      */
 148     public function setPromptText($promptText)
 149     {
 150         $this->promptText = $promptText;
 151     }
 152
 153     /**
 154      * @return string
 155      */
 156     public function getPromptText()
 157     {
 158         return $this->promptText;
 159     }
 160
 161     /**
 162      * @param int $max
 163      */
 164     public function setMax($max)
 165     {
 166         $this->max = $max;
 167     }
 168
 169     /**
 170      * @return int
 171      */
 172     public function getMax()
 173     {
 174         return $this->max;
 175     }
 176
 177     /**
 178      * @param int $min
 179      */
 180     public function setMin($min)
 181     {
 182         $this->min = $min;
 183     }
 184
 185     /**
 186      * @return int
 187      */
 188     public function getMin()
 189     {
 190         return $this->min;
 191     }
 192
 193     /**
 194      * @param  bool $allowFloat
 195      */
 196     public function setAllowFloat($allowFloat)
 197     {
 198         $this->allowFloat = $allowFloat;
 199     }
 200
 201     /**
 202      * @return bool
 203      */
 204     public function getAllowFloat()
 205     {
 206         return $this->allowFloat;
 207     }
 208 }