Zend Framework
Back to top  

 Methods

Create a new CLI request

__construct(array $args, array $env) 

Parameters

$args

arraynull

Console arguments. If not supplied, $_SERVER['argv'] will be used

$env

arraynull

Environment data. If not supplied, $_ENV will be used

Exceptions

\Zend\Console\Exception\RuntimeException

Allow PHP casting of this object

__toString() : string

Returns

string

Return the parameter container responsible for env parameters

env() : \Zend\Stdlib\Parameters

Returns

\Zend\Stdlib\Parameters

Get message content

getContent() : mixed
Inherited

inherited_from \Zend\Stdlib\Message::getContent()

Returns

mixed

Return a single parameter container responsible for env parameters

getEnv(string $name, string $default) : \Zend\Stdlib\Parameters

Parameters

$name

string

Parameter name

$default

string

(optional) default value in case the parameter does not exist

Returns

\Zend\Stdlib\Parameters

Retrieve all metadata or a single metadatum as specified by key

getMetadata(null | string | int $key, null | mixed $default) : mixed
Inherited

inherited_from \Zend\Stdlib\Message::getMetadata()

Parameters

$key

nullstringint

$default

nullmixed

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Returns

mixed

Return a single parameter.

getParam(string $name, string $default) : mixed

Shortcut for $request->params()->get()

Parameters

$name

string

Parameter name

$default

string

(optional) default value in case the parameter does not exist

Returns

mixed

Return the container responsible for parameters

getParams() : \Zend\Stdlib\Parameters

Returns

\Zend\Stdlib\Parameters

getScriptName() 

getScriptName() : string

Returns

string

Return the container responsible for parameters

params() : \Zend\Stdlib\Parameters

Returns

\Zend\Stdlib\Parameters

Set message content

setContent(mixed $value) : \Zend\Stdlib\Message
Inherited

inherited_from \Zend\Stdlib\Message::setContent()

Parameters

$value

mixed

Returns

\Zend\Stdlib\Message

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())

setEnv(\Zend\Stdlib\Parameters $env) : \Zend\Console\Request

Parameters

$env

\Zend\Stdlib\Parameters

Returns

\Zend\Console\Request

Set message metadata

setMetadata(string | int | array | \Traversable $spec, mixed $value) : \Zend\Stdlib\Message
Inherited

Non-destructive setting of message metadata; always adds to the metadata, never overwrites the entire metadata container.

inherited_from \Zend\Stdlib\Message::setMetadata()

Parameters

$spec

stringintarray\Traversable

$value

mixed

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Returns

\Zend\Stdlib\Message

Exchange parameters object

setParams(\Zend\Stdlib\Parameters $params) : \Zend\Console\Request

Parameters

$params

\Zend\Stdlib\Parameters

Returns

\Zend\Console\Request

setScriptName() 

setScriptName(string $scriptName) 

Parameters

$scriptName

string

toString() 

toString() : string

Returns

string

 Properties

 

$content

$content : string
Inherited

inherited_from \Zend\Stdlib\Message::$$content
 

$envParams

$envParams : \Zend\Stdlib\Parameters

 

$metadata

$metadata : array
Inherited

inherited_from \Zend\Stdlib\Message::$$metadata
 

$params

$params : \Zend\Stdlib\Parameters

 

$scriptName

$scriptName : string