类 yii\console\controllers\ServeController
运行 PHP 内置 Web 服务器。
为了从远程机器访问服务器,请使用 0.0.0.0:8000。这在虚拟机中运行服务器时尤其有用。
公共属性
公共方法
受保护方法
方法 | 描述 | 定义于 |
---|---|---|
bindInjectedParams() | 根据 action 方法签名中的类型和名称填充参数。 | yii\base\Controller |
getActionMethodReflection() | yii\console\Controller | |
isAddressTaken() | yii\console\controllers\ServeController | |
parseDocCommentDetail() | 从文档块返回完整描述。 | yii\console\Controller |
parseDocCommentSummary() | 返回文档块的第一行。 | yii\console\Controller |
parseDocCommentTags() | 将注释块解析成标签。 | yii\console\Controller |
runCommand() | yii\console\controllers\ServeController |
事件
事件 | 类型 | 描述 | 定义于 |
---|---|---|---|
EVENT_AFTER_ACTION | yii\base\ActionEvent | 执行控制器 action 后触发的事件。 | yii\base\Controller |
EVENT_BEFORE_ACTION | yii\base\ActionEvent | 执行控制器 action 之前触发的事件。 | yii\base\Controller |
常量
常量 | 值 | 描述 | 定义于 |
---|---|---|---|
EXIT_CODE_ADDRESS_TAKEN_BY_ANOTHER_PROCESS | 5 | yii\console\controllers\ServeController | |
EXIT_CODE_ADDRESS_TAKEN_BY_ANOTHER_SERVER | 4 | yii\console\controllers\ServeController | |
EXIT_CODE_ERROR | 1 | 自 2.0.13 版本起已弃用。请改用 yii\console\ExitCode::UNSPECIFIED_ERROR。 | yii\console\Controller |
EXIT_CODE_NORMAL | 0 | 自 2.0.13 版本起已弃用。请改用 yii\console\ExitCode::OK。 | yii\console\Controller |
EXIT_CODE_NO_DOCUMENT_ROOT | 2 | yii\console\controllers\ServeController | |
EXIT_CODE_NO_ROUTING_FILE | 3 | yii\console\controllers\ServeController |
属性详情
方法详情
定义于: yii\base\Component::__call()
调用不是类方法的命名方法。
此方法将检查任何附加的行为是否具有指定名称的方法,如果可用则执行它。
不要直接调用此方法,因为它是一个 PHP 魔术方法,当调用未知方法时会隐式调用它。
public mixed __call ( $name, $params ) | ||
$name | string |
方法名称 |
$params | array |
方法参数 |
返回值 | mixed |
方法返回值 |
---|---|---|
抛出异常 | yii\base\UnknownMethodException |
调用未知方法时 |
public function __call($name, $params)
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $object) {
if ($object->hasMethod($name)) {
return call_user_func_array([$object, $name], $params);
}
}
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
public void __construct ( $id, $module, $config = [] ) | ||
$id | string |
此控制器的 ID。 |
$module | yii\base\Module |
此控制器所属的模块。 |
$config | array |
用于初始化对象属性的键值对。 |
public function __construct($id, $module, $config = [])
{
$this->id = $id;
$this->module = $module;
parent::__construct($config);
}
定义于: yii\base\Component::__get()
返回组件属性的值。
此方法将按以下顺序检查并采取相应的措施
- 由 getter 定义的属性:返回 getter 的结果
- 行为的属性:返回行为的属性值
不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 $value = $component->property;
时会隐式调用它。
另请参阅 __set()。
public mixed __get ( $name ) | ||
$name | string |
属性名称 |
返回值 | mixed |
属性值或行为的属性值 |
---|---|---|
抛出异常 | yii\base\UnknownPropertyException |
如果属性未定义 |
抛出异常 | yii\base\InvalidCallException |
如果属性是只写属性。 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
// read property, e.g. getName()
return $this->$getter();
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name;
}
}
if (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
定义于: yii\base\Component::__isset()
检查属性是否已设置,即定义且不为 null。
此方法将按以下顺序检查并采取相应的措施
- 由 setter 定义的属性:返回属性是否已设置
- 行为的属性:返回属性是否已设置
- 对于不存在的属性返回
false
不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 isset($component->property)
时会隐式调用它。
public boolean __isset ( $name ) | ||
$name | string |
属性名称或事件名称 |
返回值 | boolean |
指定的属性是否已设置 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name !== null;
}
}
return false;
}
定义于: yii\base\Component::__set()
设置组件属性的值。
此方法将按以下顺序检查并采取相应的措施
- 由 setter 定义的属性:设置属性值
- "on xyz" 格式的事件:将处理程序附加到 "xyz" 事件
- "as xyz" 格式的行为:附加名为 "xyz" 的行为
- 行为的属性:设置行为的属性值
不要直接调用此方法,因为它是一个 PHP 魔术方法,当执行 $component->property = $value;
时会隐式调用它。
另请参阅 __get()。
public void __set ( $name, $value ) | ||
$name | string |
属性名称或事件名称 |
$value | mixed |
属性值 |
抛出异常 | yii\base\UnknownPropertyException |
如果属性未定义 |
---|---|---|
抛出异常 | yii\base\InvalidCallException |
如果属性是只读属性。 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
// set property
$this->$setter($value);
return;
} elseif (strncmp($name, 'on ', 3) === 0) {
// on event: attach event handler
$this->on(trim(substr($name, 3)), $value);
return;
} elseif (strncmp($name, 'as ', 3) === 0) {
// as behavior: attach behavior
$name = trim(substr($name, 3));
$this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = $value;
return;
}
}
if (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
定义于: yii\base\Component::__unset()
将组件属性设置为 null。
此方法将按以下顺序检查并采取相应的措施
- 由 setter 定义的属性:将属性值设置为 null
- 行为的属性:将属性值设置为 null
不要直接调用此方法,因为它是一个 PHP 魔术方法,在执行 `unset($component->property)` 时会隐式调用。
public void __unset ( $name ) | ||
$name | string |
属性名称 |
抛出异常 | yii\base\InvalidCallException |
如果属性是只读的。 |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = null;
return;
}
}
throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}
运行 PHP 内置 Web 服务器。
public integer actionIndex ( $address = 'localhost' ) | ||
$address | string |
要提供服务的地址。可以是“主机”或“主机:端口”。 |
public function actionIndex($address = 'localhost')
{
$documentRoot = Yii::getAlias($this->docroot);
$router = $this->router !== null ? Yii::getAlias($this->router) : null;
if (strpos($address, ':') === false) {
$address = $address . ':' . $this->port;
}
if (!is_dir($documentRoot)) {
$this->stdout("Document root \"$documentRoot\" does not exist.\n", Console::FG_RED);
return self::EXIT_CODE_NO_DOCUMENT_ROOT;
}
if ($this->isAddressTaken($address)) {
$this->stdout("http://$address is taken by another process.\n", Console::FG_RED);
return self::EXIT_CODE_ADDRESS_TAKEN_BY_ANOTHER_PROCESS;
}
if ($this->router !== null && !file_exists($router)) {
$this->stdout("Routing file \"$router\" does not exist.\n", Console::FG_RED);
return self::EXIT_CODE_NO_ROUTING_FILE;
}
$this->stdout("Server started on http://{$address}/\n");
$this->stdout("Document root is \"{$documentRoot}\"\n");
if ($this->router) {
$this->stdout("Routing file is \"$router\"\n");
}
$this->stdout("Quit the server with CTRL-C or COMMAND-C.\n");
$command = '"' . PHP_BINARY . '"' . " -S {$address} -t \"{$documentRoot}\"";
if ($this->router !== null && $router !== '') {
$command .= " -r \"{$router}\"";
}
$this->runCommand($command);
}
定义于: yii\base\Controller::actions()
声明控制器的外部操作。
此方法旨在被覆盖以声明控制器的外部操作。它应该返回一个数组,数组键是操作 ID,数组值是相应的操作类名或操作配置数组。例如,
return [
'action1' => 'app\components\Action1',
'action2' => [
'class' => 'app\components\Action2',
'property1' => 'value1',
'property2' => 'value2',
],
];
Yii::createObject() 将稍后用于使用此处提供的配置创建请求的操作。
public array actions ( ) |
public function actions()
{
return [];
}
定义于: yii\base\Controller::afterAction()
此方法在操作执行后立即调用。
该方法将触发 EVENT_AFTER_ACTION 事件。该方法的返回值将用作操作的返回值。
如果覆盖此方法,则代码应如下所示
public function afterAction($action, $result)
{
$result = parent::afterAction($action, $result);
// your custom code here
return $result;
}
public mixed afterAction ( $action, $result ) | ||
$action | yii\base\Action |
刚刚执行的操作。 |
$result | mixed |
操作的返回值。 |
返回值 | mixed |
已处理的操作结果。 |
---|
public function afterAction($action, $result)
{
$event = new ActionEvent($action);
$event->result = $result;
$this->trigger(self::EVENT_AFTER_ACTION, $event);
return $event->result;
}
定义于: yii\console\Controller::ansiFormat()
使用 ANSI 代码格式化字符串。
可以使用 yii\helpers\Console 中定义的常量传递其他参数。
示例
echo $this->ansiFormat('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public string ansiFormat ( $string ) | ||
$string | string |
要格式化的字符串 |
public function ansiFormat($string)
{
if ($this->isColorEnabled()) {
$args = func_get_args();
array_shift($args);
$string = Console::ansiFormat($string, $args);
}
return $string;
}
定义于: yii\base\Component::attachBehavior()
将行为附加到此组件。
此方法将根据给定的配置创建行为对象。之后,行为对象将通过调用 yii\base\Behavior::attach() 方法附加到此组件。
另请参阅 detachBehavior()。
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | string |
行为的名称。 |
$behavior | string|array|yii\base\Behavior |
行为配置。可以是以下之一
|
返回值 | yii\base\Behavior |
行为对象 |
---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
定义于: yii\base\Component::attachBehaviors()
将行为列表附加到组件。
每个行为都由其名称索引,并且应该是一个 yii\base\Behavior 对象、一个指定行为类的字符串或一个用于创建行为的配置数组。
另请参阅 attachBehavior()。
public void attachBehaviors ( $behaviors ) | ||
$behaviors | array |
要附加到组件的行为列表 |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
定义于: yii\console\Controller::beforeAction()
此方法在操作执行前立即调用。
该方法将触发 EVENT_BEFORE_ACTION 事件。该方法的返回值将确定操作是否应继续运行。
如果操作不应该运行,则请求应该在 `beforeAction` 代码中通过提供必要的输出或重定向请求来处理。否则响应将为空。
如果覆盖此方法,则代码应如下所示
public function beforeAction($action)
{
// your custom code here, if you want the code to run before action filters,
// which are triggered on the [[EVENT_BEFORE_ACTION]] event, e.g. PageCache or AccessControl
if (!parent::beforeAction($action)) {
return false;
}
// other custom code here
return true; // or false to not run the action
}
public boolean beforeAction ( $action ) | ||
$action | yii\base\Action |
要执行的操作。 |
返回值 | boolean |
操作是否应该继续运行。 |
---|
public function beforeAction($action)
{
$silentExit = $this->silentExitOnException !== null ? $this->silentExitOnException : YII_ENV_TEST;
Yii::$app->errorHandler->silentExitOnException = $silentExit;
return parent::beforeAction($action);
}
定义于: yii\base\Component::behaviors()
返回此组件应表现为的行为列表。
子类可以覆盖此方法以指定它们希望作为其行为的行为。
此方法的返回值应该是一个行为对象或配置数组,以行为名称为索引。行为配置可以是指定行为类的字符串,也可以是以下结构的数组
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
请注意,行为类必须扩展自 yii\base\Behavior。行为可以使用名称或匿名方式附加。当数组键使用名称时,使用此名称,行为稍后可以使用 getBehavior() 检索,或使用 detachBehavior() 分离。匿名行为无法检索或分离。
在此方法中声明的行为将自动附加到组件(按需)。
public array behaviors ( ) | ||
返回值 | array |
行为配置。 |
---|
public function behaviors()
{
return [];
}
定义于: yii\console\Controller::bindActionParams()
将参数绑定到操作。
当此方法使用给定参数开始运行时,它由 yii\base\Action 调用。此方法将首先使用操作可用的 options 绑定参数。然后它验证给定的参数。
public array bindActionParams ( $action, $params ) | ||
$action | yii\base\Action |
要绑定参数的操作 |
$params | array |
要绑定到操作的参数 |
返回值 | array |
操作可以运行的有效参数。 |
---|---|---|
抛出异常 | yii\console\Exception |
如果存在未知选项或缺少参数 |
public function bindActionParams($action, $params)
{
if ($action instanceof InlineAction) {
$method = new \ReflectionMethod($this, $action->actionMethod);
} else {
$method = new \ReflectionMethod($action, 'run');
}
$args = [];
$missing = [];
$actionParams = [];
$requestedParams = [];
foreach ($method->getParameters() as $i => $param) {
$name = $param->getName();
$key = null;
if (array_key_exists($i, $params)) {
$key = $i;
} elseif (array_key_exists($name, $params)) {
$key = $name;
}
if ($key !== null) {
if (PHP_VERSION_ID >= 80000) {
$isArray = ($type = $param->getType()) instanceof \ReflectionNamedType && $type->getName() === 'array';
} else {
$isArray = $param->isArray();
}
if ($isArray) {
$params[$key] = $params[$key] === '' ? [] : preg_split('/\s*,\s*/', $params[$key]);
}
$args[] = $actionParams[$key] = $params[$key];
unset($params[$key]);
} elseif (
PHP_VERSION_ID >= 70100
&& ($type = $param->getType()) !== null
&& $type instanceof \ReflectionNamedType
&& !$type->isBuiltin()
) {
try {
$this->bindInjectedParams($type, $name, $args, $requestedParams);
} catch (\yii\base\Exception $e) {
throw new Exception($e->getMessage());
}
} elseif ($param->isDefaultValueAvailable()) {
$args[] = $actionParams[$i] = $param->getDefaultValue();
} else {
$missing[] = $name;
}
}
if (!empty($missing)) {
throw new Exception(Yii::t('yii', 'Missing required arguments: {params}', ['params' => implode(', ', $missing)]));
}
// We use a different array here, specifically one that doesn't contain service instances but descriptions instead.
if (\Yii::$app->requestedParams === null) {
\Yii::$app->requestedParams = array_merge($actionParams, $requestedParams);
}
return array_merge($args, $params);
}
定义于: yii\base\Controller::bindInjectedParams()
根据 action 方法签名中的类型和名称填充参数。
protected void bindInjectedParams ( ReflectionType $type, $name, &$args, &$requestedParams ) | ||
$type | ReflectionType |
操作参数的反射类型。 |
$name | string |
参数的名称。 |
$args | array |
操作的参数数组,此函数可能会向其中追加项目。 |
$requestedParams | array |
包含请求参数的数组,此函数可能会向其中写入特定的键值对。 |
抛出异常 | yii\base\ErrorException |
当我们无法加载所需的 service 时。 |
---|---|---|
抛出异常 | yii\base\InvalidConfigException |
当 DI 配置中出现错误时抛出。 |
抛出异常 | yii\di\NotInstantiableException |
当定义无法解析为具体类(例如接口类型提示)且容器中没有相应的定义时抛出。 |
final protected function bindInjectedParams(\ReflectionType $type, $name, &$args, &$requestedParams)
{
// Since it is not a builtin type it must be DI injection.
$typeName = $type->getName();
if (($component = $this->module->get($name, false)) instanceof $typeName) {
$args[] = $component;
$requestedParams[$name] = 'Component: ' . get_class($component) . " \$$name";
} elseif ($this->module->has($typeName) && ($service = $this->module->get($typeName)) instanceof $typeName) {
$args[] = $service;
$requestedParams[$name] = 'Module ' . get_class($this->module) . " DI: $typeName \$$name";
} elseif (\Yii::$container->has($typeName) && ($service = \Yii::$container->get($typeName)) instanceof $typeName) {
$args[] = $service;
$requestedParams[$name] = "Container DI: $typeName \$$name";
} elseif ($type->allowsNull()) {
$args[] = null;
$requestedParams[$name] = "Unavailable service: $name";
} else {
throw new Exception('Could not load required service: ' . $name);
}
}
定义于: yii\base\Component::canGetProperty()
返回一个值,指示是否可以读取属性。
如果满足以下条件,则可以读取属性:
- 类具有与指定名称关联的 getter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$checkVars
为 true 时); - 附加的行为具有给定名称的可读属性(当
$checkBehaviors
为 true 时)。
另请参阅 canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkVars | boolean |
是否将成员变量视为属性 |
$checkBehaviors | boolean |
是否将行为的属性视为此组件的属性 |
返回值 | boolean |
属性是否可读 |
---|
public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
定义于: yii\base\Component::canSetProperty()
返回一个值,指示是否可以设置属性。
如果满足以下条件,则可以写入属性:
- 类具有与指定名称关联的 setter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$checkVars
为 true 时); - 附加的行为具有给定名称的可写属性(当
$checkBehaviors
为 true 时)。
另请参阅 canGetProperty()。
public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkVars | boolean |
是否将成员变量视为属性 |
$checkBehaviors | boolean |
是否将行为的属性视为此组件的属性 |
返回值 | boolean |
属性是否可写 |
---|
public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
::class
。
定义于: yii\base\BaseObject::className()
返回此类的完全限定名称。
public static string className ( ) | ||
返回值 | string |
此类的完全限定名称。 |
---|
public static function className()
{
return get_called_class();
}
定义于: yii\console\Controller::confirm()
要求用户通过键入 y 或 n 来确认。
一个典型的用法如下所示
if ($this->confirm("Are you sure?")) {
echo "user typed yes\n";
} else {
echo "user typed no\n";
}
public boolean confirm ( $message, $default = false ) | ||
$message | string |
在等待用户输入之前输出。 |
$default | boolean |
如果未进行选择,则返回此值。 |
返回值 | boolean |
用户是否确认。如果 $interactive 为 false,则返回 true。 |
---|
public function confirm($message, $default = false)
{
if ($this->interactive) {
return Console::confirm($message, $default);
}
return true;
}
定义于: yii\base\Controller::createAction()
根据给定的操作 ID 创建一个操作。
此方法首先检查操作 ID 是否已在 actions() 中声明。如果是,它将使用其中声明的配置来创建操作对象。否则,它将查找名称格式为 actionXyz
的控制器方法,其中 xyz
是操作 ID。如果找到,将创建一个表示该方法的 yii\base\InlineAction 并返回。
public yii\base\Action|null createAction ( $id ) | ||
$id | string |
操作 ID。 |
返回值 | yii\base\Action|null |
新创建的操作实例。如果 ID 未解析为任何操作,则返回 Null。 |
---|
public function createAction($id)
{
if ($id === '') {
$id = $this->defaultAction;
}
$actionMap = $this->actions();
if (isset($actionMap[$id])) {
return Yii::createObject($actionMap[$id], [$id, $this]);
}
if (preg_match('/^(?:[a-z0-9_]+-)*[a-z0-9_]+$/', $id)) {
$methodName = 'action' . str_replace(' ', '', ucwords(str_replace('-', ' ', $id)));
if (method_exists($this, $methodName)) {
$method = new \ReflectionMethod($this, $methodName);
if ($method->isPublic() && $method->getName() === $methodName) {
return new InlineAction($id, $this, $methodName);
}
}
}
return null;
}
public yii\base\Behavior|null detachBehavior ( $name ) | ||
$name | string |
行为的名称。 |
返回值 | yii\base\Behavior|null |
已分离的行为。如果行为不存在,则返回 Null。 |
---|
public function detachBehavior($name)
{
$this->ensureBehaviors();
if (isset($this->_behaviors[$name])) {
$behavior = $this->_behaviors[$name];
unset($this->_behaviors[$name]);
$behavior->detach();
return $behavior;
}
return null;
}
定义于: yii\base\Component::detachBehaviors()
从组件中分离所有行为。
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
定义于: yii\base\Component::ensureBehaviors()
确保在behaviors()中声明的行为已附加到此组件。
public void ensureBehaviors ( ) |
public function ensureBehaviors()
{
if ($this->_behaviors === null) {
$this->_behaviors = [];
foreach ($this->behaviors() as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
}
定义于: yii\base\Controller::findLayoutFile()
查找适用的布局文件。
public string|boolean findLayoutFile ( $view ) | ||
$view | yii\base\View |
用于渲染布局文件的视图对象。 |
返回值 | string|boolean |
布局文件路径,或者如果不需要布局则为 false。请参阅 render() 以了解如何指定此参数。 |
---|---|---|
抛出异常 | yii\base\InvalidArgumentException |
如果使用无效的路径别名来指定布局。 |
public function findLayoutFile($view)
{
$module = $this->module;
$layout = null;
if (is_string($this->layout)) {
$layout = $this->layout;
} elseif ($this->layout === null) {
while ($module !== null && $module->layout === null) {
$module = $module->module;
}
if ($module !== null && is_string($module->layout)) {
$layout = $module->layout;
}
}
if ($layout === null) {
return false;
}
if (strncmp($layout, '@', 1) === 0) {
$file = Yii::getAlias($layout);
} elseif (strncmp($layout, '/', 1) === 0) {
$file = Yii::$app->getLayoutPath() . DIRECTORY_SEPARATOR . substr($layout, 1);
} else {
$file = $module->getLayoutPath() . DIRECTORY_SEPARATOR . $layout;
}
if (pathinfo($file, PATHINFO_EXTENSION) !== '') {
return $file;
}
$path = $file . '.' . $view->defaultExtension;
if ($view->defaultExtension !== 'php' && !is_file($path)) {
$path = $file . '.php';
}
return $path;
}
定义于: yii\console\Controller::getActionArgsHelp()
返回操作的匿名参数的帮助信息。
返回值应为数组。键为参数名称,值为对应帮助信息。每个值必须是以下结构的数组
- required: bool,此参数是否必需
- type: string|null,此参数的 PHP 类型
- default: mixed,此参数的默认值
- comment: string,此参数的描述
默认实现将返回从与操作方法对应的参数的 Reflection 或 DocBlock 中提取的帮助信息。
public array getActionArgsHelp ( $action ) | ||
$action | yii\base\Action |
操作实例 |
返回值 | array |
操作参数的帮助信息 |
---|
public function getActionArgsHelp($action)
{
$method = $this->getActionMethodReflection($action);
$tags = $this->parseDocCommentTags($method);
$tags['param'] = isset($tags['param']) ? (array) $tags['param'] : [];
$phpDocParams = [];
foreach ($tags['param'] as $i => $tag) {
if (preg_match('/^(?<type>\S+)(\s+\$(?<name>\w+))?(?<comment>.*)/us', $tag, $matches) === 1) {
$key = empty($matches['name']) ? $i : $matches['name'];
$phpDocParams[$key] = ['type' => $matches['type'], 'comment' => $matches['comment']];
}
}
unset($tags);
$args = [];
/** @var \ReflectionParameter $parameter */
foreach ($method->getParameters() as $i => $parameter) {
$type = null;
$comment = '';
if (PHP_MAJOR_VERSION > 5 && $parameter->hasType()) {
$reflectionType = $parameter->getType();
if (PHP_VERSION_ID >= 70100) {
$types = method_exists($reflectionType, 'getTypes') ? $reflectionType->getTypes() : [$reflectionType];
foreach ($types as $key => $reflectionType) {
$types[$key] = $reflectionType->getName();
}
$type = implode('|', $types);
} else {
$type = (string) $reflectionType;
}
}
// find PhpDoc tag by property name or position
$key = isset($phpDocParams[$parameter->name]) ? $parameter->name : (isset($phpDocParams[$i]) ? $i : null);
if ($key !== null) {
$comment = $phpDocParams[$key]['comment'];
if ($type === null && !empty($phpDocParams[$key]['type'])) {
$type = $phpDocParams[$key]['type'];
}
}
// if type still not detected, then using type of default value
if ($type === null && $parameter->isDefaultValueAvailable() && $parameter->getDefaultValue() !== null) {
$type = gettype($parameter->getDefaultValue());
}
$args[$parameter->name] = [
'required' => !$parameter->isOptional(),
'type' => $type,
'default' => $parameter->isDefaultValueAvailable() ? $parameter->getDefaultValue() : null,
'comment' => $comment,
];
}
return $args;
}
定义于: yii\console\Controller::getActionHelp()
返回指定操作的详细帮助信息。
public string getActionHelp ( $action ) | ||
$action | yii\base\Action |
获取帮助的操作 |
返回值 | string |
指定操作的详细帮助信息。 |
---|
public function getActionHelp($action)
{
return $this->parseDocCommentDetail($this->getActionMethodReflection($action));
}
定义于: yii\console\Controller::getActionHelpSummary()
返回描述指定操作的一行简短摘要。
public string getActionHelpSummary ( $action ) | ||
$action | yii\base\Action |
获取摘要的操作 |
返回值 | string |
描述指定操作的一行简短摘要。 |
---|
public function getActionHelpSummary($action)
{
if ($action === null) {
return $this->ansiFormat(Yii::t('yii', 'Action not found.'), Console::FG_RED);
}
return $this->parseDocCommentSummary($this->getActionMethodReflection($action));
}
protected ReflectionFunctionAbstract getActionMethodReflection ( $action ) | ||
$action | yii\base\Action |
protected function getActionMethodReflection($action)
{
if (!isset($this->_reflections[$action->id])) {
if ($action instanceof InlineAction) {
$this->_reflections[$action->id] = new \ReflectionMethod($this, $action->actionMethod);
} else {
$this->_reflections[$action->id] = new \ReflectionMethod($action, 'run');
}
}
return $this->_reflections[$action->id];
}
定义于: yii\console\Controller::getActionOptionsHelp()
返回操作的选项的帮助信息。
返回值应为数组。键为选项名称,值为对应帮助信息。每个值必须是以下结构的数组
- type: string,此参数的 PHP 类型。
- default: string,此参数的默认值
- comment: string,此参数的注释
默认实现将返回从与操作选项对应的属性的文档注释中提取的帮助信息。
public array getActionOptionsHelp ( $action ) | ||
$action | yii\base\Action | |
返回值 | array |
操作选项的帮助信息 |
---|
public function getActionOptionsHelp($action)
{
$optionNames = $this->options($action->id);
if (empty($optionNames)) {
return [];
}
$class = new \ReflectionClass($this);
$options = [];
foreach ($class->getProperties() as $property) {
$name = $property->getName();
if (!in_array($name, $optionNames, true)) {
continue;
}
$defaultValue = $property->getValue($this);
$tags = $this->parseDocCommentTags($property);
// Display camelCase options in kebab-case
$name = Inflector::camel2id($name, '-', true);
if (isset($tags['var']) || isset($tags['property'])) {
$doc = isset($tags['var']) ? $tags['var'] : $tags['property'];
if (is_array($doc)) {
$doc = reset($doc);
}
if (preg_match('/^(\S+)(.*)/s', $doc, $matches)) {
$type = $matches[1];
$comment = $matches[2];
} else {
$type = null;
$comment = $doc;
}
$options[$name] = [
'type' => $type,
'default' => $defaultValue,
'comment' => $comment,
];
} else {
$options[$name] = [
'type' => null,
'default' => $defaultValue,
'comment' => '',
];
}
}
return $options;
}
定义于: yii\base\Component::getBehavior()
返回命名的行为对象。
public yii\base\Behavior|null getBehavior ( $name ) | ||
$name | string |
行为名称 |
返回值 | yii\base\Behavior|null |
行为对象,如果行为不存在则为 null |
---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
定义于: yii\base\Component::getBehaviors()
返回附加到此组件的所有行为。
public yii\base\Behavior[] getBehaviors ( ) | ||
返回值 | yii\base\Behavior[] |
附加到此组件的行为列表 |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
public string getHelp ( ) |
public function getHelp()
{
return $this->parseDocCommentDetail(new \ReflectionClass($this));
}
定义于: yii\console\Controller::getHelpSummary()
返回描述此控制器的单行简短摘要。
您可以重写此方法以返回自定义摘要。默认实现返回 PHPDoc 注释中的第一行。
public string getHelpSummary ( ) |
public function getHelpSummary()
{
return $this->parseDocCommentSummary(new \ReflectionClass($this));
}
public yii\base\Module[] getModules ( ) | ||
返回值 | yii\base\Module[] |
此控制器所在的祖先模块。 |
---|
public function getModules()
{
$modules = [$this->module];
$module = $this->module;
while ($module->module !== null) {
array_unshift($modules, $module->module);
$module = $module->module;
}
return $modules;
}
定义于: yii\console\Controller::getOptionValues()
返回对应于操作 ID 的选项的属性子类可以覆盖此方法以指定可能的属性。
public array getOptionValues ( $actionID ) | ||
$actionID | string |
当前请求的操作 ID |
返回值 | array |
与操作选项对应的属性 |
---|
public function getOptionValues($actionID)
{
// $actionId might be used in subclasses to provide properties specific to action id
$properties = [];
foreach ($this->options($this->action->id) as $property) {
$properties[$property] = $this->$property;
}
return $properties;
}
定义于: yii\console\Controller::getPassedOptionValues()
返回对应于传递选项的属性。
public array getPassedOptionValues ( ) | ||
返回值 | array |
与传递的选项对应的属性 |
---|
public function getPassedOptionValues()
{
$properties = [];
foreach ($this->_passedOptions as $property) {
$properties[$property] = $this->$property;
}
return $properties;
}
定义于: yii\console\Controller::getPassedOptions()
返回执行期间传递的有效选项的名称。
public 数组 getPassedOptions ( ) | ||
返回值 | array |
执行期间传递的选项名称 |
---|
public function getPassedOptions()
{
return $this->_passedOptions;
}
定义于: yii\base\Controller::getRoute()
返回当前请求的路由。
public 字符串 getRoute ( ) | ||
返回值 | string |
当前请求的路由(模块 ID、控制器 ID 和操作 ID)。 |
---|
public function getRoute()
{
return $this->action !== null ? $this->action->getUniqueId() : $this->getUniqueId();
}
定义于: yii\base\Controller::getUniqueId()
返回控制器的唯一 ID。
public 字符串 getUniqueId ( ) | ||
返回值 | string |
控制器 ID,以模块 ID(如果有)为前缀。 |
---|
public function getUniqueId()
{
return $this->module instanceof Application ? $this->id : $this->module->getUniqueId() . '/' . $this->id;
}
定义于: yii\base\Controller::getView()
返回可用于渲染视图或视图文件的视图对象。
render()、renderPartial() 和 renderFile() 方法将使用此视图对象来实现实际的视图渲染。如果未设置,则默认为“view”应用程序组件。
public yii\base\View|yii\web\View getView ( ) | ||
返回值 | yii\base\View|yii\web\View |
可用于渲染视图或视图文件的视图对象。 |
---|
public function getView()
{
if ($this->_view === null) {
$this->_view = Yii::$app->getView();
}
return $this->_view;
}
定义于: yii\base\Controller::getViewPath()
返回包含此控制器视图文件的目录。
public 字符串 getViewPath ( ) | ||
返回值 | string |
包含此控制器视图文件的目录。 |
---|
public function getViewPath()
{
if ($this->_viewPath === null) {
$this->_viewPath = $this->module->getViewPath() . DIRECTORY_SEPARATOR . $this->id;
}
return $this->_viewPath;
}
定义于: yii\base\Component::hasEventHandlers()
返回一个值,指示是否有任何处理程序附加到命名事件。
public 布尔值 hasEventHandlers ( $name ) | ||
$name | string |
事件名称 |
返回值 | boolean |
是否有任何处理程序附加到事件。 |
---|
public function hasEventHandlers($name)
{
$this->ensureBehaviors();
if (!empty($this->_events[$name])) {
return true;
}
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
return true;
}
}
return Event::hasHandlers($this, $name);
}
定义于: yii\base\Component::hasMethod()
返回一个值,指示方法是否已定义。
如果定义了方法
- 该类具有具有指定名称的方法
- 附加的行为具有给定名称的方法(当
$checkBehaviors
为 true 时)。
public 布尔值 hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkBehaviors | boolean |
是否将行为的方法视为此组件的方法 |
返回值 | boolean |
方法是否已定义 |
---|
public function hasMethod($name, $checkBehaviors = true)
{
if (method_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->hasMethod($name)) {
return true;
}
}
}
return false;
}
定义于: yii\base\Component::hasProperty()
返回一个值,指示是否为此组件定义了属性。
如果定义了属性
- 该类具有与指定名称关联的 getter 或 setter 方法(在这种情况下,属性名称不区分大小写);
- 类具有与指定名称相同的成员变量(当
$checkVars
为 true 时); - 附加的行为具有给定名称的属性(当
$checkBehaviors
为 true 时)。
另请参阅
public 布尔值 hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
属性名称 |
$checkVars | boolean |
是否将成员变量视为属性 |
$checkBehaviors | boolean |
是否将行为的属性视为此组件的属性 |
返回值 | boolean |
属性是否已定义 |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
public void init ( ) |
public function init()
{
parent::init();
$this->request = Instance::ensure($this->request, Request::className());
$this->response = Instance::ensure($this->response, Response::className());
}
protected 布尔值 isAddressTaken ( $address ) | ||
$address | string |
服务器地址 |
返回值 | boolean |
如果地址已被使用 |
---|
protected function isAddressTaken($address)
{
list($hostname, $port) = explode(':', $address);
$fp = @fsockopen($hostname, $port, $errno, $errstr, 3);
if ($fp === false) {
return false;
}
fclose($fp);
return true;
}
定义于: yii\console\Controller::isColorEnabled()
返回一个值,指示是否启用了 ANSI 颜色。
仅当 $color 设置为 true 或未设置且终端支持 ANSI 颜色时,才会启用 ANSI 颜色。
public 布尔值 isColorEnabled ( $stream = \STDOUT ) | ||
$stream | 资源 |
要检查的流。 |
返回值 | boolean |
是否在输出中启用 ANSI 样式。 |
---|
public function isColorEnabled($stream = \STDOUT)
{
return $this->color === null ? Console::streamSupportsAnsiColors($stream) : $this->color;
}
定义于: yii\base\Component::off()
从此组件中分离现有的事件处理程序。
此方法与 on() 相反。
注意:如果为事件名称传递通配符模式,则只会删除使用此通配符注册的处理程序,而使用与该通配符匹配的普通名称注册的处理程序将保留。
另请参阅 on()。
public 布尔值 off ( $name, $handler = null ) | ||
$name | string |
事件名称 |
$handler | 可调用|空 |
要删除的事件处理程序。如果它是 null,则将删除附加到命名事件的所有处理程序。 |
返回值 | boolean |
如果找到并分离了处理程序 |
---|
public function off($name, $handler = null)
{
$this->ensureBehaviors();
if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
return false;
}
if ($handler === null) {
unset($this->_events[$name], $this->_eventWildcards[$name]);
return true;
}
$removed = false;
// plain event names
if (isset($this->_events[$name])) {
foreach ($this->_events[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_events[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_events[$name] = array_values($this->_events[$name]);
return true;
}
}
// wildcard event names
if (isset($this->_eventWildcards[$name])) {
foreach ($this->_eventWildcards[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_eventWildcards[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
// remove empty wildcards to save future redundant regex checks:
if (empty($this->_eventWildcards[$name])) {
unset($this->_eventWildcards[$name]);
}
}
}
return $removed;
}
将事件处理程序附加到事件。
事件处理程序必须是一个有效的 PHP 回调。以下是一些示例
function ($event) { ... } // anonymous function
[$object, 'handleClick'] // $object->handleClick()
['Page', 'handleClick'] // Page::handleClick()
'handleClick' // global function handleClick()
事件处理程序必须使用以下签名定义,
function ($event)
其中$event
是一个yii\base\Event对象,其中包含与事件关联的参数。
从 2.0.14 开始,您可以将事件名称指定为通配符模式
$component->on('event.group.*', function ($event) {
Yii::trace($event->name . ' is triggered.');
});
另请参阅 off()。
public void on ( $name, $handler, $data = null, $append = true ) | ||
$name | string |
事件名称 |
$handler | 可调用 |
事件处理程序 |
$data | mixed |
触发事件时传递给事件处理程序的数据。当调用事件处理程序时,可以通过 yii\base\Event::$data 访问此数据。 |
$append | boolean |
是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 false,则新的处理程序将插入到现有处理程序列表的开头。 |
public function on($name, $handler, $data = null, $append = true)
{
$this->ensureBehaviors();
if (strpos($name, '*') !== false) {
if ($append || empty($this->_eventWildcards[$name])) {
$this->_eventWildcards[$name][] = [$handler, $data];
} else {
array_unshift($this->_eventWildcards[$name], [$handler, $data]);
}
return;
}
if ($append || empty($this->_events[$name])) {
$this->_events[$name][] = [$handler, $data];
} else {
array_unshift($this->_events[$name], [$handler, $data]);
}
}
返回选项别名名称。
子类可以重写此方法以指定别名选项。
public array optionAliases ( ) | ||
返回值 | array |
对操作有效的选项别名,其中键是选项的别名,值是选项名称。 |
---|
public function optionAliases()
{
return array_merge(parent::optionAliases(), [
't' => 'docroot',
'p' => 'port',
'r' => 'router',
]);
}
public string[] options ( $actionID ) | ||
$actionID | string |
当前请求的操作 ID |
返回值 | string[] |
对操作有效的选项名称 |
---|
public function options($actionID)
{
return array_merge(parent::options($actionID), [
'docroot',
'router',
'port',
]);
}
定义于: yii\console\Controller::parseDocCommentDetail()
从文档块返回完整描述。
protected string parseDocCommentDetail ( $reflection ) | ||
$reflection | ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract |
protected function parseDocCommentDetail($reflection)
{
$comment = strtr(trim(preg_replace('/^\s*\**([ \t])?/m', '', trim($reflection->getDocComment(), '/'))), "\r", '');
if (preg_match('/^\s*@\w+/m', $comment, $matches, PREG_OFFSET_CAPTURE)) {
$comment = trim(substr($comment, 0, $matches[0][1]));
}
if ($comment !== '') {
return rtrim(Console::renderColoredString(Console::markdownToAnsi($comment)));
}
return '';
}
定义于: yii\console\Controller::parseDocCommentSummary()
返回文档块的第一行。
protected string parseDocCommentSummary ( $reflection ) | ||
$reflection | ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract |
protected function parseDocCommentSummary($reflection)
{
$docLines = preg_split('~\R~u', $reflection->getDocComment());
if (isset($docLines[1])) {
return trim($docLines[1], "\t *");
}
return '';
}
定义于: yii\console\Controller::parseDocCommentTags()
将注释块解析成标签。
protected array parseDocCommentTags ( $reflection ) | ||
$reflection | ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract |
注释块 |
返回值 | array |
解析的标签 |
---|
protected function parseDocCommentTags($reflection)
{
$comment = $reflection->getDocComment();
$comment = "@description \n" . strtr(trim(preg_replace('/^\s*\**([ \t])?/m', '', trim($comment, '/'))), "\r", '');
$parts = preg_split('/^\s*@/m', $comment, -1, PREG_SPLIT_NO_EMPTY);
$tags = [];
foreach ($parts as $part) {
if (preg_match('/^(\w+)(.*)/ms', trim($part), $matches)) {
$name = $matches[1];
if (!isset($tags[$name])) {
$tags[$name] = trim($matches[2]);
} elseif (is_array($tags[$name])) {
$tags[$name][] = trim($matches[2]);
} else {
$tags[$name] = [$tags[$name], trim($matches[2])];
}
}
}
return $tags;
}
定义于: yii\console\Controller::prompt()
提示用户输入并验证它。
public string prompt ( $text, $options = [] ) | ||
$text | string |
提示字符串 |
$options | array |
验证输入的选项
如何使用带有验证器函数的 prompt 方法的示例。
|
返回值 | string |
用户输入 |
---|
public function prompt($text, $options = [])
{
if ($this->interactive) {
return Console::prompt($text, $options);
}
return isset($options['default']) ? $options['default'] : '';
}
定义于: yii\base\Controller::render()
渲染视图并在可用时应用布局。
要呈现的视图可以用以下格式之一指定
- 路径别名(例如“@app/views/site/index”);
- 应用程序中的绝对路径(例如“//site/index”):视图名称以双斜杠开头。实际的视图文件将在应用程序的 视图路径 下查找。
- 模块中的绝对路径(例如“/site/index”):视图名称以单个斜杠开头。实际的视图文件将在 视图路径 的 $module 下查找。
- 相对路径(例如“index”):实际的视图文件将在 $viewPath 下查找。
要确定应应用哪个布局,将执行以下两个步骤
- 在第一步中,它确定布局名称和上下文模块
- 如果 $layout 指定为字符串,则将其用作布局名称,并将 $module 用作上下文模块;
- 如果 $layout 为 null,则遍历此控制器的所有祖先模块,并找到第一个 layout 不为 null 的模块。布局和相应的模块分别用作布局名称和上下文模块。如果找不到这样的模块或相应的布局不是字符串,它将返回 false,表示没有适用的布局。
- 在第二步中,它根据先前找到的布局名称和上下文模块确定实际的布局文件。布局名称可以是
- 路径别名(例如“@app/views/layouts/main”);
- 绝对路径(例如“/main”):布局名称以斜杠开头。实际的布局文件将在应用程序的 布局路径 下查找;
- 相对路径(例如“main”):实际的布局文件将在上下文模块的 布局路径 下查找。
如果布局名称不包含文件扩展名,它将使用默认扩展名.php
。
public string render ( $view, $params = [] ) | ||
$view | string |
视图名称。 |
$params | array |
应在视图中可用的参数(名称-值对)。这些参数在布局中不可用。 |
返回值 | string |
呈现结果。 |
---|---|---|
抛出异常 | yii\base\InvalidArgumentException |
如果视图文件或布局文件不存在。 |
public function render($view, $params = [])
{
$content = $this->getView()->render($view, $params, $this);
return $this->renderContent($content);
}
定义于: yii\base\Controller::renderContent()
通过应用布局渲染静态字符串。
public string renderContent ( $content ) | ||
$content | string |
正在呈现的静态字符串 |
返回值 | string |
布局的呈现结果,其中给定的静态字符串作为 |
---|
public function renderContent($content)
{
$layoutFile = $this->findLayoutFile($this->getView());
if ($layoutFile !== false) {
return $this->getView()->renderFile($layoutFile, ['content' => $content], $this);
}
return $content;
}
定义于: yii\base\Controller::renderFile()
渲染视图文件。
public string renderFile ( $file, $params = [] ) | ||
$file | string |
要渲染的视图文件。这可以是文件路径或 路径别名。 |
$params | array |
应该在视图中可用的参数(名称-值对)。 |
返回值 | string |
呈现结果。 |
---|---|---|
抛出异常 | yii\base\InvalidArgumentException |
如果视图文件不存在。 |
public function renderFile($file, $params = [])
{
return $this->getView()->renderFile($file, $params, $this);
}
public string renderPartial ( $view, $params = [] ) | ||
$view | string |
视图名称。请参阅 render() 以了解如何指定视图名称。 |
$params | array |
应该在视图中可用的参数(名称-值对)。 |
返回值 | string |
呈现结果。 |
---|---|---|
抛出异常 | yii\base\InvalidArgumentException |
如果视图文件不存在。 |
public function renderPartial($view, $params = [])
{
return $this->getView()->render($view, $params, $this);
}
定义于: yii\base\Controller::run()
运行以路由形式指定的请求。
路由可以是此控制器中操作的 ID,也可以是包含模块 ID、控制器 ID 和操作 ID 的完整路由。如果路由以斜杠 '/' 开头,则路由的解析将从应用程序开始;否则,它将从此控制器的父模块开始。
另请参阅 runAction()。
public mixed run ( $route, $params = [] ) | ||
$route | string |
要处理的路由,例如 'view'、'comment/view'、'/admin/comment/view'。 |
$params | array |
要传递给操作的参数。 |
返回值 | mixed |
操作的结果。 |
---|
public function run($route, $params = [])
{
$pos = strpos($route, '/');
if ($pos === false) {
return $this->runAction($route, $params);
} elseif ($pos > 0) {
return $this->module->runAction($route, $params);
}
return Yii::$app->runAction(ltrim($route, '/'), $params);
}
定义于: yii\console\Controller::runAction()
使用指定的操作 ID 和参数运行操作。
如果操作 ID 为空,则该方法将使用 $defaultAction。
另请参阅 createAction()。
public integer runAction ( $id, $params = [] ) | ||
$id | string |
要执行的操作的 ID。 |
$params | array |
要传递给操作的参数(名称-值对)。 |
返回值 | integer |
操作执行的状态。0 表示正常,其他值表示异常。 |
---|---|---|
抛出异常 | yii\base\InvalidRouteException |
如果请求的操作 ID 无法成功解析为操作。 |
抛出异常 | yii\console\Exception |
如果存在未知选项或缺少参数 |
public function runAction($id, $params = [])
{
if (!empty($params)) {
// populate options here so that they are available in beforeAction().
$options = $this->options($id === '' ? $this->defaultAction : $id);
if (isset($params['_aliases'])) {
$optionAliases = $this->optionAliases();
foreach ($params['_aliases'] as $name => $value) {
if (array_key_exists($name, $optionAliases)) {
$params[$optionAliases[$name]] = $value;
} else {
$message = Yii::t('yii', 'Unknown alias: -{name}', ['name' => $name]);
if (!empty($optionAliases)) {
$aliasesAvailable = [];
foreach ($optionAliases as $alias => $option) {
$aliasesAvailable[] = '-' . $alias . ' (--' . $option . ')';
}
$message .= '. ' . Yii::t('yii', 'Aliases available: {aliases}', [
'aliases' => implode(', ', $aliasesAvailable)
]);
}
throw new Exception($message);
}
}
unset($params['_aliases']);
}
foreach ($params as $name => $value) {
// Allow camelCase options to be entered in kebab-case
if (!in_array($name, $options, true) && strpos($name, '-') !== false) {
$kebabName = $name;
$altName = lcfirst(Inflector::id2camel($kebabName));
if (in_array($altName, $options, true)) {
$name = $altName;
}
}
if (in_array($name, $options, true)) {
$default = $this->$name;
if (is_array($default) && is_string($value)) {
$this->$name = preg_split('/\s*,\s*(?![^()]*\))/', $value);
} elseif ($default !== null) {
settype($value, gettype($default));
$this->$name = $value;
} else {
$this->$name = $value;
}
$this->_passedOptions[] = $name;
unset($params[$name]);
if (isset($kebabName)) {
unset($params[$kebabName]);
}
} elseif (!is_int($name)) {
$message = Yii::t('yii', 'Unknown option: --{name}', ['name' => $name]);
if (!empty($options)) {
$message .= '. ' . Yii::t('yii', 'Options available: {options}', ['options' => '--' . implode(', --', $options)]);
}
throw new Exception($message);
}
}
}
if ($this->help) {
$route = $this->getUniqueId() . '/' . $id;
return Yii::$app->runAction('help', [$route]);
}
return parent::runAction($id, $params);
}
protected void runCommand ( $command ) | ||
$command |
protected function runCommand($command)
{
passthru($command);
}
定义于: yii\console\Controller::select()
允许用户从选项中进行选择。输入“?”将显示可供选择的选项列表及其说明。
public string select ( $prompt, $options = [], $default = null ) | ||
$prompt | string |
提示消息 |
$options | array |
要从中选择的选项的键值数组 |
$default | string|null |
用户未提供选项时要使用的值。如果默认值为 |
返回值 | string |
用户选择的选项字符 |
---|
版本 | 描述 |
---|---|
2.0.49 | 添加了 $default 参数 |
public function select($prompt, $options = [], $default = null)
{
if ($this->interactive) {
return Console::select($prompt, $options, $default);
}
return $default;
}
定义于: yii\base\Controller::setView()
设置此控制器使用的视图对象。
public void setView ( $view ) | ||
$view | yii\base\View|yii\web\View |
可用于渲染视图或视图文件的视图对象。 |
public function setView($view)
{
$this->_view = $view;
}
定义于: yii\base\Controller::setViewPath()
设置包含视图文件的目录。
public void setViewPath ( $path ) | ||
$path | string |
视图文件的根目录。 |
抛出异常 | yii\base\InvalidArgumentException |
如果目录无效 |
---|
public function setViewPath($path)
{
$this->_viewPath = Yii::getAlias($path);
}
定义于: yii\console\Controller::stderr()
将字符串打印到 STDERR。
您可以选择使用 yii\helpers\Console 中定义的常量通过传递其他参数来使用 ANSI 代码格式化字符串。
示例
$this->stderr('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public integer|boolean stderr ( $string ) | ||
$string | string |
要打印的字符串 |
返回值 | integer|boolean |
打印的字节数或错误时的 false |
---|
public function stderr($string)
{
if ($this->isColorEnabled(\STDERR)) {
$args = func_get_args();
array_shift($args);
$string = Console::ansiFormat($string, $args);
}
return fwrite(\STDERR, $string);
}
定义于: yii\console\Controller::stdout()
将字符串打印到 STDOUT。
您可以选择使用 yii\helpers\Console 中定义的常量通过传递其他参数来使用 ANSI 代码格式化字符串。
示例
$this->stdout('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public integer|boolean stdout ( $string ) | ||
$string | string |
要打印的字符串 |
返回值 | integer|boolean |
打印的字节数或错误时的 false |
---|
public function stdout($string)
{
if ($this->isColorEnabled()) {
$args = func_get_args();
array_shift($args);
$string = Console::ansiFormat($string, $args);
}
return Console::stdout($string);
}
public void trigger ( $name, yii\base\Event $event = null ) | ||
$name | string |
事件名称 |
$event | yii\base\Event|null |
事件实例。如果未设置,则将创建一个默认的 yii\base\Event 对象。 |
public function trigger($name, Event $event = null)
{
$this->ensureBehaviors();
$eventHandlers = [];
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (StringHelper::matchWildcard($wildcard, $name)) {
$eventHandlers[] = $handlers;
}
}
if (!empty($this->_events[$name])) {
$eventHandlers[] = $this->_events[$name];
}
if (!empty($eventHandlers)) {
$eventHandlers = call_user_func_array('array_merge', $eventHandlers);
if ($event === null) {
$event = new Event();
}
if ($event->sender === null) {
$event->sender = $this;
}
$event->handled = false;
$event->name = $name;
foreach ($eventHandlers as $handler) {
$event->data = $handler[1];
call_user_func($handler[0], $event);
// stop further handling if the event is handled
if ($event->handled) {
return;
}
}
}
// invoke class-level attached handlers
Event::trigger($this, $name, $event);
}
请 注册 或 登录 以发表评论。