Request

API reference › yii › console › Request

class	`yii\console\Request`
Extends	`yii\base\Request` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0
Source	`framework/console/Request.php`

The console Request represents the environment information for a console application.

It is a wrapper for the PHP $_SERVER variable which holds information about the currently running PHP script and the command line arguments given to it.

Properties

Property	Type	Description	Defined by
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$isConsoleRequest`	`bool`	The value indicating whether the current request is made via console.	`yii\base\Request`
`$params`	`array`	The command line arguments.	`Request`
`$scriptFile`	`string`	Entry script file path (processed w/ realpath()).	`yii\base\Request`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`yii\base\Component`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`detachBehavior()`	Detaches a behavior from the component.	`yii\base\Component`
`detachBehaviors()`	Detaches all behaviors from the component.	`yii\base\Component`
`ensureBehaviors()`	Makes sure that the behaviors declared in `behaviors()` are attached to this component.	`yii\base\Component`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getIsConsoleRequest()`	Returns a value indicating whether the current request is made via command line.	`yii\base\Request`
`getParams()`	Returns the command line arguments.	`Request`
`getScriptFile()`	Returns entry script file path.	`yii\base\Request`
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	`yii\base\Component`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Initializes the object.	`yii\base\BaseObject`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`resolve()`	Resolves the current request into a route and the associated parameters.	`Request`
`setIsConsoleRequest()`	Sets the value indicating whether the current request is made via command line.	`yii\base\Request`
`setParams()`	Sets the command line arguments.	`Request`
`setScriptFile()`	Sets the entry script file path.	`yii\base\Request`
`trigger()`	Triggers an event.	`yii\base\Component`

Property details

$params

public array $params

The command line arguments.

It does not include the entry script name.

Method details

getParams()

public function getParams(): array

Returns the command line arguments.

Returns

array: The command line arguments. It does not include the entry script name.

resolve()

public function resolve(): array

Resolves the current request into a route and the associated parameters.

Returns

array: The first element is the route, and the second is the associated parameters.

Throws

Exception: when parameter is wrong and can not be resolved

setParams()

public function setParams(array $params): mixed

Sets the command line arguments.

Parameters

Parameter	Type	Description
`$params`	`array`	The command line arguments

Returns

mixed