vendor/zendframework/zendframework/library/Zend/Console/Prompt/Confirm.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-2015 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 Confirm extends Char
  13 {
  14     /**
  15      * @var string
  16      */
  17     protected $promptText = 'Are you sure?';
  18
  19     /**
  20      * @var string
  21      */
  22     protected $allowedChars = 'yn';
  23
  24     /**
  25      * @var string
  26      */
  27     protected $yesChar = 'y';
  28
  29     /**
  30      * @var string
  31      */
  32     protected $noChar = 'n';
  33
  34     /**
  35      * @var bool
  36      */
  37     protected $ignoreCase = 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    $yesChar        The "yes" key (defaults to Y)
  44      * @param string    $noChar         The "no" key (defaults to N)
  45      */
  46     public function __construct(
  47         $promptText = 'Are you sure?',
  48         $yesChar = 'y',
  49         $noChar = 'n'
  50     ) {
  51         if ($promptText !== null) {
  52             $this->setPromptText($promptText);
  53         }
  54
  55         if ($yesChar !== null) {
  56             $this->setYesChar($yesChar);
  57         }
  58
  59         if ($noChar !== null) {
  60             $this->setNoChar($noChar);
  61         }
  62     }
  63
  64     /**
  65      * Show the confirmation message and return result.
  66      *
  67      * @return bool
  68      */
  69     public function show()
  70     {
  71         $char = parent::show();
  72         if ($this->ignoreCase) {
  73             $response = strtolower($char) === strtolower($this->yesChar);
  74         } else {
  75             $response = $char === $this->yesChar;
  76         }
  77         return $this->lastResponse = $response;
  78     }
  79
  80     /**
  81      * @param string $noChar
  82      */
  83     public function setNoChar($noChar)
  84     {
  85         $this->noChar = $noChar;
  86         $this->setAllowedChars($this->yesChar . $this->noChar);
  87     }
  88
  89     /**
  90      * @return string
  91      */
  92     public function getNoChar()
  93     {
  94         return $this->noChar;
  95     }
  96
  97     /**
  98      * @param string $yesChar
  99      */
 100     public function setYesChar($yesChar)
 101     {
 102         $this->yesChar = $yesChar;
 103         $this->setAllowedChars($this->yesChar . $this->noChar);
 104     }
 105
 106     /**
 107      * @return string
 108      */
 109     public function getYesChar()
 110     {
 111         return $this->yesChar;
 112     }
 113 }