# Class yii\console\Request

Inheritance | yii\console\Request » yii\base\Request » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2/blob/master/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.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$isConsoleRequest | boolean | The value indicating whether the current request is made via console. | yii\base\Request
$params | array | The command line arguments. It does not include the entry script name. | yii\console\Request
$scriptFile | string | Entry script file path (processed w/ realpath()). | yii\base\Request

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__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
__construct() | Constructor. | yii\base\BaseObject
__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() | 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. | yii\console\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. | yii\console\Request
setIsConsoleRequest() | Sets the value indicating whether the current request is made via command line. | yii\base\Request
setParams() | Sets the command line arguments. | yii\console\Request
setScriptFile() | Sets the entry script file path. | yii\base\Request
trigger() | Triggers an event. | yii\base\Component

## Property Details

$params public property

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

public array $params = null

## Method Details

getParams() public method

Returns the command line arguments.

public array getParams ( )
return | array | The command line arguments. It does not include the entry script name.

resolve() public method

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

public array resolve ( )
return | array | The first element is the route, and the second is the associated parameters.
throws | yii\console\Exception | when parameter is wrong and can not be resolved

setParams() public method

Sets the command line arguments.

public void setParams ( $params )
$params | array | The command line arguments