gii.md 4.34 KB
Newer Older
1 2 3 4 5 6
The Gii code generation tool
============================

Yii2 includes a handy tool that allows rapid prototyping by generating commonly used code snippets
as well as complete CRUD controllers.

Carsten Brandt committed
7

8 9 10
Installing and configuring
--------------------------

Carsten Brandt committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
Gii comes as an offical extension and the preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```
php composer.phar require yiisoft/yii2-gii "*"
```

or add

```
"yiisoft/yii2-gii": "*"
```

to the require section of your `composer.json` file.

Once the extension is installed, simply add these lines to your application configuration file:
28 29

```php
30
'modules' => [
Carsten Brandt committed
31 32 33
	'gii' => [
		'class' => 'yii\gii\Module',
	],
34
]
35 36
```

Carsten Brandt committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
You can then access Gii through the following URL:

```
http://localhost/path/to/index.php?r=gii
```

> Note: if you are accessing gii from another IP than localhost, access will be denied by default.
  You have to add allowed IPs to the configuration in this case:
  ```php
      'gii' => [
          'class' => 'yii\gii\Module',
          'allowedIPs' => ['127.0.0.1', '::1', '192.168.0.*', '192.168.178.20'] // adjust this to your needs
      ],
  ```


53 54 55
How to use it
-------------

Carsten Brandt committed
56 57 58 59 60 61
When you open Gii you first see the entry page that lets you choose a generator.

![Gii entry page](images/gii-entry.png)

By default there are the following generators available:

Carsten Brandt committed
62 63
- **Model Generator** - This generator generates an ActiveRecord class for the specified database table.
- **CRUD Generator** - This generator generates a controller and views that implement CRUD (Create, Read, Update, Delete)
Carsten Brandt committed
64
  operations for the specified data model.
Carsten Brandt committed
65
- **Controller Generator** - This generator helps you to quickly generate a new controller class, one or several
Carsten Brandt committed
66
  controller actions and their corresponding views.
Carsten Brandt committed
67
- **Form Generator** - This generator generates a view script file that displays a form to collect input for the
Carsten Brandt committed
68
  specified model class.
Carsten Brandt committed
69
- **Module Generator** - This generator helps you to generate the skeleton code needed by a Yii module.
Carsten Brandt committed
70 71 72 73 74 75 76 77 78 79 80 81

After choosing a generator by clicking on the "Start" button you will see a form that allows you to configure the
parameters of the generator. Fill out the form according to your needs and press the "Preview" button to get a
preview of the code that gii is about to generated. Dependend on the generator you chose and whether the files
already existed or not you will get an ouput similar to what you see in the following picuture:

![Gii preview](images/gii-preview.png)

Clicking on the file name you can view a preview of the code that will be generated for that file.
When the file already exists, gii also provides a diff view that shows what is different between the code that exists
and the one that will be generated. In this case you can also choose which files should be overridden and which not.

Carsten Brandt committed
82 83 84 85 86
> Tip: When using the Model Generator to update models after database change, you can copy the code from gii preview
  and merge the changes with your own code. You can use IDE features like PHPStorms
  [compare with clipboard](http://www.jetbrains.com/phpstorm/webhelp/comparing-files.html) for this,
  which allows you to merge in relevant changes and leave out others that may revert your own code.

Carsten Brandt committed
87 88 89
After you have reviewed the code and selected the files to be generated you can click the "Generate" button to create
the files. If all went fine you are done. When you see errors that gii is not able to generate the files you have to
adjust directory permissions so that your webserver is able to write to the directories and create the files.
90 91 92 93 94 95 96

> Note: The code generated by gii is only a template that has to be adjusted to your needs. It is there
  to help you create new things quickly but it is not something that creates ready to use code.
  We often see people using the models generated by gii without change and just extend them to adjust
  some parts of it. This is not how it is ment to be used. Code generated by gii may be incomplete or incorrect
  and has to be changed to fit your needs before you can use it.

Carsten Brandt committed
97

98 99 100
Creating your own templates
---------------------------

Carsten Brandt committed
101 102 103 104 105
Every generator has a form field that lets you choose a template to use for code generation.
By default gii only provides one template but you can create your own templates that are adjusted to your needs.

TBD

Carsten Brandt committed
106

Carsten Brandt committed
107 108 109
Creating your own generators
----------------------------

110
TBD
111