没有命名空间的类 yii yii\base yii\behaviors yii\caching yii\captcha yii\console yii\console\controllers yii\console\widgets yii\data yii\db yii\db\conditions yii\db\cubrid yii\db\cubrid\conditions yii\db\mssql yii\db\mssql\conditions yii\db\mysql yii\db\oci yii\db\oci\conditions yii\db\pgsql yii\db\sqlite yii\db\sqlite\conditions yii\di yii\filters yii\filters\auth yii\grid yii\helpers yii\i18n yii\log yii\mail yii\mutex yii\rbac yii\rest yii\test yii\validators yii\web yii\widgets

Class yii\console\Request

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

控制台请求表示控制台应用程序的环境信息。

它是 PHP $_SERVER 变量的包装器,该变量包含有关当前运行的 PHP 脚本及其命令行参数的信息。

公共属性

隐藏继承的属性

属性类型描述被定义在
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$isConsoleRequest boolean 指示当前请求是否通过控制台运行的值 yii\base\Request
$params array 命令行参数。它不包括条目脚本名称。 yii\console\Request
$scriptFile string 入口脚本文件路径(processed w/ realpath()) yii\base\Request

公共方法

隐藏继承的方法

方法描述被定义在
__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() 返回一个值,该值指示当前请求是否通过命令行生成。 yii\base\Request
getParams() 返回命令行参数。 yii\console\Request
getScriptFile() 返回入口脚本文件的路径。 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() 将当前请求解析为路由和相关参数。 yii\console\Request
setIsConsoleRequest() 设置指示当前请求是否通过命令行生成的值。 yii\base\Request
setParams() 设置命令行参数。 yii\console\Request
setScriptFile() 设置入口脚本文件路径。 通常可以根据 SCRIPT_FILENAME SERVER 变量确定入口脚本文件路径。 但是,对于某些服务器配置,这可能不正确或不可行。 提供此 setter 以便可以手动指定入口脚本文件路径。 yii\base\Request
trigger() Triggers an event. yii\base\Component

属性详情

$params 公共 属性

命令行参数。它不包括条目脚本名称。

public array getParams ( )
public void setParams ( $params )

方法详情

getParams() 公共 方法

返回命令行参数。

public array getParams()
return array

命令行参数。它不包括条目脚本名称。

resolve() 公共 方法

将当前请求解析为路由和相关参数。

public array resolve()
return array

第一个元素是路由,第二个元素是关联的参数。

throws yii\console\Exception

当参数错误且无法解析时

setParams() 公共 方法

设置命令行参数。

public void setParams($params)
$params array

命令行参数