Class yii\console\Request

Inheritance	yii\console\Request » yii\base\Request » yii\base\Component » yii\base\Object
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

Property	Type	Description	Defined By
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	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.	yii\console\Request
$scriptFile	string	Entry script file path (processed w/ realpath())	yii\base\Request

Public Methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Object
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\Object
__get()	Returns the value of an object property.	yii\base\Object
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Object
__set()	Sets value of an object property.	yii\base\Object
__unset()	Sets an object property to null.	yii\base\Object
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\Object
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Object
className()	Returns the fully qualified name of this class.	yii\base\Object
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\Object
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\Object
init()	Initializes the object.	yii\base\Object
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 getParams ( )
public void setParams ( $params )

Method Details