289. Class

289.1. Zend\Console\Request

289.1.1. Methods

289.1.1.1. __construct

__construct()

Create a new CLI request

Parameters:

• array|null – Console arguments. If not supplied, $_SERVER[‘argv’] will be used
• array|null – Environment data. If not supplied, $_ENV will be used

Throws ExceptionRuntimeException:  

289.1.1.2. setParams

setParams()

Exchange parameters object

Parameters:ZendStdlibParameters – Return type:Request

289.1.1.3. getParams

getParams()

Return the container responsible for parameters

Return type:ZendStdlibParameters

289.1.1.4. getParam

getParam()

Return a single parameter. Shortcut for $request->params()->get()

Parameters:

• string – Parameter name
• string – (optional) default value in case the parameter does not exist

Return type:

mixed

289.1.1.5. params

params()

Return the container responsible for parameters

Return type:ZendStdlibParameters

289.1.1.6. setEnv

setEnv()

Provide an alternate Parameter Container implementation for env parameters in this object, (this is NOT the primary API for value setting, for that see env())

Parameters:ZendStdlibParameters – Return type:ZendConsoleRequest

289.1.1.7. env

env()

Return the parameter container responsible for env parameters

Return type:ZendStdlibParameters

289.1.1.8. toString

toString()

@return string

289.1.1.9. __toString

__toString()

Allow PHP casting of this object

Return type:string

289.1.1.10. setScriptName

setScriptName()

@param string $scriptName

289.1.1.11. getScriptName

getScriptName()

@return string