類別 yii\console\controllers\MigrateController
管理應用程式遷移。
遷移是指對應用程式環境的一組持久性變更,這些變更在不同的開發人員之間共享。例如,在由資料庫支援的應用程式中,遷移可能指的是對資料庫的一組變更,例如建立新表格、新增新的表格欄位。
此命令提供追蹤遷移歷史、使用遷移升級或降級以及建立新遷移骨架的支援。
遷移歷史記錄儲存在名為 $migrationTable 的資料庫表格中。如果表格不存在,則在首次執行此命令時將自動建立表格。您也可以手動建立它,如下所示
CREATE TABLE migration (
version varchar(180) PRIMARY KEY,
apply_time integer
)
以下是一些此命令的常用用法
# creates a new migration named 'create_user_table'
yii migrate/create create_user_table
# applies ALL new migrations
yii migrate
# reverts the last applied migration
yii migrate/down
自 2.0.10 版本起,您可以使用命名空間遷移。為了啟用此功能,您應該在應用程式配置中為控制器配置 $migrationNamespaces 屬性
return [
'controllerMap' => [
'migrate' => [
'class' => 'yii\console\controllers\MigrateController',
'migrationNamespaces' => [
'app\migrations',
'some\extension\migrations',
],
//'migrationPath' => null, // allows to disable not namespaced migration completely
],
],
];
公開屬性
公共方法
受保護方法
事件
事件 | 類型 | 描述 | 定義於 |
---|---|---|---|
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 |
MAX_NAME_LENGTH | 180 | 遷移名稱的最大長度。 | yii\console\controllers\MigrateController |
屬性詳細資訊
在套用遷移時要使用的 DB 連線物件或 DB 連線的應用程式元件 ID。從 2.0.3 版本開始,這也可以是用於建立物件的組態陣列。
用於建立遷移程式碼的欄位定義字串。
每個定義的格式為 COLUMN_NAME:COLUMN_TYPE:COLUMN_DECORATOR
。分隔符號為 ,
。例如,--fields="name:string(12):notNull:unique"
會產生大小為 12 的字串欄位,該欄位不可為 null 且值為唯一。
注意:主鍵會自動新增,預設名稱為 id。如果您想使用另一個名稱,您可以明確指定它,例如 --fields="id_key:primaryKey,name:string(12):notNull:unique"
一組用於自動產生遷移程式碼的範本路徑。
鍵是範本類型,值是路徑或別名。支援的類型為
create_table
:表格建立範本drop_table
:表格捨棄範本add_column
:新增欄位範本drop_column
:捨棄欄位範本create_junction
:建立連接範本
'create_table' => '@yii/views/createTableMigration.php',
'drop_table' => '@yii/views/dropTableMigration.php',
'add_column' => '@yii/views/addColumnMigration.php',
'drop_column' => '@yii/views/dropColumnMigration.php',
'create_junction' => '@yii/views/createTableMigration.php',
]
用於產生新遷移的範本檔案。這可以是 路徑別名 (例如 "@app/migrations/template.php") 或檔案路徑。
指示產生的表格名稱是否應考慮 DB 連線的 tablePrefix
設定。例如,如果表格名稱為 post
,產生器將傳回 {{%post}}
。
方法詳細資訊
定義於: yii\base\Component::__call()
呼叫非類別方法的具名方法。
此方法將檢查是否有任何附加的行為具有具名方法,如果有的話,將執行該方法。
請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在呼叫未知方法時隱式呼叫。
public mixed __call ( $name, $params ) | ||
$name | string |
方法名稱 |
$params | array |
方法參數 |
return | mixed |
方法傳回值 |
---|---|---|
throws | 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 |
屬性名稱 |
return | mixed |
屬性值或行為的屬性值 |
---|---|---|
throws | yii\base\UnknownPropertyException |
如果未定義屬性 |
throws | 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 |
屬性名稱或事件名稱 |
return | 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 |
屬性值 |
throws | yii\base\UnknownPropertyException |
如果未定義屬性 |
---|---|---|
throws | 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 |
屬性名稱 |
throws | 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);
}
定義於: yii\console\controllers\BaseMigrateController::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,則產生的遷移檔案將包含額外的程式碼,在此情況下用於建立/刪除資料表。 |
throws | yii\console\Exception |
如果 name 參數無效。 |
---|
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;
}
定義於: yii\console\controllers\BaseMigrateController::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" 時,將還原所有遷移。 |
return | integer |
動作執行的狀態。0 表示正常,其他值表示異常。 |
---|---|---|
throws | 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;
}
定義於: yii\console\controllers\BaseMigrateController::actionFresh()
捨棄所有表格和相關約束。從頭開始遷移。
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;
}
定義於: yii\console\controllers\BaseMigrateController::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",將顯示整個遷移歷史記錄。 |
throws | yii\console\Exception |
如果傳遞了無效的 limit 值 |
---|
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;
}
定義於: yii\console\controllers\BaseMigrateController::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 |
應標記遷移歷史記錄的版本。這可以是時間戳記或遷移的完整名稱。您可以指定名稱 |
return | integer |
CLI 退出代碼 |
---|---|---|
throws | yii\console\Exception |
如果 version 參數無效或找不到該版本。 |
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'.");
}
定義於: yii\console\controllers\BaseMigrateController::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 |
要顯示的最大新遷移數量。如果為 |
throws | yii\console\Exception |
如果傳遞了無效的 limit 值 |
---|
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;
}
定義於: yii\console\controllers\BaseMigrateController::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" 時,將重做所有遷移。 |
return | integer |
動作執行的狀態。0 表示正常,其他值表示異常。 |
---|---|---|
throws | 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;
}
定義於: yii\console\controllers\BaseMigrateController::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 時間戳記或可解析的日期時間字串。 |
throws | yii\console\Exception |
如果 version 參數無效。 |
---|
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).");
}
}
定義於: yii\console\controllers\BaseMigrateController::actionUp()
透過套用新遷移來升級應用程式。
例如,
yii migrate # apply all new migrations
yii migrate 3 # apply the first 3 new migrations
public integer actionUp ( $limit = 0 ) | ||
$limit | integer |
要套用的新遷移數量。如果為 0,則表示套用所有可用的新遷移。 |
return | 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;
}
定義於: 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 [];
}
如果未指定主鍵,則將預設主鍵新增至欄位列表。
protected void addDefaultPrimaryKey ( &$fields ) | ||
$fields | array |
已剖析的欄位 |
protected function addDefaultPrimaryKey(&$fields)
{
foreach ($fields as $field) {
if ($field['property'] === 'id' || false !== strripos($field['decorators'], 'primarykey()')) {
return;
}
}
array_unshift($fields, ['property' => 'id', 'decorators' => 'primaryKey()']);
}
將新的遷移項目新增至歷史記錄。
protected void addMigrationHistory ( $version ) | ||
$version | string |
遷移版本名稱。 |
protected function addMigrationHistory($version)
{
$command = $this->db->createCommand();
$command->insert($this->migrationTable, [
'version' => $version,
'apply_time' => time(),
])->execute();
}
定義於: 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 |
動作傳回結果。 |
return | 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 |
行為組態。這可以是下列其中之一
|
return | 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);
}
}
此方法在動作即將執行前(在所有可能的篩選器之後)立即呼叫。它會檢查 $migrationPath 的存在。
public boolean beforeAction ( $action ) | ||
$action | yii\base\Action |
要執行的動作。 |
return | boolean |
動作是否應繼續執行。 |
---|
public function beforeAction($action)
{
if (parent::beforeAction($action)) {
$this->db = Instance::ensure($this->db, Connection::className());
return true;
}
return false;
}
定義於: yii\base\Component::behaviors()
傳回此元件應表現為的行為列表。
子類別可以覆寫此方法,以指定它們想要表現的行為。
此方法的傳回值應該是以行為名稱索引的行為物件或組態陣列。行為組態可以是指定行為類別的字串,或是具有以下結構的陣列
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
請注意,行為類別必須從 yii\base\Behavior 擴展。行為可以使用名稱或匿名方式附加。當使用名稱作為陣列鍵時,使用此名稱,稍後可以使用 getBehavior() 檢索行為,或使用 detachBehavior() 分離行為。匿名行為無法檢索或分離。
在此方法中宣告的行為將自動(按需)附加到組件。
public array behaviors ( ) | ||
return | array |
行為組態。 |
---|
public function behaviors()
{
return [];
}
定義於: yii\console\Controller::bindActionParams()
將參數繫結到動作。
當 yii\base\Action 開始使用給定的參數執行時,將會呼叫此方法。此方法將首先將參數與動作可用的 options 綁定。然後它會驗證給定的引數。
public array bindActionParams ( $action, $params ) | ||
$action | yii\base\Action |
要與參數綁定的動作 |
$params | array |
要綁定到動作的參數 |
return | array |
動作可以執行的有效參數。 |
---|---|---|
throws | 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()
根據動作方法簽名中的類型和名稱填寫參數。
protected void bindInjectedParams ( ReflectionType $type, $name, &$args, &$requestedParams ) | ||
$type | ReflectionType |
動作參數的反射型別。 |
$name | string |
參數的名稱。 |
$args | array |
動作的引數陣列,此函數可能會將項目附加到其中。 |
$requestedParams | array |
具有請求參數的陣列,此函數可能會將特定鍵寫入其中。 |
throws | yii\base\ErrorException |
當我們無法載入所需的服務時。 |
---|---|---|
throws | yii\base\InvalidConfigException |
當 DI 組態中存在錯誤時拋出。 |
throws | 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 |
是否將行為的屬性視為此組件的屬性 |
return | 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 |
是否將行為的屬性視為此組件的屬性 |
return | 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 ( ) | ||
return | 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 |
如果沒有做出選擇,則會傳回此值。 |
return | 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。 |
return | 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;
}
建立新的遷移實例。
protected yii\db\Migration createMigration ( $class ) | ||
$class | string |
遷移類別名稱 |
return | yii\db\Migration |
遷移實例 |
---|
protected function createMigration($class)
{
$this->includeMigrationFile($class);
return Yii::createObject([
'class' => $class,
'db' => $this->db,
'compact' => $this->compact,
]);
}
建立遷移歷史記錄表格。
protected void createMigrationHistoryTable ( ) |
protected function createMigrationHistoryTable()
{
$tableName = $this->db->schema->getRawTableName($this->migrationTable);
$this->stdout("Creating migration history table \"$tableName\"...", Console::FG_YELLOW);
$this->db->createCommand()->createTable($this->migrationTable, [
'version' => 'varchar(' . static::MAX_NAME_LENGTH . ') NOT NULL PRIMARY KEY',
'apply_time' => 'integer',
])->execute();
$this->db->createCommand()->insert($this->migrationTable, [
'version' => self::BASE_MIGRATION,
'apply_time' => time(),
])->execute();
$this->stdout("Done.\n", Console::FG_GREEN);
}
public yii\base\Behavior|null detachBehavior ( $name ) | ||
$name | string |
行為的名稱。 |
return | 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 |
要渲染版面配置檔案的視圖物件。 |
return | string|boolean |
版面配置檔案路徑,或如果不需要版面配置則為 false。請參考 render() 了解如何指定此參數。 |
---|---|---|
throws | 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;
}
產生新的遷移原始碼 PHP 程式碼。
子類別可以覆寫此方法,為流程新增額外的邏輯或變化。
protected string generateMigrationSourceCode ( $params ) | ||
$params | array |
產生參數,通常存在以下參數
|
return | string |
產生的 PHP 程式碼。 |
---|
protected function generateMigrationSourceCode($params)
{
$parsedFields = $this->parseFields();
$fields = $parsedFields['fields'];
$foreignKeys = $parsedFields['foreignKeys'];
$name = $params['name'];
if ($params['namespace']) {
$name = substr($name, (strrpos($name, '\\') ?: -1) + 1);
}
$templateFile = $this->templateFile;
$table = null;
if (preg_match('/^create_?junction_?(?:table)?_?(?:for)?(.+)_?and(.+)_?tables?$/i', $name, $matches)) {
$templateFile = $this->generatorTemplateFiles['create_junction'];
$firstTable = $this->normalizeTableName($matches[1]);
$secondTable = $this->normalizeTableName($matches[2]);
$fields = array_merge(
[
[
'property' => $firstTable . '_id',
'decorators' => 'integer()',
],
[
'property' => $secondTable . '_id',
'decorators' => 'integer()',
],
],
$fields,
[
[
'property' => 'PRIMARY KEY(' .
$firstTable . '_id, ' .
$secondTable . '_id)',
],
]
);
$foreignKeys[$firstTable . '_id']['table'] = $firstTable;
$foreignKeys[$secondTable . '_id']['table'] = $secondTable;
$foreignKeys[$firstTable . '_id']['column'] = null;
$foreignKeys[$secondTable . '_id']['column'] = null;
$table = $firstTable . '_' . $secondTable;
} elseif (preg_match('/^add(.+)columns?_?to(.+)table$/i', $name, $matches)) {
$templateFile = $this->generatorTemplateFiles['add_column'];
$table = $this->normalizeTableName($matches[2]);
} elseif (preg_match('/^drop(.+)columns?_?from(.+)table$/i', $name, $matches)) {
$templateFile = $this->generatorTemplateFiles['drop_column'];
$table = $this->normalizeTableName($matches[2]);
} elseif (preg_match('/^create(.+)table$/i', $name, $matches)) {
$this->addDefaultPrimaryKey($fields);
$templateFile = $this->generatorTemplateFiles['create_table'];
$table = $this->normalizeTableName($matches[1]);
} elseif (preg_match('/^drop(.+)table$/i', $name, $matches)) {
$this->addDefaultPrimaryKey($fields);
$templateFile = $this->generatorTemplateFiles['drop_table'];
$table = $this->normalizeTableName($matches[1]);
}
foreach ($foreignKeys as $column => $foreignKey) {
$relatedColumn = $foreignKey['column'];
$relatedTable = $foreignKey['table'];
// Since 2.0.11 if related column name is not specified,
// we're trying to get it from table schema
// @see https://github.com/yiisoft/yii2/issues/12748
if ($relatedColumn === null) {
$relatedColumn = 'id';
try {
$this->db = Instance::ensure($this->db, Connection::className());
$relatedTableSchema = $this->db->getTableSchema($relatedTable);
if ($relatedTableSchema !== null) {
$primaryKeyCount = count($relatedTableSchema->primaryKey);
if ($primaryKeyCount === 1) {
$relatedColumn = $relatedTableSchema->primaryKey[0];
} elseif ($primaryKeyCount > 1) {
$this->stdout("Related table for field \"{$column}\" exists, but primary key is composite. Default name \"id\" will be used for related field\n", Console::FG_YELLOW);
} elseif ($primaryKeyCount === 0) {
$this->stdout("Related table for field \"{$column}\" exists, but does not have a primary key. Default name \"id\" will be used for related field.\n", Console::FG_YELLOW);
}
}
} catch (\ReflectionException $e) {
$this->stdout("Cannot initialize database component to try reading referenced table schema for field \"{$column}\". Default name \"id\" will be used for related field.\n", Console::FG_YELLOW);
}
}
$foreignKeys[$column] = [
'idx' => $this->generateTableName("idx-$table-$column"),
'fk' => $this->generateTableName("fk-$table-$column"),
'relatedTable' => $this->generateTableName($relatedTable),
'relatedColumn' => $relatedColumn,
];
}
return $this->renderFile(Yii::getAlias($templateFile), array_merge($params, [
'table' => $this->generateTableName($table),
'fields' => $fields,
'foreignKeys' => $foreignKeys,
'tableComment' => $this->comment,
]));
}
如果 useTablePrefix
等於 true,則表格名稱將包含前綴格式。
protected string generateTableName ( $tableName ) | ||
$tableName | string |
要產生的資料表名稱。 |
protected function generateTableName($tableName)
{
if (!$this->useTablePrefix) {
return $tableName;
}
return '{{%' . $tableName . '}}';
}
定義於: yii\console\Controller::getActionArgsHelp()
傳回動作的匿名引數的說明資訊。
傳回值應為陣列。鍵名是引數名稱,值是相應的說明資訊。每個值都必須是以下結構的陣列
- required: bool,此引數是否為必要項
- type: string|null,此引數的 PHP 類型
- default: mixed,此引數的預設值
- comment: string,此引數的描述
預設實作將傳回從對應於動作方法的參數的 Reflection 或 DocBlock 中提取的說明資訊。
public array getActionArgsHelp ( $action ) | ||
$action | yii\base\Action |
動作實例 |
return | 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 |
要取得說明的動作 |
return | string |
指定動作的詳細說明資訊。 |
---|
public function getActionHelp($action)
{
return $this->parseDocCommentDetail($this->getActionMethodReflection($action));
}
定義於: yii\console\Controller::getActionHelpSummary()
傳回描述指定動作的單行簡短摘要。
public string getActionHelpSummary ( $action ) | ||
$action | yii\base\Action |
要取得摘要的動作 |
return | 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,此引數的註解
預設實作將傳回從對應於動作選項的屬性的 doc-comment 中提取的說明資訊。
public array getActionOptionsHelp ( $action ) | ||
$action | yii\base\Action | |
return | 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 |
行為名稱 |
return | 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 ( ) | ||
return | 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));
}
傳回遷移歷史記錄。
protected array getMigrationHistory ( $limit ) | ||
$limit | integer|null |
要傳回的歷史記錄中的最大記錄數。 |
return | array |
遷移歷史記錄 |
---|
protected function getMigrationHistory($limit)
{
if ($this->db->schema->getTableSchema($this->migrationTable, true) === null) {
$this->createMigrationHistoryTable();
}
$query = (new Query())
->select(['version', 'apply_time'])
->from($this->migrationTable)
->orderBy(['apply_time' => SORT_DESC, 'version' => SORT_DESC]);
if (empty($this->migrationNamespaces)) {
$query->limit($limit);
$rows = $query->all($this->db);
$history = ArrayHelper::map($rows, 'version', 'apply_time');
unset($history[self::BASE_MIGRATION]);
return $history;
}
$rows = $query->all($this->db);
$history = [];
foreach ($rows as $key => $row) {
if ($row['version'] === self::BASE_MIGRATION) {
continue;
}
if (preg_match('/m?(\d{6}_?\d{6})(\D.*)?$/is', $row['version'], $matches)) {
$time = str_replace('_', '', $matches[1]);
$row['canonicalVersion'] = $time;
} else {
$row['canonicalVersion'] = $row['version'];
}
$row['apply_time'] = (int) $row['apply_time'];
$history[] = $row;
}
usort($history, function ($a, $b) {
if ($a['apply_time'] === $b['apply_time']) {
if (($compareResult = strcasecmp($b['canonicalVersion'], $a['canonicalVersion'])) !== 0) {
return $compareResult;
}
return strcasecmp($b['version'], $a['version']);
}
return ($a['apply_time'] > $b['apply_time']) ? -1 : +1;
});
$history = array_slice($history, 0, $limit);
$history = ArrayHelper::map($history, 'version', 'apply_time');
return $history;
}
傳回遷移名稱的最大名稱長度。
子類別可以覆寫此方法以定義限制。
protected integer|null getMigrationNameLimit ( ) | ||
return | integer|null |
遷移的最大名稱長度,如果沒有限制則為 |
---|
protected function getMigrationNameLimit()
{
if ($this->_migrationNameLimit !== null) {
return $this->_migrationNameLimit;
}
$tableSchema = $this->db->schema ? $this->db->schema->getTableSchema($this->migrationTable, true) : null;
if ($tableSchema !== null) {
return $this->_migrationNameLimit = $tableSchema->columns['version']->size;
}
return static::MAX_NAME_LENGTH;
}
public yii\base\Module[] getModules ( ) | ||
return | 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;
}
protected array getNewMigrations ( ) | ||
return | 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);
}
定義於: yii\console\Controller::getOptionValues()
傳回與動作 ID 的選項相對應的屬性。子類別可以覆寫此方法以指定可能的屬性。
public array getOptionValues ( $actionID ) | ||
$actionID | string |
當前請求的動作 ID |
return | 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 ( ) | ||
return | array |
對應於已傳遞選項的屬性 |
---|
public function getPassedOptionValues()
{
$properties = [];
foreach ($this->_passedOptions as $property) {
$properties[$property] = $this->$property;
}
return $properties;
}
定義於: yii\console\Controller::getPassedOptions()
傳回執行期間傳遞的有效選項名稱。
public array getPassedOptions ( ) | ||
return | array |
執行期間傳遞的選項名稱 |
---|
public function getPassedOptions()
{
return $this->_passedOptions;
}
定義於: yii\base\Controller::getRoute()
傳回目前請求的路由。
public string getRoute ( ) | ||
return | string |
目前請求的路由(模組 ID、控制器 ID 和動作 ID)。 |
---|
public function getRoute()
{
return $this->action !== null ? $this->action->getUniqueId() : $this->getUniqueId();
}
定義於: yii\base\Controller::getUniqueId()
傳回控制器的唯一 ID。
public string getUniqueId ( ) | ||
return | string |
以模組 ID(如果有的話)作為前綴的控制器 ID。 |
---|
public function getUniqueId()
{
return $this->module instanceof Application ? $this->id : $this->module->getUniqueId() . '/' . $this->id;
}
Defined in: yii\base\Controller::getView()
傳回可用於呈現視圖或視圖檔案的視圖物件。
render()、renderPartial() 和 renderFile() 方法將會使用此視圖物件來實作實際的視圖渲染。若未設定,則預設為 "view" 應用程式元件。
public yii\base\View|yii\web\View getView ( ) | ||
return | yii\base\View|yii\web\View |
可用於呈現視圖或視圖檔案的視圖物件。 |
---|
public function getView()
{
if ($this->_view === null) {
$this->_view = Yii::$app->getView();
}
return $this->_view;
}
Defined in: yii\base\Controller::getViewPath()
傳回包含此控制器視圖檔案的目錄。
public string getViewPath ( ) | ||
return | string |
包含此控制器視圖檔案的目錄。 |
---|
public function getViewPath()
{
if ($this->_viewPath === null) {
$this->_viewPath = $this->module->getViewPath() . DIRECTORY_SEPARATOR . $this->id;
}
return $this->_viewPath;
}
Defined in: yii\base\Component::hasEventHandlers()
傳回值,指示是否有名稱事件的任何處理常式附加。
public boolean hasEventHandlers ( $name ) | ||
$name | string |
事件名稱 |
return | 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);
}
Defined in: yii\base\Component::hasMethod()
傳回值,指示是否已定義方法。
若符合下列條件,則方法被定義:
- 類別具有指定名稱的方法
- 附加的行為具有給定名稱的方法(當
$checkBehaviors
為 true 時)。
public boolean hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkBehaviors | boolean |
是否將行為的方法視為此元件的方法 |
return | 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;
}
Defined in: yii\base\Component::hasProperty()
傳回值,指示是否為此元件定義了屬性。
若符合下列條件,則屬性被定義:
- 類別具有與指定名稱相關聯的 getter 或 setter 方法(在此情況下,屬性名稱不區分大小寫);
- 該類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時); - 附加的行為具有給定名稱的屬性(當
$checkBehaviors
為 true 時)。
參見
public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
屬性名稱 |
$checkVars | boolean |
是否將成員變數視為屬性 |
$checkBehaviors | boolean |
是否將行為的屬性視為此組件的屬性 |
return | boolean |
判斷屬性是否被定義 |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
Defined in: yii\console\controllers\BaseMigrateController::includeMigrationFile()
包含給定遷移類別名稱的遷移檔案。
此函式在命名空間遷移中不會執行任何操作,命名空間遷移會由自動載入自動載入。它將包含遷移檔案,方法是在 $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;
}
}
}
public void init ( ) |
public function init()
{
parent::init();
$this->request = Instance::ensure($this->request, Request::className());
$this->response = Instance::ensure($this->response, Response::className());
}
Defined in: yii\console\Controller::isColorEnabled()
傳回值,指示是否已啟用 ANSI 彩色。
只有在 $color 設定為 true,或未設定且終端機支援 ANSI 彩色時,才會啟用 ANSI 彩色。
public boolean isColorEnabled ( $stream = \STDOUT ) | ||
$stream | resource |
要檢查的串流。 |
return | boolean |
判斷是否在輸出中啟用 ANSI 樣式。 |
---|
public function isColorEnabled($stream = \STDOUT)
{
return $this->color === null ? Console::streamSupportsAnsiColors($stream) : $this->color;
}
Defined in: yii\console\controllers\BaseMigrateController::migrateDown()
使用指定的遷移類別降級。
protected boolean migrateDown ( $class ) | ||
$class | string |
遷移類別名稱 |
return | 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;
}
Defined in: yii\console\controllers\BaseMigrateController::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;
}
Defined in: yii\console\controllers\BaseMigrateController::migrateToVersion()
遷移到特定版本。
protected integer migrateToVersion ( $version ) | ||
$version | string |
完整格式的名稱。 |
return | integer |
CLI 退出代碼 |
---|---|---|
throws | 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'.");
}
Defined in: yii\console\controllers\BaseMigrateController::migrateUp()
使用指定的遷移類別升級。
protected boolean migrateUp ( $class ) | ||
$class | string |
遷移類別名稱 |
return | 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;
}
Defined in: yii\base\Component::off()
從此元件分離現有的事件處理常式。
此方法與 on() 方法相反。
注意:如果為事件名稱傳遞了萬用字元模式,則只會移除以此萬用字元註冊的處理器,而以符合此萬用字元的純文字名稱註冊的處理器將會保留。
另請參閱 on()。
public boolean off ( $name, $handler = null ) | ||
$name | string |
事件名稱 |
$handler | callable|null |
要移除的事件處理器。如果為 null,則會移除附加到具名事件的所有處理器。 |
return | 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;
}
Defined in: 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()。
public void on ( $name, $handler, $data = null, $append = true ) | ||
$name | string |
事件名稱 |
$handler | callable |
事件處理器 |
$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 ( ) | ||
return | array |
適用於動作的選項別名名稱,其中鍵是選項的別名名稱,值是選項名稱。 |
---|
public function optionAliases()
{
return array_merge(parent::optionAliases(), [
'C' => 'comment',
'f' => 'fields',
'p' => 'migrationPath',
't' => 'migrationTable',
'F' => 'templateFile',
'P' => 'useTablePrefix',
'c' => 'compact',
]);
}
傳回動作 (id) 的有效選項名稱。選項需要存在一個公用成員變數,其名稱為選項名稱。
子類別可以覆寫此方法以指定可能的選項。
請注意,透過選項設定的值在 beforeAction() 被呼叫之前都不可用。
public string[] options ( $actionID ) | ||
$actionID | string |
當前請求的動作 ID |
return | string[] |
適用於動作的選項名稱 |
---|
public function options($actionID)
{
return array_merge(
parent::options($actionID),
['migrationTable', 'db'], // global for all actions
$actionID === 'create'
? ['templateFile', 'fields', 'useTablePrefix', 'comment']
: []
);
}
Defined in: yii\console\Controller::parseDocCommentDetail()
從 docblock 傳回完整描述。
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 '';
}
Defined in: yii\console\Controller::parseDocCommentSummary()
傳回 docblock 的第一行。
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 '';
}
Defined in: yii\console\Controller::parseDocCommentTags()
將註解區塊剖析為標籤。
protected array parseDocCommentTags ( $reflection ) | ||
$reflection | ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract |
註解區塊 |
return | 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;
}
剖析命令列遷移欄位。
protected array parseFields ( ) | ||
return | array |
剖析結果,包含以下欄位
|
---|
protected function parseFields()
{
$fields = [];
$foreignKeys = [];
foreach ($this->fields as $index => $field) {
$chunks = $this->splitFieldIntoChunks($field);
$property = array_shift($chunks);
foreach ($chunks as $i => &$chunk) {
if (strncmp($chunk, 'foreignKey', 10) === 0) {
preg_match('/foreignKey\((\w*)\s?(\w*)\)/', $chunk, $matches);
$foreignKeys[$property] = [
'table' => isset($matches[1])
? $matches[1]
: preg_replace('/_id$/', '', $property),
'column' => !empty($matches[2])
? $matches[2]
: null,
];
unset($chunks[$i]);
continue;
}
if (!preg_match('/^(.+?)\(([^(]+)\)$/', $chunk)) {
$chunk .= '()';
}
}
$fields[] = [
'property' => $property,
'decorators' => implode('->', $chunks),
];
}
return [
'fields' => $fields,
'foreignKeys' => $foreignKeys,
];
}
Defined in: yii\console\Controller::prompt()
提示使用者輸入並驗證它。
public string prompt ( $text, $options = [] ) | ||
$text | string |
提示字串 |
$options | array |
驗證輸入的選項
如何使用帶有驗證器函式的 prompt 方法的範例。
|
return | string |
使用者輸入 |
---|
public function prompt($text, $options = [])
{
if ($this->interactive) {
return Console::prompt($text, $options);
}
return isset($options['default']) ? $options['default'] : '';
}
從歷史記錄中移除現有的遷移。
protected void removeMigrationHistory ( $version ) | ||
$version | string |
遷移版本名稱。 |
protected function removeMigrationHistory($version)
{
$command = $this->db->createCommand();
$command->delete($this->migrationTable, [
'version' => $version,
])->execute();
}
Defined in: 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 |
應該在視圖中提供的參數(名稱-值組)。這些參數在版面配置中將不可用。 |
return | string |
渲染結果。 |
---|---|---|
throws | 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 |
正在渲染的靜態字串 |
return | 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 |
應該在視圖中可用的參數(名稱-值 對)。 |
return | string |
渲染結果。 |
---|---|---|
throws | 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 |
應該在視圖中可用的參數(名稱-值 對)。 |
return | string |
渲染結果。 |
---|---|---|
throws | 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 |
要傳遞給動作的參數。 |
return | 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 |
要傳遞給動作的參數(名稱-值 對)。 |
return | integer |
動作執行的狀態。0 表示正常,其他值表示異常。 |
---|---|---|
throws | yii\base\InvalidRouteException |
如果請求的動作 ID 無法成功解析為動作。 |
throws | 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);
}
定義於: yii\console\Controller::select()
讓使用者選擇選項。輸入 '?' 將顯示可供選擇的選項列表及其說明。
public string select ( $prompt, $options = [], $default = null ) | ||
$prompt | string |
提示訊息 |
$options | array |
要從中選擇的選項的鍵值陣列 |
$default | string|null |
當使用者未提供選項時要使用的值。如果預設值為 |
return | 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 |
視圖檔案的根目錄。 |
throws | yii\base\InvalidArgumentException |
如果目錄無效 |
---|
public function setViewPath($path)
{
$this->_viewPath = Yii::getAlias($path);
}
將欄位分割成區塊
protected string[]|false splitFieldIntoChunks ( $field ) | ||
$field | string |
protected function splitFieldIntoChunks($field)
{
$originalDefaultValue = null;
$defaultValue = null;
preg_match_all('/defaultValue\(["\'].*?:?.*?["\']\)/', $field, $matches, PREG_SET_ORDER, 0);
if (isset($matches[0][0])) {
$originalDefaultValue = $matches[0][0];
$defaultValue = str_replace(':', '{{colon}}', $originalDefaultValue);
$field = str_replace($originalDefaultValue, $defaultValue, $field);
}
$chunks = preg_split('/\s?:\s?/', $field);
if (is_array($chunks) && $defaultValue !== null && $originalDefaultValue !== null) {
foreach ($chunks as $key => $chunk) {
$chunks[$key] = str_replace($defaultValue, $originalDefaultValue, $chunk);
}
}
return $chunks;
}
定義於: yii\console\Controller::stderr()
將字串列印到 STDERR。
您可以選擇性地使用 ANSI 代碼格式化字串,方法是使用 yii\helpers\Console 中定義的常數傳遞其他參數。
範例
$this->stderr('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public integer|boolean stderr ( $string ) | ||
$string | string |
要列印的字串 |
return | 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。
您可以選擇性地使用 ANSI 代碼格式化字串,方法是使用 yii\helpers\Console 中定義的常數傳遞其他參數。
範例
$this->stdout('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public integer|boolean stdout ( $string ) | ||
$string | string |
要列印的字串 |
return | 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);
}
截斷資料庫。
應在子類別中覆寫此方法,以實作清除資料庫的任務。
protected void truncateDatabase ( ) | ||
throws | yii\base\NotSupportedException |
如果未覆寫 |
---|
protected function truncateDatabase()
{
$db = $this->db;
$schemas = $db->schema->getTableSchemas();
// First drop all foreign keys,
foreach ($schemas as $schema) {
foreach ($schema->foreignKeys as $name => $foreignKey) {
$db->createCommand()->dropForeignKey($name, $schema->name)->execute();
$this->stdout("Foreign key $name dropped.\n");
}
}
// Then drop the tables:
foreach ($schemas as $schema) {
try {
$db->createCommand()->dropTable($schema->name)->execute();
$this->stdout("Table {$schema->name} dropped.\n");
} catch (\Exception $e) {
if ($this->isViewRelated($e->getMessage())) {
$db->createCommand()->dropView($schema->name)->execute();
$this->stdout("View {$schema->name} dropped.\n");
} else {
$this->stdout("Cannot drop {$schema->name} Table .\n");
}
}
}
}
註冊 或 登入 以發表評論。