# Gii Extension for Yii 2

This extension provides a Web-based code generator, called Gii, for Yii framework 2.0 applications. You can use Gii to quickly generate models, forms, modules, CRUD, etc.

For license information check the LICENSE-file.

Documentation is at docs/guide/README.md.

## Installation ¶

The preferred way to install this extension is through composer.

Either run

    php composer.phar require --dev --prefer-dist yiisoft/yii2-gii

or add

    "yiisoft/yii2-gii": "~2.1.0"

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

## Usage ¶

Once the extension is installed, simply modify your application configuration as follows:

    return [
        'bootstrap' => ['gii'],
        'modules' => [
            'gii' => [
                'class' => 'yii\gii\Module',
            ],
            // ...
        ],
        // ...
    ];

You can then access Gii through the following URL:

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

or if you have enabled pretty URLs, you may use the following URL:

    http://localhost/path/to/index.php/gii

Using the same configuration for your console application, you will also be able to access Gii via command line as follows,

    # change path to your application's base path
    cd path/to/AppBasePath

    # show help information about Gii
    yii help gii

    # show help information about the model generator in Gii
    yii help gii/model

    # generate City model from city table
    yii gii/model --tableName=city --modelClass=City

# Class Reference

Class | Description
--- | ---
yii\gii\CodeFile | CodeFile represents a code file to be generated.
yii\gii\Generator | This is the base class for all generator classes.
yii\gii\GiiAsset | This declares the asset files required by Gii.
yii\gii\Module | This is the main module class for the Gii module.
yii\gii\components\ActiveField |
yii\gii\components\DiffRendererHtmlInline | Renders diff to HTML. Output adjusted to be copy-paste friendly.
yii\gii\console\GenerateAction |
yii\gii\console\GenerateController | This is the command line version of Gii - a code generator.
yii\gii\controllers\DefaultController |
yii\gii\generators\controller\Generator | This generator will generate a controller and one or a few action view files.
yii\gii\generators\crud\Generator | Generates CRUD
yii\gii\generators\extension\Generator | This generator will generate the skeleton files needed by an extension.
yii\gii\generators\form\Generator | This generator will generate an action view file based on the specified model class.
yii\gii\generators\model\Generator | This generator will generate one or multiple ActiveRecord classes for the specified database table.
yii\gii\generators\module\Generator | This generator will generate the skeleton code needed by a module.