interface/modules/zend_modules/library/Zend/Console/Request.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;
  11
  12 use Zend\Stdlib\Message;
  13 use Zend\Stdlib\Parameters;
  14 use Zend\Stdlib\RequestInterface;
  15
  16 class Request extends Message implements RequestInterface
  17 {
  18     /**
  19      * @var \Zend\Stdlib\Parameters
  20      */
  21     protected $params = null;
  22
  23     /**
  24      * @var \Zend\Stdlib\Parameters
  25      */
  26     protected $envParams = null;
  27
  28     /**
  29      * @var string
  30      */
  31     protected $scriptName = null;
  32
  33     /**
  34      * Create a new CLI request
  35      *
  36      * @param array|null $args Console arguments. If not supplied, $_SERVER['argv'] will be used
  37      * @param array|null $env Environment data. If not supplied, $_ENV will be used
  38      * @throws Exception\RuntimeException
  39      */
  40     public function __construct(array $args = null, array $env = null)
  41     {
  42         if ($args === null) {
  43             if (!isset($_SERVER['argv'])) {
  44                 $errorDescription = (ini_get('register_argc_argv') == false)
  45                     ? "Cannot create Console\\Request because PHP ini option 'register_argc_argv' is set Off"
  46                     : 'Cannot create Console\\Request because $_SERVER["argv"] is not set for unknown reason.';
  47                 throw new Exception\RuntimeException($errorDescription);
  48             }
  49             $args = $_SERVER['argv'];
  50         }
  51
  52         if ($env === null) {
  53             $env = $_ENV;
  54         }
  55
  56         /**
  57          * Extract first param assuming it is the script name
  58          */
  59         if (count($args) > 0) {
  60             $this->setScriptName(array_shift($args));
  61         }
  62
  63         /**
  64          * Store runtime params
  65          */
  66         $this->params()->fromArray($args);
  67         $this->setContent($args);
  68
  69         /**
  70          * Store environment data
  71          */
  72         $this->env()->fromArray($env);
  73     }
  74
  75     /**
  76      * Exchange parameters object
  77      *
  78      * @param \Zend\Stdlib\Parameters $params
  79      * @return Request
  80      */
  81     public function setParams(Parameters $params)
  82     {
  83         $this->params = $params;
  84         $this->setContent($params);
  85         return $this;
  86     }
  87
  88     /**
  89      * Return the container responsible for parameters
  90      *
  91      * @return \Zend\Stdlib\Parameters
  92      */
  93     public function getParams()
  94     {
  95         if ($this->params === null) {
  96             $this->params = new Parameters();
  97         }
  98
  99         return $this->params;
 100     }
 101
 102     /**
 103      * Return a single parameter.
 104      * Shortcut for $request->params()->get()
 105      *
 106      * @param string    $name       Parameter name
 107      * @param string    $default    (optional) default value in case the parameter does not exist
 108      * @return mixed
 109      */
 110     public function getParam($name, $default = null)
 111     {
 112         return $this->params()->get($name, $default);
 113     }
 114
 115     /**
 116      * Return the container responsible for parameters
 117      *
 118      * @return \Zend\Stdlib\Parameters
 119      */
 120     public function params()
 121     {
 122         return $this->getParams();
 123     }
 124
 125     /**
 126      * Provide an alternate Parameter Container implementation for env parameters in this object, (this is NOT the
 127      * primary API for value setting, for that see env())
 128      *
 129      * @param \Zend\Stdlib\Parameters $env
 130      * @return \Zend\Console\Request
 131      */
 132     public function setEnv(Parameters $env)
 133     {
 134         $this->envParams = $env;
 135         return $this;
 136     }
 137
 138     /**
 139      * Return a single parameter container responsible for env parameters
 140      *
 141      * @param string    $name       Parameter name
 142      * @param string    $default    (optional) default value in case the parameter does not exist
 143      * @return \Zend\Stdlib\Parameters
 144      */
 145     public function getEnv($name, $default = null)
 146     {
 147         return $this->env()->get($name, $default);
 148     }
 149
 150     /**
 151      * Return the parameter container responsible for env parameters
 152      *
 153      * @return \Zend\Stdlib\Parameters
 154      */
 155     public function env()
 156     {
 157         if ($this->envParams === null) {
 158             $this->envParams = new Parameters();
 159         }
 160
 161         return $this->envParams;
 162     }
 163
 164     /**
 165      * @return string
 166      */
 167     public function toString()
 168     {
 169         return trim(implode(' ', $this->params()->toArray()));
 170     }
 171
 172     /**
 173      * Allow PHP casting of this object
 174      *
 175      * @return string
 176      */
 177     public function __toString()
 178     {
 179         return $this->toString();
 180     }
 181
 182     /**
 183      * @param string $scriptName
 184      */
 185     public function setScriptName($scriptName)
 186     {
 187         $this->scriptName = $scriptName;
 188     }
 189
 190     /**
 191      * @return string
 192      */
 193     public function getScriptName()
 194     {
 195         return $this->scriptName;
 196     }
 197 }