Class yii\console\Request

继承yii\console\Request » yii\base\Request » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/console/Request.php

控制台 Request 表示控制台应用程序的环境信息.

它是 PHP $_SERVER变量的封装, 该变量保存有关当前正在运行的 PHP 脚本以及为其提供的命令行参数的信息.

公共属性

隐藏继承的属性

属性类型描述定义在
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$isConsoleRequest boolean 指示当前请求是否是通过控制台发出的. yii\base\Request
$params array 命令行参数. 它不包括输入脚本名称. yii\console\Request
$scriptFile string 入口脚本文件路径(processed w/ realpath()). yii\base\Request

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的指定的方法. yii\base\Component
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\BaseObject
__get() 返回组件属性的值. yii\base\Component
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\Component
__set() 设置组件属性的值. yii\base\Component
__unset() 将组件属性设置为null. yii\base\Component
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
canGetProperty() 返回一个值, 指示属性是否可读取. yii\base\Component
canSetProperty() 返回一个值, 指示属性是否可设置. yii\base\Component
className() 返回此类的完全限定名称. yii\base\BaseObject
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
getIsConsoleRequest() 返回一个值, 指示当前请求是否是通过命令行发出的. yii\base\Request
getParams() 返回命令行参数. yii\console\Request
getScriptFile() 返回入口脚本文件路径. yii\base\Request
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\Component
init() 初始化对象. yii\base\BaseObject
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
resolve() 将当前请求解析为路由和关联的参数. yii\console\Request
setIsConsoleRequest() 设置指示当前请求是否是通过命令行发出的. yii\base\Request
setParams() 设置命令行参数. yii\console\Request
setScriptFile() 设置入口脚本文件路径. yii\base\Request
trigger() 触发事件. yii\base\Component

属性详情

$params public 属性

命令行参数. 它不包括输入脚本名称.

public array $params null

方法详情

getParams() public 方法

返回命令行参数.

public array getParams ( )
return array

命令行参数. 它不包括输入脚本名称.

resolve() public 方法

将当前请求解析为路由和关联的参数.

public array resolve ( )
return array

第一个参数是路由, 第二个参数是关联的参数.

throws yii\console\Exception

参数错误且无法解析时.

setParams() public 方法

设置命令行参数.

public void setParams ( $params )
$params array

命令行参数.