0 关注者

抽象类 yii\console\controllers\BaseMigrateController

所有类 | 属性 | 方法 | 事件 | 常量
继承关系yii\console\controllers\BaseMigrateController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
实现接口yii\base\Configurable, yii\base\ViewContextInterface
子类yii\console\controllers\MigrateController
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/console/controllers/BaseMigrateController.php

BaseMigrateController 是迁移控制器（migrate controllers）的基类。

公有属性

隐藏继承的属性

属性 类型 描述 定义于
$action yii\base\Action|null 当前正在执行的操作。 yii\base\Controller
$behaviors yii\base\Behavior[] 附加到此组件的行为列表。 yii\base\Component
$color boolean|null 是否启用输出中的 ANSI 颜色。 yii\console\Controller
$compact boolean 指示控制台输出是否应紧凑。 yii\console\controllers\BaseMigrateController
$defaultAction string 默认命令操作。 yii\console\controllers\BaseMigrateController
$help boolean 是否显示当前命令的帮助信息。 yii\console\Controller
$helpSummary string yii\console\Controller
$id string 此控制器的 ID。 yii\base\Controller
$interactive boolean 是否以交互方式运行命令。 yii\console\Controller
$layout string|null|false 要应用于此控制器视图的布局名称。 yii\base\Controller
$migrationNamespaces array 包含迁移类的命名空间列表。 yii\console\controllers\BaseMigrateController
$migrationPath string|array|null 包含迁移类的目录。 yii\console\controllers\BaseMigrateController
$module yii\base\Module 此控制器所属的模块。 yii\base\Controller
$modules yii\base\Module[] 此控制器所在的祖先模块。 yii\base\Controller
$newFileMode integer|null 为新生成的迁移文件设置的权限。 yii\console\controllers\BaseMigrateController
$newFileOwnership string|integer|null 为新生成的迁移文件设置的用户和/或组所有权。 yii\console\controllers\BaseMigrateController
$passedOptionValues array 对应于传递选项的属性。 yii\console\Controller
$passedOptions array 执行期间传递的选项名称。 yii\console\Controller
$request yii\base\Request|array|string 请求。 yii\base\Controller
$response yii\base\Response|array|string 响应。 yii\base\Controller
$route string 当前请求的路由（模块 ID、控制器 ID 和操作 ID）。 yii\base\Controller
$silentExitOnException boolean|null 如果为 true - 脚本在出现异常时以 ExitCode::OK 结束。 yii\console\Controller
$templateFile string 生成新迁移的模板文件。 yii\console\controllers\BaseMigrateController
$uniqueId string 控制器 ID，以模块 ID（如果有）作为前缀。 yii\base\Controller
$view yii\base\View|yii\web\View 可用于渲染视图或视图文件的视图对象。 yii\base\Controller
$viewPath string 包含此控制器视图文件的目录。 yii\base\Controller

公有方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\Component
__clone() 此方法在通过克隆现有对象创建对象后调用。 yii\base\Component
__construct() yii\base\Controller
__get() 返回组件属性的值。 yii\base\Component
__isset() 检查属性是否已设置，即定义且不为 null。 yii\base\Component
__set() 设置组件属性的值。 yii\base\Component
__unset() 将组件属性设置为 null。 yii\base\Component
actionCreate() 创建一个新的迁移。 yii\console\controllers\BaseMigrateController
actionDown() 通过回滚旧迁移来降级应用程序。 yii\console\controllers\BaseMigrateController
actionFresh() 删除所有表和相关的约束。从头开始迁移。 yii\console\controllers\BaseMigrateController
actionHistory() 显示迁移历史。 yii\console\controllers\BaseMigrateController
actionMark() 将迁移历史修改为指定版本。 yii\console\controllers\BaseMigrateController
actionNew() 显示未应用的新迁移。 yii\console\controllers\BaseMigrateController
actionRedo() 重做最近几次迁移。 yii\console\controllers\BaseMigrateController
actionTo() 升级或降级到指定版本。 yii\console\controllers\BaseMigrateController
actionUp() 通过应用新迁移来升级应用程序。 yii\console\controllers\BaseMigrateController
actions() 声明控制器的外部操作。 yii\base\Controller
afterAction() 此方法在操作执行后立即调用。 yii\base\Controller
ansiFormat() 使用 ANSI 代码格式化字符串。 yii\console\Controller
attachBehavior() 将行为附加到此组件。 yii\base\Component
attachBehaviors() 将行为列表附加到组件。 yii\base\Component
beforeAction() 此方法在执行操作之前立即调用（在所有可能的过滤器之后）。它检查 $migrationPath 的存在。 yii\console\controllers\BaseMigrateController
behaviors() 返回此组件应表现为的行为列表。 yii\base\Component
bindActionParams() 将参数绑定到操作。 yii\console\Controller
canGetProperty() 返回一个值，指示是否可以读取属性。 yii\base\Component
canSetProperty() 返回一个值，指示是否可以设置属性。 yii\base\Component
className() 返回此类的完全限定名称。 yii\base\BaseObject
confirm() 要求用户通过输入 y 或 n 来确认。 yii\console\Controller
createAction() 根据给定的操作 ID 创建一个操作。 yii\base\Controller
detachBehavior() 从组件中分离行为。 yii\base\Component
detachBehaviors() 从组件中分离所有行为。 yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件。 yii\base\Component
findLayoutFile() 查找适用的布局文件。 yii\base\Controller
getActionArgsHelp() 返回操作的匿名参数的帮助信息。 yii\console\Controller
getActionHelp() 返回指定操作的详细帮助信息。 yii\console\Controller
getActionHelpSummary() 返回描述指定操作的一行简短摘要。 yii\console\Controller
getActionOptionsHelp() 返回操作选项的帮助信息。 yii\console\Controller
getBehavior() 返回命名的行为对象。 yii\base\Component
getBehaviors() 返回附加到此组件的所有行为。 yii\base\Component
getHelp() 返回此控制器的帮助信息。 yii\console\Controller
getHelpSummary() 返回描述此控制器的单行简短摘要。 yii\console\Controller
getModules() 返回此控制器的所有祖先模块。 yii\base\Controller
getOptionValues() 返回对应于操作 ID 选项的属性 子类可以重写此方法以指定可能的属性。 yii\console\Controller
getPassedOptionValues() 返回对应于传递选项的属性。 yii\console\Controller
getPassedOptions() 返回执行期间传递的有效选项的名称。 yii\console\Controller
getRoute() 返回当前请求的路由。 yii\base\Controller
getUniqueId() 返回控制器的唯一 ID。 yii\base\Controller
getView() 返回可用于渲染视图或视图文件的视图对象。 yii\base\Controller
getViewPath() 返回包含此控制器视图文件的目录。 yii\base\Controller
hasEventHandlers() 返回一个值，指示是否有任何处理程序附加到指定的事件。 yii\base\Component
hasMethod() 返回一个值，指示是否定义了方法。 yii\base\Component
hasProperty() 返回一个值，指示是否为此组件定义了属性。 yii\base\Component
init() 初始化对象。 yii\base\Controller
isColorEnabled() 返回一个值，指示是否启用了 ANSI 颜色。 yii\console\Controller
off() 从该组件分离现有的事件处理程序。 yii\base\Component
on() 将事件处理程序附加到事件。 yii\base\Component
optionAliases() 返回选项别名名称。 yii\console\Controller
options() 返回操作（id）的有效选项名称。选项需要存在一个公共成员变量，其名称为选项名称。 yii\console\controllers\BaseMigrateController
prompt() 提示用户输入并对其进行验证。 yii\console\Controller
render() 渲染视图并在可用时应用布局。 yii\base\Controller
renderContent() 通过应用布局渲染静态字符串。 yii\base\Controller
renderFile() 渲染视图文件。 yii\base\Controller
renderPartial() 渲染视图而不应用布局。 yii\base\Controller
run() 运行以路由形式指定的请求。 yii\base\Controller
runAction() 使用指定的动作 ID 和参数运行动作。 yii\console\Controller
select() 让用户选择一个选项。输入“？”将显示可供选择的选项列表及其说明。 yii\console\Controller
setView() 设置此控制器要使用的视图对象。 yii\base\Controller
setViewPath() 设置包含视图文件的目录。 yii\base\Controller
stderr() 将字符串打印到 STDERR。 yii\console\Controller
stdout() 将字符串打印到 STDOUT。 yii\console\Controller
trigger() 触发事件。 yii\base\Component

