mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-01 11:39:41 +08:00
merge from yiisoft/yii2
This commit is contained in:
cuileon
@ -5,8 +5,7 @@
|
||||
コンソール・アプリケーションは、主として、ウェブ・サイトのために実行する必要のあるバックグラウンドのタスクやメンテナンスのタスクを作成するために使われるものです。
|
||||
|
||||
コンソール・アプリケーションの構造は Yii のウェブ・アプリケーションのそれと非常に良く似ています。
|
||||
コンソール・アプリケーションは一つまたは複数の [[yii\console\Controller]] クラスから構成されます。
|
||||
コントローラはコンソール環境ではしばしば「コマンド」と呼ばれます。
|
||||
コンソール・アプリケーションは一つまたは複数の [[yii\console\Controller]] クラスから構成されます。コントローラはコンソール環境ではしばしば「コマンド」と呼ばれます。
|
||||
また、各コントローラは、ウェブのコントローラと全く同じように、一つまたは複数のアクションを持つことが出来ます。
|
||||
|
||||
プロジェクト・テンプレートは、両方とも、既にコンソール・アプリケーションを持っています。
|
||||
@ -43,7 +42,9 @@ yii <route> [--option1=value1 --option2=value2 ... argument1 argument2 ...]
|
||||
上記において、`<route>` はコントローラ・アクションへのルートを示すものです。
|
||||
オプション (options) はクラスのプロパティに代入され、引数 (arguments) はアクション・メソッドのパラメータとなります。
|
||||
|
||||
例えば、[[yii\console\controllers\MigrateController::$migrationTable|MigrateController::$migrationTable]] として `migrations` を指定し、マイグレーションの上限を 5 と指定して [[yii\console\controllers\MigrateController::actionUp()|MigrateController::actionUp()]] を呼び出すためには、次のようにします。
|
||||
例えば、[[yii\console\controllers\MigrateController::$migrationTable|MigrateController::$migrationTable]] として `migrations` を指定し、
|
||||
マイグレーションの上限を 5 と指定して [[yii\console\controllers\MigrateController::actionUp()|MigrateController::actionUp()]]
|
||||
を呼び出すためには、次のようにします。
|
||||
|
||||
```
|
||||
yii migrate/up 5 --migrationTable=migrations
|
||||
@ -68,6 +69,7 @@ yii migrate/up 5 --migrationTable=migrations
|
||||
*/
|
||||
|
||||
defined('YII_DEBUG') or define('YII_DEBUG', true);
|
||||
defined('YII_ENV') or define('YII_ENV', 'dev');
|
||||
|
||||
require __DIR__ . '/vendor/autoload.php';
|
||||
require __DIR__ . '/vendor/yiisoft/yii2/Yii.php';
|
||||
@ -79,8 +81,7 @@ $exitCode = $application->run();
|
||||
exit($exitCode);
|
||||
```
|
||||
|
||||
このスクリプトはアプリケーションの一部として生成されるものです。
|
||||
あなたの必要を満たすように、自由に編集して構いません。
|
||||
このスクリプトはアプリケーションの一部として生成されるものです。あなたの必要を満たすように、自由に編集して構いません。
|
||||
エラー発生時にスタック・トレースを見たくない、または、全体のパフォーマンスを上げたい、という場合は、`YII_DEBUG` 定数を `false` に設定することが出来ます。
|
||||
ベーシック・プロジェクト・テンプレートでも、アドバンスト・プロジェクト・テンプレートでも、コンソール・アプリケーションのエントリ・スクリプトは、開発者に優しい環境を提供するために、デフォルトでデバッグを有効にしています。
|
||||
|
||||
@ -91,17 +92,21 @@ exit($exitCode);
|
||||
上記のコードで見るように、コンソール・アプリケーションは、`console.php` という名前のそれ自身の構成情報ファイルを使用します。
|
||||
このファイルの中で、さまざまな [アプリケーション・コンポーネント](structure-application-components.md)、取り分け、コンソール・アプリケーションのためのプロパティを構成しなければなりません。
|
||||
|
||||
ウェブ・アプリケーションとコンソール・アプリケーションが構成情報のパラメータと値を数多く共有する場合は、共通の部分を独立したファイルに移動して、そのファイルを両方のアプリケーション (ウェブとコンソール) の構成情報にインクルードすることを検討しても良いでしょう。
|
||||
ウェブ・アプリケーションとコンソール・アプリケーションが構成情報のパラメータと値を数多く共有する場合は、共通の部分を独立したファイルに移動して、
|
||||
そのファイルを両方のアプリケーション (ウェブとコンソール) の構成情報にインクルードすることを検討しても良いでしょう。
|
||||
その例をアドバンスト・プロジェクト・テンプレートの中で見ることが出来ます。
|
||||
|
||||
> Tip: 場合によっては、エントリ・スクリプトで指定されているのとは異なるアプリケーション構成情報を使ってコンソール・コマンドを実行したいことがあります。
|
||||
> 例えば、`yii migrate` コマンドを使ってテストのデータベースをアップグレードするとき、データベースが個々のテストスイートの中で構成されているような場合です。
|
||||
> Tip: 場合によっては、エントリ・スクリプトで指定されているのとは異なるアプリケーション構成情報を使って
|
||||
> コンソール・コマンドを実行したいことがあります。
|
||||
> 例えば、`yii migrate` コマンドを使ってテストのデータベースをアップグレードするとき、
|
||||
> データベースが個々のテストスイートの中で構成されているような場合です。
|
||||
> 構成情報を動的に変更するためには、コマンドを実行するときに `appconfig` オプションを使ってカスタムの構成情報ファイルを指定するだけで大丈夫です。
|
||||
>
|
||||
> ```
|
||||
> yii <route> --appconfig=path/to/config.php ...
|
||||
> ```
|
||||
|
||||
|
||||
コンソール・コマンドの補完 <span id="console-command-completion"></span>
|
||||
--------------------------
|
||||
|
||||
@ -110,8 +115,7 @@ exit($exitCode);
|
||||
|
||||
### Bash の補完
|
||||
|
||||
bash completion がインストールされていることを確認して下さい。
|
||||
ほとんどの bash のインストレーションでは、デフォルトで利用可能になっています。
|
||||
bash completion がインストールされていることを確認して下さい。ほとんどの bash のインストレーションでは、デフォルトで利用可能になっています。
|
||||
|
||||
補完スクリプトを `/etc/bash_completion.d/` に置いて下さい。
|
||||
|
||||
@ -150,34 +154,35 @@ autoload -Uz compinit && compinit -i
|
||||
exec $SHELL -l
|
||||
```
|
||||
|
||||
|
||||
あなた自身のコンソール・コマンドを作成する <span id="create-command"></span>
|
||||
------------------------------------------
|
||||
|
||||
### コンソールのコントローラとアクション
|
||||
|
||||
コンソール・コマンドは、[[yii\console\Controller]] を拡張するコントローラ・クラスとして定義することが出来ます。
|
||||
コントローラ・クラスの中で、コントローラのサブ・コマンドに対応する一つまたは複数のアクションを定義します。
|
||||
各アクションの中で、その特定のサブ・コマンドのための適切なタスクを実装するコードを書きます。
|
||||
コントローラ・クラスの中で、コントローラのサブ・コマンドに対応する一つまたは複数のアクションを定義します。各アクションの中で、その特定のサブ・コマンドのための適切なタスクを実装するコードを書きます。
|
||||
|
||||
コマンドを実行するときは、コントローラのアクションに対するルートを指定する必要があります。
|
||||
例えば、ルート `migrate/create` は、[[yii\console\controllers\MigrateController::actionCreate()|MigrateController::actionCreate()]] アクション・メソッドに対応するサブコマンドを呼び出します。
|
||||
例えば、ルート `migrate/create` は、[[yii\console\controllers\MigrateController::actionCreate()|MigrateController::actionCreate()]]
|
||||
アクション・メソッドに対応するサブコマンドを呼び出します。
|
||||
実行時に提供されたルートにアクション ID が含まれない場合は、(ウェブのコントローラの場合と同じように) デフォルトのアクションが実行されます。
|
||||
|
||||
### オプション
|
||||
|
||||
[[yii\console\Controller::options()]] メソッドをオーバーライドすることによって、コンソール・コマンド (controller/actionID) で利用できるオプションを指定することが出来ます。
|
||||
このメソッドはコントローラ・クラスのパブリックなプロパティのリストを返さなければなりません。
|
||||
コマンドを実行するときは、`--OptionName=OptionValue` という構文を使ってオプションの値を指定することが出来ます。これはコントローラ・クラスの `OptionName` プロパティに `OptionValue` を割り当てるものです。
|
||||
コマンドを実行するときは、`--OptionName=OptionValue` という構文を使ってオプションの値を指定することが出来ます。
|
||||
これはコントローラ・クラスの `OptionName` プロパティに `OptionValue` を割り当てるものです。
|
||||
|
||||
オプションのデフォルト値が配列型である場合、実行時にこのオプションをセットすると、オプションの値は、入力文字列をカンマで分離することによって、配列に変換されます。
|
||||
オプションのデフォルト値が配列型である場合、実行時にこのオプションをセットすると、
|
||||
オプションの値は、入力文字列をカンマで分離することによって、配列に変換されます。
|
||||
|
||||
### オプションのエイリアス
|
||||
|
||||
バージョン 2.0.8 以降、コンソールコマンドは、オプションにエイリアスを追加するための [[yii\console\Controller::optionAliases()]] メソッドを提供しています。
|
||||
バージョン 2.0.8 以降、コンソールコマンドは、オプションにエイリアスを追加するための
|
||||
[[yii\console\Controller::optionAliases()]] メソッドを提供しています。
|
||||
|
||||
エイリアスを定義するためには、コントローラで [[yii\console\Controller::optionAliases()]] をオーバーライドします。
|
||||
例えば、
|
||||
エイリアスを定義するためには、コントローラで [[yii\console\Controller::optionAliases()]] をオーバーライドします。例えば、
|
||||
|
||||
```php
|
||||
namespace app\commands;
|
||||
@ -213,8 +218,7 @@ class HelloController extends Controller
|
||||
|
||||
### 引数
|
||||
|
||||
オプションに加えてに、コマンドは引数を取ることも出来ます。
|
||||
引数は、リクエストされたサブ・コマンドに対応するアクション・メソッドへのパラメータとして渡されます。
|
||||
オプションに加えてに、コマンドは引数を取ることも出来ます。引数は、リクエストされたサブ・コマンドに対応するアクション・メソッドへのパラメータとして渡されます。
|
||||
最初の引数は最初のパラメータに対応し、二番目の引数は二番目のパラメータに対応し、以下同様です。
|
||||
コマンドが呼び出されたときに十分な数の引数が提供されなかったときは、対応するパラメータは、定義されていれば、宣言されているデフォルト値をとります。
|
||||
デフォルト値が設定されておらず、実行時に値が提供されなかった場合は、コマンドはエラーで終了します。
|
||||
@ -244,12 +248,12 @@ class ExampleController extends \yii\console\Controller
|
||||
### 終了コード
|
||||
|
||||
終了コードを使うことはコンソール・アプリケーション開発のベスト・プラクティスです。
|
||||
コマンドは何も問題が無かったことを示すために `0` を返すのが慣例です。
|
||||
コマンドが 1 以上の値を返したときは、何かエラーを示唆するものとみなされます。
|
||||
コマンドは何も問題が無かったことを示すために `0` を返すのが慣例です。コマンドが 1 以上の値を返したときは、何かエラーを示唆するものとみなされます。
|
||||
返される数値がエラーコードであり、それによってエラーに関する詳細を見出すことが出来る場合もあります。
|
||||
例えば、`1` は一般的な未知のエラーを示すものとし、`2` 以上の全てのコードは特定のエラー、例えば、入力エラー、ファイルが見つからない、等々を示すものとすることが出来ます。
|
||||
|
||||
コンソール・コマンドに終了コードを返させるためには、単にコントローラのアクション・メソッドで整数を返すようにします。
|
||||
コンソール・コマンドに終了コードを返させるためには、
|
||||
単にコントローラのアクション・メソッドで整数を返すようにします。
|
||||
|
||||
```php
|
||||
public function actionIndex()
|
||||
@ -284,8 +288,7 @@ public function actionIndex()
|
||||
Yii のコンソール・コマンドは出力の書式設定をサポートしています。
|
||||
これは、コマンドを走らせている端末がサポートしていない場合は、自動的に書式設定の無い出力にグレードダウンされます。
|
||||
|
||||
書式設定された文字列を出力することは簡単です。
|
||||
ボールドのテキストを出力するには、次のようにします。
|
||||
書式設定された文字列を出力することは簡単です。ボールドのテキストを出力するには、次のようにします。
|
||||
|
||||
```php
|
||||
$this->stdout("Hello?\n", Console::BOLD);
|
||||
@ -300,8 +303,7 @@ echo "Hello, my name is $name.";
|
||||
|
||||
### 表形式
|
||||
|
||||
バージョン 2.0.13 以降、表形式のデータをコンソールに表示するウィジェットが追加されています。
|
||||
次のようにして使うことが出来ます。
|
||||
バージョン 2.0.13 以降、表形式のデータをコンソールに表示するウィジェットが追加されています。次のようにして使うことが出来ます。
|
||||
|
||||
```php
|
||||
echo Table::widget([
|
||||
|
||||
Reference in New Issue
Block a user