After Width: | Height: | Size: 84 KiB |
After Width: | Height: | Size: 53 KiB |
After Width: | Height: | Size: 74 KiB |
After Width: | Height: | Size: 94 KiB |
After Width: | Height: | Size: 102 KiB |
After Width: | Height: | Size: 92 KiB |
After Width: | Height: | Size: 89 KiB |
@ -0,0 +1,147 @@
|
||||
Gii でコードを生成する |
||||
====================== |
||||
|
||||
この節では、[Gii](tool-gii.md) を使って、ウェブサイトの一般的な機能のいくつかを実装するコードを |
||||
自動的に生成する方法を説明します。Gii を使ってコードを自動生成することは、Gii のウェブページに |
||||
表示される指示に対して正しい情報を入力するだけのことです。 |
||||
|
||||
このチュートリアルを通じて、次のことをする方法を学びます: |
||||
|
||||
* アプリケーションで Gii を有効にする |
||||
* Gii を使って、アクティブレコードのクラスを生成する |
||||
* Gii を使って、DB テーブルの CRUD 操作を実装するコードを生成する |
||||
* Gii によって生成されるコードをカスタマイズする |
||||
|
||||
|
||||
Gii を開始する<a name="starting-gii"></a> |
||||
-------------- |
||||
|
||||
[Gii](tool-gii.md) は Yii の [モジュール](structure-modules.md) として提供されます。 |
||||
Gii は、アプリケーションの [[yii\base\Application::modules|modules]] プロパティの中で設定することで有効にすることが出来ます。 |
||||
アプリケーションを生成した仕方にもよりますが、`config/web.php` の設定ファイルの中に、多分、下記のコードが既に提供されているでしょう: |
||||
|
||||
```php |
||||
$config = [ ... ]; |
||||
|
||||
if (YII_ENV_DEV) { |
||||
$config['bootstrap'][] = 'gii'; |
||||
$config['modules']['gii'] = 'yii\gii\Module'; |
||||
} |
||||
``` |
||||
|
||||
上記の設定は、[開発環境](concept-configurations.md#environment-constants) において、アプリケーションは |
||||
`gii` という名前のモジュールをインクルードすべきこと、そして `gii` は [[yii\gii\Module]] というクラスのものであることを記述しています。 |
||||
|
||||
アプリケーションの [エントリスクリプト](structure-entry-scripts.md) である `web/index.php` をチェックすると、次の行があることに気付くでしょう。 |
||||
これは本質的には `YII_ENV_DEV` を true に設定するものです。 |
||||
|
||||
```php |
||||
defined('YII_ENV') or define('YII_ENV', 'dev'); |
||||
``` |
||||
|
||||
この行のおかげで、アプリケーションは開発モードになり、上記の設定によって、Gii が有効になります。 |
||||
これで、下記の URL によって Gii にアクセスすることが出来ます: |
||||
|
||||
``` |
||||
http://hostname/index.php?r=gii |
||||
``` |
||||
|
||||
> Note|注意: ローカルホスト以外のマシンから GII にアクセスしようとすると、既定ではセキュリティ上の |
||||
> 目的からアクセスが拒否されます。下記のように Gii を設定して、許可される IP アドレスを追加することが出来ます。 |
||||
> |
||||
```php |
||||
'gii' => [ |
||||
'class' => 'yii\gii\Module', |
||||
'allowedIPs' => ['127.0.0.1', '::1', '192.168.0.*', '192.168.178.20'] // 必要に応じて調整 |
||||
], |
||||
``` |
||||
|
||||
![Gii](images/start-gii.png) |
||||
|
||||
|
||||
アクティブレコードのクラスを生成する<a name="generating-ar"></a> |
||||
------------------------------------ |
||||
|
||||
Gii を使ってアクティブレコードのクラスを生成するためには、(Gii のインデックスページのリンクをクリックして) "Model Generator" を選びます。 |
||||
そして、次のようにフォームに入力します: |
||||
|
||||
* Table Name: `country` |
||||
* Model Class: `Country` |
||||
|
||||
![Model Generator](images/start-gii-model.png) |
||||
|
||||
次に、"Preview" ボタンをクリックします。 |
||||
そうすると、結果として作成されるクラスファイルのリストに `models/Country.php` が挙ってきます。 |
||||
クラスファイルの名前をクリックすると、内容をプレビュー出来ます。 |
||||
|
||||
Gii を使うときに、既に同じファイルを作成していて、それを上書きしようとしている場合は、 |
||||
ファイル名の隣の `diff` ボタンをクリックして、生成されようとしているコードと既存のバージョンの |
||||
違いを見てください。 |
||||
|
||||
![Model Generator のプレビュー](images/start-gii-model-preview.png) |
||||
|
||||
既存のファイルを上書きしようとしているときは、"overwrite" の隣のチェックボックスをチェックしてから "Generate" ボタンをクリックします。 |
||||
新しいファイルを作成しようとしているときは、単に "Generate" を押せば大丈夫です。 |
||||
|
||||
次に、コードの生成が成功したことを示す確認ページが表示されます。既存のファイルがあった場合は、 |
||||
それが新しく生成されたコードで上書きされたことを示すメッセージも同じく表示されます。 |
||||
|
||||
|
||||
CRUD コードを生成する<a name="generating-crud"></a> |
||||
--------------------- |
||||
|
||||
CRUD は Create(作成)、Read(読出し)、Update(更新)、そして Delete(削除) を意味しており、 |
||||
ほとんどのウェブサイトでデータを扱うときによく用いられる4つのタスクを表しています。 |
||||
Gii を使って CRUD 機能を作成するためには、(Gii のインデックスページのリンクをクリックして) "CRUD Generator" を選びます。 |
||||
「国リスト」のサンプルのためには、以下のようにフォームに入力します: |
||||
|
||||
* Model Class: `app\models\Country` |
||||
* Search Model Class: `app\models\CountrySearch` |
||||
* Controller Class: `app\controllers\CountryController` |
||||
|
||||
![CRUD Generator](images/start-gii-crud.png) |
||||
|
||||
次に、"Preview" ボタンをクリックします。 |
||||
生成されるファイルのリストは、次のようになります。 |
||||
|
||||
![CRUD Generator のプレビュー](images/start-gii-crud-preview.png) |
||||
|
||||
以前に(ガイドのデータベースの節で)`controllers/CountryController.php` と |
||||
`views/country/index.php` のファイルを作成していた場合は、それらを置き換えるために "overwrite" の |
||||
チェックボックスをチェックしてください。(以前のバージョンは フル機能の CRUD をサポートしていません。) |
||||
|
||||
|
||||
試してみる<a name="trying-it-out"></a> |
||||
---------- |
||||
|
||||
どのように動作するかを見るために、ブラウザを使って下記の URL にアクセスしてください: |
||||
|
||||
``` |
||||
http://hostname/index.php?r=country/index |
||||
``` |
||||
|
||||
データグリッドがデータベーステーブルから取得した国を表示しているページが表示されます。 |
||||
グリッドをソートしたり、カラムのヘッダに検索条件を入力してグリッドをフィルターしたりすることが出来ます。 |
||||
|
||||
グリッドに表示されているそれぞれの国について、詳細を見たり、更新したり、または削除したりすることが出来ます。また、グリッドの上にある "Create Country" ボタンをクリックすると、新しい国データを作成するためのフォームが利用に供されます。 |
||||
|
||||
![国リストのデータグリッド](images/start-gii-country-grid.png) |
||||
|
||||
![国データを更新する](images/start-gii-country-update.png) |
||||
|
||||
下記が Gii によって生成されるファイルのリストです。 |
||||
これらの機能がどのように実装されているかを調査したい場合、また、これらの機能をカスタマイズしたいときに参照してください: |
||||
|
||||
* Controller: `controllers/CountryController.php` |
||||
* Models: `models/Country.php` and `models/CountrySearch.php` |
||||
* Views: `views/country/*.php` |
||||
|
||||
> Info|情報: Gii は非常にカスタマイズしやすく拡張しやすいコード生成ツールとして設計されています。 |
||||
これを賢く使うと、アプリケーションの開発速度を大いに高めることが出来ます。 |
||||
更なる詳細は、[Gii](tool-gii.md) の節を参照してください。 |
||||
|
||||
|
||||
まとめ<a name="summary"></a> |
||||
------ |
||||
|
||||
この節では、Gii を使ってコードを生成して、データベーステーブルに保存されているコンテンツのための完全な CRUD 機能を実装する方法を学びました。 |