受保护方法

隐藏继承的方法

方法 描述 定义于
addMigrationHistory() 将新的迁移条目添加到历史记录。 yii\console\controllers\BaseMigrateController
bindInjectedParams() 根据动作方法签名中的类型和名称填充参数。 yii\base\Controller
createMigration() 创建一个新的迁移实例。 yii\console\controllers\BaseMigrateController
generateMigrationSourceCode() 生成新的迁移源 PHP 代码。 yii\console\controllers\BaseMigrateController
getActionMethodReflection() yii\console\Controller
getMigrationHistory() 返回迁移历史记录。 yii\console\controllers\BaseMigrateController
getMigrationNameLimit() 返回迁移的最大名称长度。 yii\console\controllers\BaseMigrateController
getNewMigrations() 返回尚未应用的迁移。 yii\console\controllers\BaseMigrateController
includeMigrationFile() 包含给定迁移类名称的迁移文件。 yii\console\controllers\BaseMigrateController
migrateDown() 使用指定的迁移类降级。 yii\console\controllers\BaseMigrateController
migrateToTime() 迁移到过去指定的应用时间。 yii\console\controllers\BaseMigrateController
migrateToVersion() 迁移到特定版本。 yii\console\controllers\BaseMigrateController
migrateUp() 使用指定的迁移类升级。 yii\console\controllers\BaseMigrateController
parseDocCommentDetail() 从文档块返回完整描述。 yii\console\Controller
parseDocCommentSummary() 返回文档块的第一行。 yii\console\Controller
parseDocCommentTags() 将注释块解析为标签。 yii\console\Controller
removeMigrationHistory() 从历史记录中删除现有的迁移。 yii\console\controllers\BaseMigrateController
truncateDatabase() 截断数据库。 yii\console\controllers\BaseMigrateController

事件

隐藏继承的事件

事件 类型 描述 定义于
EVENT_AFTER_ACTION yii\base\ActionEvent 执行控制器操作后立即引发的事件。 yii\base\Controller
EVENT_BEFORE_ACTION yii\base\ActionEvent 执行控制器操作前立即引发的事件。 yii\base\Controller

常量

隐藏继承的常量

常量 值 描述 定义于
BASE_MIGRATION 'm000000_000000_base' 标记整个迁移历史记录开始的虚拟迁移的名称。 yii\console\controllers\BaseMigrateController
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

属性详情

隐藏继承的属性

$compact 公共属性（自版本 2.0.13 起可用）

指示控制台输出是否应压缩。如果将其设置为 true，则迁移中运行的各个命令将不会输出到控制台。默认为 false，换句话说，默认情况下输出是完全详细的。

public boolean $compact = false
$defaultAction 公共属性

默认命令操作。

public string $defaultAction = 'up'
$migrationNamespaces 公共属性（自版本 2.0.10 起可用）

包含迁移类的命名空间列表。

迁移命名空间应可解析为 路径别名，如果以 @ 为前缀，例如，如果您指定命名空间 app\migrations，则代码 Yii::getAlias('@app/migrations') 应该能够返回此命名空间引用的目录的文件路径。这与 Yii 的 自动加载约定 相对应。

例如

[
    'app\migrations',
    'some\extension\migrations',
]

另请参阅 $migrationPath。

public array $migrationNamespaces = []
$migrationPath 公共属性

包含迁移类的目录。这可以是 路径别名 或目录路径。

位于此路径的迁移类应在没有命名空间的情况下声明。如果您使用的是命名空间迁移，请使用 $migrationNamespaces 属性。

如果您已设置 $migrationNamespaces，则可以将此字段设置为 null 以禁用不使用命名空间的迁移。

从 2.0.12 版开始，您还可以指定应搜索以加载迁移的迁移路径数组。这主要用于支持提供无命名空间迁移的旧扩展，并在保留现有迁移的同时采用命名空间迁移的新功能。

通常，要从不同位置加载迁移，$migrationNamespaces 是首选解决方案，因为迁移名称包含历史记录中迁移的来源，而使用多个迁移路径时则并非如此。

另请参阅 $migrationNamespaces。

public string|array|null $migrationPath = [
    '@app/migrations',
]
$newFileMode 公共属性（自版本 2.0.43 起可用）

为新生成的迁移文件设置的权限。此值将由 PHP chmod() 函数使用。不会应用 umask。如果未设置，则权限将由当前环境确定。

public integer|null $newFileMode = null
$newFileOwnership 公共属性（自版本 2.0.43 起可用）

为新生成的迁移文件设置的用户和/或组所有权。如果未设置，则所有权将由当前环境确定。

另请参阅 yii\helpers\FileHelper::changeOwnership()。

public string|integer|null $newFileOwnership = null
$templateFile 公共属性

生成新迁移的模板文件。它可以是 路径别名（例如“@app/migrations/template.php”）或文件路径。

public string $templateFile = null

方法详情

隐藏继承的方法

__call() 公共方法

定义于： 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()");
}
__clone() 公共方法

定义于： yii\base\Component::__clone()

此方法在通过克隆现有对象创建对象后调用。

它删除所有行为，因为它们附加到旧对象上。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}
__construct() 公共方法

定义于： yii\base\Controller::__construct()

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);
}
__get() 公共方法

定义于： 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);
}
__isset() 公共方法

定义于： yii\base\Component::__isset()

检查属性是否已设置，即定义且不为 null。

此方法将按以下顺序检查并相应地采取行动

  • 由 setter 定义的属性：返回属性是否已设置
  • 行为的属性：返回属性是否已设置
  • 对于不存在的属性返回 false

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 isset($component->property) 时会隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.isset.php。

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;
}
__set() 公共方法

定义于： 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);
}
__unset() 公共方法

定义于： yii\base\Component::__unset()

将组件属性设置为 null。

此方法将按以下顺序检查并相应地采取行动

  • 由 setter 定义的属性：将属性值设置为 null
  • 行为的属性：将属性值设置为 null

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 unset($component->property) 时会隐式调用。

另请参阅 https://php.ac.cn/manual/en/function.unset.php。

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);
}
actionCreate() 公共方法

创建一个新的迁移。

此命令使用可用的迁移模板创建新的迁移。使用此命令后，开发人员应通过填充实际的迁移逻辑来修改创建的迁移骨架。

yii migrate/create create_user_table

为了生成命名空间迁移，您应该在迁移名称之前指定命名空间。请注意，反斜杠 (\) 通常被认为是 shell 中的特殊字符，因此您需要正确地对其进行转义以避免 shell 错误或不正确的行为。例如

yii migrate/create app\\migrations\\createUserTable

如果未设置 $migrationPath 且未提供命名空间，则将使用 $migrationNamespaces 的第一个条目。

public void actionCreate ( $name )
$name string

新迁移的名称。这只能包含字母、数字、下划线和/或反斜杠。

注意：如果迁移名称采用特殊形式，例如 create_xxx 或 drop_xxx，则生成的迁移文件将包含额外的代码，在这种情况下用于创建/删除表。
抛出异常 yii\console\Exception

如果名称参数无效。

 

                public function actionCreate($name)
{
    if (!preg_match('/^[\w\\\\]+$/', $name)) {
        throw new Exception('The migration name should contain letters, digits, underscore and/or backslash characters only.');
    }
    list($namespace, $className) = $this->generateClassName($name);
    // Abort if name is too long
    $nameLimit = $this->getMigrationNameLimit();
    if ($nameLimit !== null && strlen($className) > $nameLimit) {
        throw new Exception('The migration name is too long.');
    }
    $migrationPath = $this->findMigrationPath($namespace);
    $file = $migrationPath . DIRECTORY_SEPARATOR . $className . '.php';
    if ($this->confirm("Create new migration '$file'?")) {
        $content = $this->generateMigrationSourceCode([
            'name' => $name,
            'className' => $className,
            'namespace' => $namespace,
        ]);
        FileHelper::createDirectory($migrationPath);
        if (file_put_contents($file, $content, LOCK_EX) === false) {
            $this->stdout("Failed to create new migration.\n", Console::FG_RED);
            return ExitCode::IOERR;
        }
        FileHelper::changeOwnership($file, $this->newFileOwnership, $this->newFileMode);
        $this->stdout("New migration created successfully.\n", Console::FG_GREEN);
    }
    return ExitCode::OK;
}
actionDown() 公共方法

通过回滚旧迁移来降级应用程序。

例如，

yii migrate/down     # revert the last migration
yii migrate/down 3   # revert the last 3 migrations
yii migrate/down all # revert all migrations
public integer actionDown ( $limit = 1 )
$limit integer|string

要回滚的迁移数量。默认为 1，表示将回滚最后应用的迁移。当值为“all”时，将回滚所有迁移。
返回值 integer

操作执行的状态。0 表示正常，其他值表示异常。
抛出异常 yii\console\Exception

如果指定的步骤数小于 1。

 

                public function actionDown($limit = 1)
{
    if ($limit === 'all') {
        $limit = null;
    } else {
        $limit = (int) $limit;
        if ($limit < 1) {
            throw new Exception('The step argument must be greater than 0.');
        }
    }
    $migrations = $this->getMigrationHistory($limit);
    if (empty($migrations)) {
        $this->stdout("No migration has been done before.\n", Console::FG_YELLOW);
        return ExitCode::OK;
    }
    $migrations = array_keys($migrations);
    $n = count($migrations);
    $this->stdout("Total $n " . ($n === 1 ? 'migration' : 'migrations') . " to be reverted:\n", Console::FG_YELLOW);
    foreach ($migrations as $migration) {
        $this->stdout("\t$migration\n");
    }
    $this->stdout("\n");
    $reverted = 0;
    if ($this->confirm('Revert the above ' . ($n === 1 ? 'migration' : 'migrations') . '?')) {
        foreach ($migrations as $migration) {
            if (!$this->migrateDown($migration)) {
                $this->stdout("\n$reverted from $n " . ($reverted === 1 ? 'migration was' : 'migrations were') . " reverted.\n", Console::FG_RED);
                $this->stdout("\nMigration failed. The rest of the migrations are canceled.\n", Console::FG_RED);
                return ExitCode::UNSPECIFIED_ERROR;
            }
            $reverted++;
        }
        $this->stdout("\n$n " . ($n === 1 ? 'migration was' : 'migrations were') . " reverted.\n", Console::FG_GREEN);
        $this->stdout("\nMigrated down successfully.\n", Console::FG_GREEN);
    }
    return ExitCode::OK;
}
actionFresh() 公共方法 (自版本 2.0.13 起可用)

删除所有表和相关的约束。从头开始迁移。

yii migrate/fresh
public void actionFresh ( )

                public function actionFresh()
{
    if (YII_ENV_PROD) {
        $this->stdout("YII_ENV is set to 'prod'.\nRefreshing migrations is not possible on production systems.\n");
        return ExitCode::OK;
    }
    if ($this->confirm("Are you sure you want to drop all tables and related constraints and start the migration from the beginning?\nAll data will be lost irreversibly!")) {
        $this->truncateDatabase();
        return $this->actionUp();
    }
    $this->stdout('Action was cancelled by user. Nothing has been performed.');
    return ExitCode::OK;
}
actionHistory() 公共方法

显示迁移历史。

此命令将显示迄今为止已应用的迁移列表。例如，

yii migrate/history     # showing the last 10 migrations
yii migrate/history 5   # showing the last 5 migrations
yii migrate/history all # showing the whole history
public void actionHistory ( $limit = 10 )
$limit integer|string

要显示的迁移的最大数量。如果为“all”，则将显示整个迁移历史记录。
抛出异常 yii\console\Exception

如果传递了无效的限制值

 

                public function actionHistory($limit = 10)
{
    if ($limit === 'all') {
        $limit = null;
    } else {
        $limit = (int) $limit;
        if ($limit < 1) {
            throw new Exception('The limit must be greater than 0.');
        }
    }
    $migrations = $this->getMigrationHistory($limit);
    if (empty($migrations)) {
        $this->stdout("No migration has been done before.\n", Console::FG_YELLOW);
    } else {
        $n = count($migrations);
        if ($limit > 0) {
            $this->stdout("Showing the last $n applied " . ($n === 1 ? 'migration' : 'migrations') . ":\n", Console::FG_YELLOW);
        } else {
            $this->stdout("Total $n " . ($n === 1 ? 'migration has' : 'migrations have') . " been applied before:\n", Console::FG_YELLOW);
        }
        foreach ($migrations as $version => $time) {
            $this->stdout("\t(" . date('Y-m-d H:i:s', $time) . ') ' . $version . "\n");
        }
    }
    return ExitCode::OK;
}
actionMark() 公共方法

将迁移历史修改为指定版本。

不会执行任何实际迁移。

yii migrate/mark 101129_185401                        # using timestamp
yii migrate/mark m101129_185401_create_user_table     # using full name
yii migrate/mark app\migrations\M101129185401CreateUser # using full namespace name
yii migrate/mark m000000_000000_base # reset the complete migration history
public integer actionMark ( $version )
$version string

应将迁移历史记录标记到的版本。这可以是时间戳或迁移的完整名称。您可以指定名称 m000000_000000_base 将迁移历史记录设置为未应用任何迁移的状态。
返回值 integer

CLI 退出代码
抛出异常 yii\console\Exception

如果版本参数无效或找不到版本。

 

                public function actionMark($version)
{
    $originalVersion = $version;
    if (($namespaceVersion = $this->extractNamespaceMigrationVersion($version)) !== false) {
        $version = $namespaceVersion;
    } elseif (($migrationName = $this->extractMigrationVersion($version)) !== false) {
        $version = $migrationName;
    } elseif ($version !== static::BASE_MIGRATION) {
        throw new Exception("The version argument must be either a timestamp (e.g. 101129_185401)\nor the full name of a migration (e.g. m101129_185401_create_user_table)\nor the full name of a namespaced migration (e.g. app\\migrations\\M101129185401CreateUserTable).");
    }
    // try mark up
    $migrations = $this->getNewMigrations();
    foreach ($migrations as $i => $migration) {
        if (strpos($migration, $version) === 0) {
            if ($this->confirm("Set migration history at $originalVersion?")) {
                for ($j = 0; $j <= $i; ++$j) {
                    $this->addMigrationHistory($migrations[$j]);
                }
                $this->stdout("The migration history is set at $originalVersion.\nNo actual migration was performed.\n", Console::FG_GREEN);
            }
            return ExitCode::OK;
        }
    }
    // try mark down
    $migrations = array_keys($this->getMigrationHistory(null));
    $migrations[] = static::BASE_MIGRATION;
    foreach ($migrations as $i => $migration) {
        if (strpos($migration, $version) === 0) {
            if ($i === 0) {
                $this->stdout("Already at '$originalVersion'. Nothing needs to be done.\n", Console::FG_YELLOW);
            } elseif ($this->confirm("Set migration history at $originalVersion?")) {
                for ($j = 0; $j < $i; ++$j) {
                    $this->removeMigrationHistory($migrations[$j]);
                }
                $this->stdout("The migration history is set at $originalVersion.\nNo actual migration was performed.\n", Console::FG_GREEN);
            }
            return ExitCode::OK;
        }
    }
    throw new Exception("Unable to find the version '$originalVersion'.");
}
actionNew() 公共方法

显示未应用的新迁移。

此命令将显示尚未应用的新迁移。例如，

yii migrate/new     # showing the first 10 new migrations
yii migrate/new 5   # showing the first 5 new migrations
yii migrate/new all # showing all new migrations
public void actionNew ( $limit = 10 )
$limit integer|string

要显示的新迁移的最大数量。如果为 all，则将显示所有可用的新迁移。
抛出异常 yii\console\Exception

如果传递了无效的限制值

 

                public function actionNew($limit = 10)
{
    if ($limit !== 'all') {
        $limit = (int) $limit;
        if ($limit < 1) {
            throw new Exception('The limit must be greater than 0.');
        }
    }
    $migrations = $this->getNewMigrations();
    if (empty($migrations)) {
        $this->stdout("No new migrations found. Your system is up-to-date.\n", Console::FG_GREEN);
    } else {
        $n = count($migrations);
        if ($limit !== 'all' && $n > $limit) {
            $migrations = array_slice($migrations, 0, $limit);
            $this->stdout("Showing $limit out of $n new " . ($n === 1 ? 'migration' : 'migrations') . ":\n", Console::FG_YELLOW);
        } else {
            $this->stdout("Found $n new " . ($n === 1 ? 'migration' : 'migrations') . ":\n", Console::FG_YELLOW);
        }
        foreach ($migrations as $migration) {
            $this->stdout("\t" . $migration . "\n");
        }
    }
    return ExitCode::OK;
}
actionRedo() 公共方法

重做最近几次迁移。

此命令将首先回滚指定的迁移，然后再次应用它们。例如，

yii migrate/redo     # redo the last applied migration
yii migrate/redo 3   # redo the last 3 applied migrations
yii migrate/redo all # redo all migrations
public integer actionRedo ( $limit = 1 )
$limit integer|string

要重做的迁移数量。默认为 1，表示将重做上次应用的迁移。当等于“all”时，将重做所有迁移。
返回值 integer

操作执行的状态。0 表示正常，其他值表示异常。
抛出异常 yii\console\Exception

如果指定的步骤数小于 1。

 

                public function actionRedo($limit = 1)
{
    if ($limit === 'all') {
        $limit = null;
    } else {
        $limit = (int) $limit;
        if ($limit < 1) {
            throw new Exception('The step argument must be greater than 0.');
        }
    }
    $migrations = $this->getMigrationHistory($limit);
    if (empty($migrations)) {
        $this->stdout("No migration has been done before.\n", Console::FG_YELLOW);
        return ExitCode::OK;
    }
    $migrations = array_keys($migrations);
    $n = count($migrations);
    $this->stdout("Total $n " . ($n === 1 ? 'migration' : 'migrations') . " to be redone:\n", Console::FG_YELLOW);
    foreach ($migrations as $migration) {
        $this->stdout("\t$migration\n");
    }
    $this->stdout("\n");
    if ($this->confirm('Redo the above ' . ($n === 1 ? 'migration' : 'migrations') . '?')) {
        foreach ($migrations as $migration) {
            if (!$this->migrateDown($migration)) {
                $this->stdout("\nMigration failed. The rest of the migrations are canceled.\n", Console::FG_RED);
                return ExitCode::UNSPECIFIED_ERROR;
            }
        }
        foreach (array_reverse($migrations) as $migration) {
            if (!$this->migrateUp($migration)) {
                $this->stdout("\nMigration failed. The rest of the migrations are canceled.\n", Console::FG_RED);
                return ExitCode::UNSPECIFIED_ERROR;
            }
        }
        $this->stdout("\n$n " . ($n === 1 ? 'migration was' : 'migrations were') . " redone.\n", Console::FG_GREEN);
        $this->stdout("\nMigration redone successfully.\n", Console::FG_GREEN);
    }
    return ExitCode::OK;
}
actionTo() 公共方法

升级或降级到指定版本。

还可以通过提供 UNIX 时间戳或 strtotime() 函数可解析的字符串，将版本降级到过去的某个应用时间。这意味着将在指定时间之后应用的所有版本都将被回滚。

此命令将首先回滚指定的迁移，然后再次应用它们。例如，

yii migrate/to 101129_185401                          # using timestamp
yii migrate/to m101129_185401_create_user_table       # using full name
yii migrate/to 1392853618                             # using UNIX timestamp
yii migrate/to "2014-02-15 13:00:50"                  # using strtotime() parseable string
yii migrate/to app\migrations\M101129185401CreateUser # using full namespace name
public void actionTo ( $version )
$version string

应用程序应迁移到的版本名称或过去的某个时间值。这可以是时间戳、迁移的完整名称、UNIX 时间戳或可解析的日期时间字符串。
抛出异常 yii\console\Exception

如果版本参数无效。

 

                public function actionTo($version)
{
    if (($namespaceVersion = $this->extractNamespaceMigrationVersion($version)) !== false) {
        return $this->migrateToVersion($namespaceVersion);
    } elseif (($migrationName = $this->extractMigrationVersion($version)) !== false) {
        return $this->migrateToVersion($migrationName);
    } elseif ((string) (int) $version == $version) {
        return $this->migrateToTime($version);
    } elseif (($time = strtotime($version)) !== false) {
        return $this->migrateToTime($time);
    } else {
        throw new Exception("The version argument must be either a timestamp (e.g. 101129_185401),\n the full name of a migration (e.g. m101129_185401_create_user_table),\n the full namespaced name of a migration (e.g. app\\migrations\\M101129185401CreateUserTable),\n a UNIX timestamp (e.g. 1392853000), or a datetime string parseable\nby the strtotime() function (e.g. 2014-02-15 13:00:50).");
    }
}
actionUp() 公共方法

通过应用新迁移来升级应用程序。

例如，

yii migrate     # apply all new migrations
yii migrate 3   # apply the first 3 new migrations
public integer actionUp ( $limit = 0 )
$limit integer

要应用的新迁移的数量。如果为 0，则表示应用所有可用的新迁移。
返回值 integer

操作执行的状态。0 表示正常，其他值表示异常。

 

                public function actionUp($limit = 0)
{
    $migrations = $this->getNewMigrations();
    if (empty($migrations)) {
        $this->stdout("No new migrations found. Your system is up-to-date.\n", Console::FG_GREEN);
        return ExitCode::OK;
    }
    $total = count($migrations);
    $limit = (int) $limit;
    if ($limit > 0) {
        $migrations = array_slice($migrations, 0, $limit);
    }
    $n = count($migrations);
    if ($n === $total) {
        $this->stdout("Total $n new " . ($n === 1 ? 'migration' : 'migrations') . " to be applied:\n", Console::FG_YELLOW);
    } else {
        $this->stdout("Total $n out of $total new " . ($total === 1 ? 'migration' : 'migrations') . " to be applied:\n", Console::FG_YELLOW);
    }
    foreach ($migrations as $migration) {
        $nameLimit = $this->getMigrationNameLimit();
        if ($nameLimit !== null && strlen($migration) > $nameLimit) {
            $this->stdout("\nThe migration name '$migration' is too long. Its not possible to apply this migration.\n", Console::FG_RED);
            return ExitCode::UNSPECIFIED_ERROR;
        }
        $this->stdout("\t$migration\n");
    }
    $this->stdout("\n");
    $applied = 0;
    if ($this->confirm('Apply the above ' . ($n === 1 ? 'migration' : 'migrations') . '?')) {
        foreach ($migrations as $migration) {
            if (!$this->migrateUp($migration)) {
                $this->stdout("\n$applied from $n " . ($applied === 1 ? 'migration was' : 'migrations were') . " applied.\n", Console::FG_RED);
                $this->stdout("\nMigration failed. The rest of the migrations are canceled.\n", Console::FG_RED);
                return ExitCode::UNSPECIFIED_ERROR;
            }
            $applied++;
        }
        $this->stdout("\n$n " . ($n === 1 ? 'migration was' : 'migrations were') . " applied.\n", Console::FG_GREEN);
        $this->stdout("\nMigrated up successfully.\n", Console::FG_GREEN);
    }
    return ExitCode::OK;
}
actions() 公共方法

定义于： 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 [];
}
addMigrationHistory() 受保护的抽象方法

将新的迁移条目添加到历史记录。

protected abstract void addMigrationHistory ( $version )
$version string

迁移版本名称。

 

                abstract protected function addMigrationHistory($version);
afterAction() 公共方法

定义于： 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;
}
ansiFormat() 公共方法

定义于： 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;
}
attachBehavior() 公共方法

定义于： 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);
}
attachBehaviors() 公共方法

定义于： 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);
    }
}
beforeAction() 公共方法

此方法在执行操作之前立即调用（在所有可能的过滤器之后）。它检查 $migrationPath 的存在。

public boolean beforeAction ( $action )
$action yii\base\Action

要执行的操作。
返回值 boolean

操作是否应该继续执行。
抛出异常 yii\base\InvalidConfigException

如果 migrationPath 中指定的目录不存在且操作不是“create”。

 

                public function beforeAction($action)
{
    if (parent::beforeAction($action)) {
        if (empty($this->migrationNamespaces) && empty($this->migrationPath)) {
            throw new InvalidConfigException('At least one of `migrationPath` or `migrationNamespaces` should be specified.');
        }
        $this->migrationNamespaces = (array) $this->migrationNamespaces;
        foreach ($this->migrationNamespaces as $key => $value) {
            $this->migrationNamespaces[$key] = trim($value, '\\');
        }
        if (is_array($this->migrationPath)) {
            foreach ($this->migrationPath as $i => $path) {
                $this->migrationPath[$i] = Yii::getAlias($path);
            }
        } elseif ($this->migrationPath !== null) {
            $path = Yii::getAlias($this->migrationPath);
            if (!is_dir($path)) {
                if ($action->id !== 'create') {
                    throw new InvalidConfigException("Migration failed. Directory specified in migrationPath doesn't exist: {$this->migrationPath}");
                }
                FileHelper::createDirectory($path);
            }
            $this->migrationPath = $path;
        }
        $version = Yii::getVersion();
        $this->stdout("Yii Migration Tool (based on Yii v{$version})\n\n");
        return true;
    }
    return false;
}
behaviors() 公共方法

定义于： yii\base\Component::behaviors()

返回此组件应表现为的行为列表。

子类可以重写此方法以指定它们希望表现出的行为。

此方法的返回值应该是一个行为对象或配置数组，按行为名称索引。行为配置可以是指定行为类的字符串，也可以是以下结构的数组：

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

请注意，行为类必须扩展自 yii\base\Behavior。可以使用名称或匿名方式附加行为。当使用名称作为数组键时，可以使用此名称，稍后可以使用 getBehavior() 检索行为，或使用 detachBehavior() 分离行为。无法检索或分离匿名行为。

在此方法中声明的行为将自动附加到组件（按需）。

public array behaviors ( )
返回值 array

行为配置。

 

                public function behaviors()
{
    return [];
}
bindActionParams() 公共方法

定义于： 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);
}
bindInjectedParams() 受保护的方法（自版本 2.0.36 起可用）

定义于： yii\base\Controller::bindInjectedParams()

根据动作方法签名中的类型和名称填充参数。

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);
    }
}
canGetProperty() 公共方法

定义于： 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;
}
canSetProperty() 公共方法

定义于： 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;
}
className() 公共静态方法
自 2.0.14 起已弃用。在 PHP >=5.5 上，请改用 ::class。

定义于： yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
confirm() 公共方法

定义于： 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;
}
createAction() 公共方法

定义于： 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;
}
createMigration() 受保护方法

创建一个新的迁移实例。

protected yii\db\MigrationInterface createMigration ( $class )
$class string

迁移类名
返回值 yii\db\MigrationInterface

迁移实例

 

                protected function createMigration($class)
{
    $this->includeMigrationFile($class);
    /** @var MigrationInterface $migration */
    $migration = Yii::createObject($class);
    if ($migration instanceof BaseObject && $migration->canSetProperty('compact')) {
        $migration->compact = $this->compact;
    }
    return $migration;
}
detachBehavior() 公共方法

定义于： yii\base\Component::detachBehavior()

从组件中分离行为。

将调用行为的 yii\base\Behavior::detach() 方法。

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;
}
detachBehaviors() 公共方法

定义于： yii\base\Component::detachBehaviors()

从组件中分离所有行为。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}
ensureBehaviors() 公共方法

定义于： 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);
        }
    }
}
findLayoutFile() 公共方法

定义于： 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;
}
generateMigrationSourceCode() 受保护方法 (自版本 2.0.8 起可用)

生成新的迁移源 PHP 代码。

子类可以重写此方法，为该过程添加额外的逻辑或变化。

protected string generateMigrationSourceCode ( $params )
$params array

生成参数，通常包含以下参数

  • name: string 迁移基本名称
  • className: string 迁移类名
返回值 string

生成的 PHP 代码。

 

                protected function generateMigrationSourceCode($params)
{
    return $this->renderFile(Yii::getAlias($this->templateFile), $params);
}
getActionArgsHelp() 公共方法

定义于： 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;
}
getActionHelp() 公共方法

定义于： yii\console\Controller::getActionHelp()

返回指定操作的详细帮助信息。

public string getActionHelp ( $action )
$action yii\base\Action

获取帮助的操作
返回值 string

指定操作的详细帮助信息。

 

                public function getActionHelp($action)
{
    return $this->parseDocCommentDetail($this->getActionMethodReflection($action));
}
getActionHelpSummary() 公共方法

定义于： 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));
}
getActionMethodReflection() 受保护方法

定义于： yii\console\Controller::getActionMethodReflection()

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];
}
getActionOptionsHelp() 公共方法

定义于： 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;
}
getBehavior() 公共方法

定义于： 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;
}
getBehaviors() 公共方法

定义于： yii\base\Component::getBehaviors()

返回附加到此组件的所有行为。

public yii\base\Behavior[] getBehaviors ( )
返回值 yii\base\Behavior[]

附加到此组件的行为列表

 

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}
getHelp() 公共方法

定义于： yii\console\Controller::getHelp()

返回此控制器的帮助信息。

您可以重写此方法以返回自定义帮助。默认实现返回从 PHPDoc 注释中检索到的帮助信息。

public string getHelp ( )

                public function getHelp()
{
    return $this->parseDocCommentDetail(new \ReflectionClass($this));
}
getHelpSummary() 公共方法

定义于： yii\console\Controller::getHelpSummary()

返回描述此控制器的单行简短摘要。

您可以重写此方法以返回自定义摘要。默认实现返回 PHPDoc 注释中的第一行。

public string getHelpSummary ( )

                public function getHelpSummary()
{
    return $this->parseDocCommentSummary(new \ReflectionClass($this));
}
getMigrationHistory() 受保护抽象方法

返回迁移历史记录。

protected abstract array getMigrationHistory ( $limit )
$limit integer|null

要返回的历史记录中的最大记录数。null 表示“无限制”。
返回值 array

迁移历史记录

 

                abstract protected function getMigrationHistory($limit);
getMigrationNameLimit() 受保护方法 (自版本 2.0.13 起可用)

返回迁移的最大名称长度。

子类可以重写此方法来定义限制。

protected integer|null getMigrationNameLimit ( )
返回值 integer|null

迁移的最大名称长度，如果没有任何限制则为 null。

 

                protected function getMigrationNameLimit()
{
    return null;
}
getModules() 公共方法

定义于： yii\base\Controller::getModules()

返回此控制器的所有祖先模块。

数组中的第一个模块是最外层的（即应用程序实例），而最后一个是最内层的。

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;
}
getNewMigrations() 受保护方法

返回尚未应用的迁移。

protected array getNewMigrations ( )
返回值 array

新迁移列表

 

                protected function getNewMigrations()
{
    $applied = [];
    foreach ($this->getMigrationHistory(null) as $class => $time) {
        $applied[trim($class, '\\')] = true;
    }
    $migrationPaths = [];
    if (is_array($this->migrationPath)) {
        foreach ($this->migrationPath as $path) {
            $migrationPaths[] = [$path, ''];
        }
    } elseif (!empty($this->migrationPath)) {
        $migrationPaths[] = [$this->migrationPath, ''];
    }
    foreach ($this->migrationNamespaces as $namespace) {
        $migrationPaths[] = [$this->getNamespacePath($namespace), $namespace];
    }
    $migrations = [];
    foreach ($migrationPaths as $item) {
        list($migrationPath, $namespace) = $item;
        if (!file_exists($migrationPath)) {
            continue;
        }
        $handle = opendir($migrationPath);
        while (($file = readdir($handle)) !== false) {
            if ($file === '.' || $file === '..') {
                continue;
            }
            $path = $migrationPath . DIRECTORY_SEPARATOR . $file;
            if (preg_match('/^(m(\d{6}_?\d{6})\D.*?)\.php$/is', $file, $matches) && is_file($path)) {
                $class = $matches[1];
                if (!empty($namespace)) {
                    $class = $namespace . '\\' . $class;
                }
                $time = str_replace('_', '', $matches[2]);
                if (!isset($applied[$class])) {
                    $migrations[$time . '\\' . $class] = $class;
                }
            }
        }
        closedir($handle);
    }
    ksort($migrations);
    return array_values($migrations);
}
getOptionValues() 公共方法

定义于： 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;
}
getPassedOptionValues() 公共方法

定义于： yii\console\Controller::getPassedOptionValues()

返回对应于传递选项的属性。

public array getPassedOptionValues ( )
返回值 array

与传递的选项对应的属性

 

                public function getPassedOptionValues()
{
    $properties = [];
    foreach ($this->_passedOptions as $property) {
        $properties[$property] = $this->$property;
    }
    return $properties;
}
getPassedOptions() 公共方法

定义于： yii\console\Controller::getPassedOptions()

返回执行期间传递的有效选项的名称。

public array getPassedOptions ( )
返回值 array

执行期间传递的选项名称

 

                public function getPassedOptions()
{
    return $this->_passedOptions;
}
getRoute() 公共方法

定义于： yii\base\Controller::getRoute()

返回当前请求的路由。

public string getRoute ( )
返回值 string

当前请求的路由（模块 ID、控制器 ID 和操作 ID）。

 

                public function getRoute()
{
    return $this->action !== null ? $this->action->getUniqueId() : $this->getUniqueId();
}
getUniqueId() 公共方法

定义于： yii\base\Controller::getUniqueId()

返回控制器的唯一 ID。

public string getUniqueId ( )
返回值 string

控制器 ID，以模块 ID（如果有）作为前缀。

 

                public function getUniqueId()
{
    return $this->module instanceof Application ? $this->id : $this->module->getUniqueId() . '/' . $this->id;
}
getView() 公共方法

定义于： 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;
}
getViewPath() 公共方法

定义于： yii\base\Controller::getViewPath()

返回包含此控制器视图文件的目录。

默认实现返回控制器 $id 下名为的目录 $module的 $viewPath 目录。

public string getViewPath ( )
返回值 string

包含此控制器视图文件的目录。

 

                public function getViewPath()
{
    if ($this->_viewPath === null) {
        $this->_viewPath = $this->module->getViewPath() . DIRECTORY_SEPARATOR . $this->id;
    }
    return $this->_viewPath;
}
hasEventHandlers() 公共方法

定义于： yii\base\Component::hasEventHandlers()

返回一个值，指示是否有任何处理程序附加到指定的事件。

public boolean 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);
}
hasMethod() 公共方法

定义于： yii\base\Component::hasMethod()

返回一个值，指示是否定义了方法。

如果定义了方法

  • 该类具有指定名称的方法
  • 附加的行为具有给定名称的方法（当$checkBehaviors为真时）。
public boolean 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;
}
hasProperty() 公共方法

定义于： yii\base\Component::hasProperty()

返回一个值，指示是否为此组件定义了属性。

如果定义了属性

  • 该类具有与指定名称关联的 getter 或 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；
  • 附加的行为具有给定名称的属性（当$checkBehaviors为真时）。

另请参阅

public boolean 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);
}
includeMigrationFile() 受保护方法（自版本 2.0.12 起可用）

包含给定迁移类名称的迁移文件。

此函数对命名空间迁移将不执行任何操作，命名空间迁移通过自动加载自动加载。它将包含迁移文件，方法是在 $migrationPath 中搜索没有命名空间的类。

protected void includeMigrationFile ( $class )
$class string

迁移类名。

 

                protected function includeMigrationFile($class)
{
    $class = trim($class, '\\');
    if (strpos($class, '\\') === false) {
        if (is_array($this->migrationPath)) {
            foreach ($this->migrationPath as $path) {
                $file = $path . DIRECTORY_SEPARATOR . $class . '.php';
                if (is_file($file)) {
                    require_once $file;
                    break;
                }
            }
        } else {
            $file = $this->migrationPath . DIRECTORY_SEPARATOR . $class . '.php';
            require_once $file;
        }
    }
}
init() 公共方法（自版本 2.0.36 起可用）

定义于： yii\base\Controller::init()

初始化对象。

此方法在构造函数结束时调用，在对象使用给定配置初始化之后。

public void init ( )

                public function init()
{
    parent::init();
    $this->request = Instance::ensure($this->request, Request::className());
    $this->response = Instance::ensure($this->response, Response::className());
}
isColorEnabled() 公共方法

定义于： yii\console\Controller::isColorEnabled()

返回一个值，指示是否启用了 ANSI 颜色。

仅当 $color 设置为 true 或未设置且终端支持 ANSI 颜色时，才会启用 ANSI 颜色。

public boolean isColorEnabled ( $stream = \STDOUT )
$stream 资源

要检查的流。
返回值 boolean

是否在输出中启用 ANSI 样式。

 

                public function isColorEnabled($stream = \STDOUT)
{
    return $this->color === null ? Console::streamSupportsAnsiColors($stream) : $this->color;
}
migrateDown() 受保护方法

使用指定的迁移类降级。

protected boolean migrateDown ( $class )
$class string

迁移类名
返回值 boolean

迁移是否成功

 

                protected function migrateDown($class)
{
    if ($class === self::BASE_MIGRATION) {
        return true;
    }
    $this->stdout("*** reverting $class\n", Console::FG_YELLOW);
    $start = microtime(true);
    $migration = $this->createMigration($class);
    if ($migration->down() !== false) {
        $this->removeMigrationHistory($class);
        $time = microtime(true) - $start;
        $this->stdout("*** reverted $class (time: " . sprintf('%.3f', $time) . "s)\n\n", Console::FG_GREEN);
        return true;
    }
    $time = microtime(true) - $start;
    $this->stdout("*** failed to revert $class (time: " . sprintf('%.3f', $time) . "s)\n\n", Console::FG_RED);
    return false;
}
migrateToTime() 受保护方法

迁移到过去指定的应用时间。

protected void migrateToTime ( $time )
$time integer

UNIX 时间戳值。

 

                protected function migrateToTime($time)
{
    $count = 0;
    $migrations = array_values($this->getMigrationHistory(null));
    while ($count < count($migrations) && $migrations[$count] > $time) {
        ++$count;
    }
    if ($count === 0) {
        $this->stdout("Nothing needs to be done.\n", Console::FG_GREEN);
    } else {
        return $this->actionDown($count);
    }
    return ExitCode::OK;
}
migrateToVersion() 受保护方法

迁移到特定版本。

受保护 整数 migrateToVersion ( $version )
$version string

完整格式的名称。
返回值 integer

CLI 退出代码
抛出异常 yii\console\Exception

如果找不到提供的版本。

 

                protected function migrateToVersion($version)
{
    $originalVersion = $version;
    // try migrate up
    $migrations = $this->getNewMigrations();
    foreach ($migrations as $i => $migration) {
        if (strpos($migration, $version) === 0) {
            return $this->actionUp($i + 1);
        }
    }
    // try migrate down
    $migrations = array_keys($this->getMigrationHistory(null));
    foreach ($migrations as $i => $migration) {
        if (strpos($migration, $version) === 0) {
            if ($i === 0) {
                $this->stdout("Already at '$originalVersion'. Nothing needs to be done.\n", Console::FG_YELLOW);
            } else {
                return $this->actionDown($i);
            }
            return ExitCode::OK;
        }
    }
    throw new Exception("Unable to find the version '$originalVersion'.");
}
migrateUp() 受保护方法

使用指定的迁移类升级。

受保护 布尔值 migrateUp ( $class )
$class string

迁移类名
返回值 boolean

迁移是否成功

 

                protected function migrateUp($class)
{
    if ($class === self::BASE_MIGRATION) {
        return true;
    }
    $this->stdout("*** applying $class\n", Console::FG_YELLOW);
    $start = microtime(true);
    $migration = $this->createMigration($class);
    if ($migration->up() !== false) {
        $this->addMigrationHistory($class);
        $time = microtime(true) - $start;
        $this->stdout("*** applied $class (time: " . sprintf('%.3f', $time) . "s)\n\n", Console::FG_GREEN);
        return true;
    }
    $time = microtime(true) - $start;
    $this->stdout("*** failed to apply $class (time: " . sprintf('%.3f', $time) . "s)\n\n", Console::FG_RED);
    return false;
}
off() 公共方法

定义于： yii\base\Component::off()

从该组件分离现有的事件处理程序。

此方法与 on() 相反。

注意：如果为事件名称传递通配符模式，则只会移除使用此通配符注册的处理程序，而使用与该通配符匹配的普通名称注册的处理程序将保留。

另请参阅 on()。

公共 布尔值 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;
}
on() 公共方法

定义于： yii\base\Component::on()

将事件处理程序附加到事件。

事件处理程序必须是有效的 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()。

公共 空 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]);
    }
}
optionAliases() 公共方法（自版本 2.0.8 起可用）

定义于： yii\console\Controller::optionAliases()

返回选项别名名称。

子类可以重写此方法以指定别名选项。

另请参阅 options()。

公共 数组 optionAliases ( )
返回值 array

对操作有效的选项别名名称，其中键是选项的别名名称，值是选项名称。

 

                public function optionAliases()
{
    return [
        'h' => 'help',
    ];
}
options() 公共方法

返回操作（id）的有效选项名称。选项需要存在一个公共成员变量，其名称为选项名称。

子类可以重写此方法以指定可能的选项。

请注意，通过选项设置的值在调用 beforeAction() 之前不可用。

公共 字符串[] options ( $actionID )
$actionID string

当前请求的操作 ID
返回值 string[]

对操作有效的选项名称

 

                public function options($actionID)
{
    return array_merge(
        parent::options($actionID),
        ['migrationPath', 'migrationNamespaces', 'compact'], // global for all actions
        $actionID === 'create' ? ['templateFile'] : [] // action create
    );
}
parseDocCommentDetail() 受保护方法

定义于： yii\console\Controller::parseDocCommentDetail()

从文档块返回完整描述。

受保护 字符串 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 '';
}
parseDocCommentSummary() 受保护方法

定义于： yii\console\Controller::parseDocCommentSummary()

返回文档块的第一行。

受保护 字符串 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 '';
}
parseDocCommentTags() 受保护方法

定义于： yii\console\Controller::parseDocCommentTags()

将注释块解析为标签。

受保护 数组 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;
}
prompt() 公共方法

定义于： yii\console\Controller::prompt()

提示用户输入并对其进行验证。

公共 字符串 prompt ( $text, $options = [] )
$text string

提示字符串
$options array

验证输入的选项

  • required：是否必填
  • default：如果用户未输入，则为默认值
  • pattern：验证用户输入的正则表达式模式
  • validator：一个可调用的函数来验证输入。该函数必须接受两个参数
    • $input：要验证的用户输入
    • $error：如果验证失败，则通过引用传递的错误值。

如何使用带有验证器函数的 prompt 方法的示例。

$code = $this->prompt('Enter 4-Chars-Pin', ['required' => true, 'validator' => function($input, &$error) {
    if (strlen($input) !== 4) {
        $error = 'The Pin must be exactly 4 chars!';
        return false;
    }
    return true;
}]);
返回值 string

用户输入

 

                public function prompt($text, $options = [])
{
    if ($this->interactive) {
        return Console::prompt($text, $options);
    }
    return isset($options['default']) ? $options['default'] : '';
}
removeMigrationHistory() 受保护的抽象方法

从历史记录中删除现有的迁移。

受保护的抽象 空 removeMigrationHistory ( $version )
$version string

迁移版本名称。

 

                abstract protected function removeMigrationHistory($version);
render() 公共方法

定义于： yii\base\Controller::render()

渲染视图并在可用时应用布局。

要渲染的视图可以用以下格式之一指定

  • 路径别名（例如 "@app/views/site/index"）；
  • 应用程序内的绝对路径（例如 "//site/index"）：视图名称以双斜杠开头。实际的视图文件将在应用程序的 视图路径 下查找。
  • 模块内的绝对路径（例如 "/site/index"）：视图名称以单个斜杠开头。实际的视图文件将在 视图路径 的 $module 下查找。
  • 相对路径（例如 "index"）：实际的视图文件将在 $viewPath 下查找。

要确定应用哪个布局，将执行以下两个步骤

  1. 第一步，确定布局名称和上下文模块
  • 如果 $layout 指定为字符串，则将其用作布局名称，并将 $module 用作上下文模块；
  • 如果 $layout 为 null，则遍历此控制器的所有祖先模块，并找到第一个 layout 不为 null 的模块。布局和相应的模块分别用作布局名称和上下文模块。如果找不到这样的模块或相应的布局不是字符串，则返回 false，表示没有适用的布局。
  1. 第二步，根据之前找到的布局名称和上下文模块确定实际的布局文件。布局名称可以是
  • 路径别名（例如 "@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);
}
renderContent() 公共方法（自版本 2.0.1 起可用）

定义于： yii\base\Controller::renderContent()

通过应用布局渲染静态字符串。

public string renderContent ( $content )
$content string

正在渲染的静态字符串
返回值 string

带有给定静态字符串作为 $content 变量的布局的渲染结果。如果禁用布局，则会将字符串返回。

 

                public function renderContent($content)
{
    $layoutFile = $this->findLayoutFile($this->getView());
    if ($layoutFile !== false) {
        return $this->getView()->renderFile($layoutFile, ['content' => $content], $this);
    }
    return $content;
}
renderFile() 公共方法

定义于： 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);
}
renderPartial() 公共方法

定义于： yii\base\Controller::renderPartial()

渲染视图而不应用布局。

此方法与 render() 不同，因为它不应用任何布局。

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);
}
run() 公共方法

定义于： 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);
}
runAction() 公共方法

定义于： 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);
}
select() 公共方法

定义于： yii\console\Controller::select()

让用户选择一个选项。输入“？”将显示可供选择的选项列表及其说明。

public string select ( $prompt, $options = [], $default = null )
$prompt string

提示信息
$options array

要从中选择的选项的键值对数组
$default string|null

用户未提供选项时要使用的值。如果默认值为 null，则要求用户选择一个选项。
返回值 string

用户选择的选项字符
版本 描述
2.0.49 添加了 $default 参数 

                public function select($prompt, $options = [], $default = null)
{
    if ($this->interactive) {
        return Console::select($prompt, $options, $default);
    }
    return $default;
}
setView() 公共方法

定义于： yii\base\Controller::setView()

设置此控制器要使用的视图对象。

public void setView ( $view )
$view yii\base\View|yii\web\View

可用于渲染视图或视图文件的视图对象。

 

                public function setView($view)
{
    $this->_view = $view;
}
setViewPath() 公共方法（自版本 2.0.7 起可用）

定义于： yii\base\Controller::setViewPath()

设置包含视图文件的目录。

public void setViewPath ( $path )
$path string

视图文件的根目录。
抛出异常 yii\base\InvalidArgumentException

如果目录无效

 

                public function setViewPath($path)
{
    $this->_viewPath = Yii::getAlias($path);
}
stderr() 公共方法

定义于： yii\console\Controller::stderr()

将字符串打印到 STDERR。

您可以选择使用 yii\helpers\Console 中定义的常量通过传递其他参数来使用 ANSI 代码格式化字符串。

示例

$this->stderr('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public 整数|布尔值 stderr ( $string )
$string string

要打印的字符串
返回值 整数|布尔值

打印的字节数或错误时的 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);
}
stdout() 公共方法

定义于： yii\console\Controller::stdout()

将字符串打印到 STDOUT。

您可以选择使用 yii\helpers\Console 中定义的常量通过传递其他参数来使用 ANSI 代码格式化字符串。

示例

$this->stdout('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public 整数|布尔值 stdout ( $string )
$string string

要打印的字符串
返回值 整数|布尔值

打印的字节数或错误时的 false

 

                public function stdout($string)
{
    if ($this->isColorEnabled()) {
        $args = func_get_args();
        array_shift($args);
        $string = Console::ansiFormat($string, $args);
    }
    return Console::stdout($string);
}
trigger() 公共方法

定义于： yii\base\Component::trigger()

触发事件。

此方法表示事件的发生。它调用事件的所有附加处理程序，包括类级处理程序。

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);
}
truncateDatabase() 受保护的方法 (自版本 2.0.13 起可用)

截断数据库。

此方法应在子类中被覆盖以实现清除数据库的任务。

protected void truncateDatabase ( )
抛出异常 yii\base\NotSupportedException

如果未覆盖

 

                protected function truncateDatabase()
{
    throw new NotSupportedException('This command is not implemented in ' . get_class($this));
}