skobka/yii2-migration-generator

Generates migrations from Annotations

Installs: 1 089

Dependents: 0

Suggesters: 0

Security: 0

Stars: 8

Watchers: 3

Forks: 3

Open Issues: 0

Type:yii2-extension

v2.0.2 2017-01-04 04:26 UTC

This package is not auto-updated.

Last update: 2022-01-08 04:41:37 UTC


README

Generates migrations from Annotations of Model or ActiveRecords classes (not only). You simple write classes as usual and then asking generator to create migration file from code.

NOTE! Works only with yii2 console. This is NOT Gii extension

##Installation

php composer.phar require --dev skobka/yii2-migration-generator "*"

Or add it manualy to composer.json

{
  "require-dev": {
    "skobka/yii2-migration-generator": "*"
  }
}

Next step is to enable generation from Yii2 console. Add following code in console/config/main.php

use skobka\yii2\migrationGenerator\Controllers\MigrationGeneratorController;

return [
   //...
    'controllerMap' => [
        'migration' => [
            'class' => MigrationGeneratorController::class,
        ],
    ],
   //...
]

##Usage This package provide following annotations:

  • @Superclass(active=true)
  • @Table(name="")
  • @Column(name="", type="", typeArgs={}, extra="")

###@Superclass Indicate that annotation from current class must be included in child class. When parser goes throught classes it will skip class without @Superclass or @Table annotation. Parser will not finds parents of such class. If you want to skip current @Superclass from parsing, simple set option active to false

###@Table This annotations tells that current class define a table. Table name takes from property name:

@Table(name="my_first_table")
// You can use @Table() without parameters, then MyModel::tableName() will be used

###@Column This annotation defined a table column. You must specify the name and type of column.

NOTE! Column types must be a method names of yii\db\SchemaBuilderTrait Available properties:

  • name - name of column
  • type - column type
  • typeArgs - an array of type arguments, for example: @Column(type="decimal", typeArgs={10,2})
  • extra - string wich will be append to then end of column definition

After all run

php yii migration/generate common/models/mymodel 

##Examples

/**
 * @Superclass()
 * @Column(name="id", type="primaryKey")
 * @Column(name="uid", type="integer", notNull=false)
 * 
 * @property int id
 * @property int uid
 */
class BaseModel
{

}
<?php
use skobka\yii2\migrationGenerator\annotation\Column;
use skobka\yii2\migrationGenerator\annotation\Superclass;
use skobka\yii2\migrationGenerator\annotation\Table;

/**
 * @Table(name="{{%simple_class}}")
 *
 * @Column(name="some", type="string", typeArgs={255}, extra=" DEFAULT '0'")
 * @Superclass()
 * use superclass annotation to allow extending class annotation
 *
 * @property string some
 */
class SimpleClass extends BaseModel
{

}
<?php
use skobka\yii2\migrationGenerator\annotation\Column;
use skobka\yii2\migrationGenerator\annotation\Table;

/**
 * @Table(name="sub_simple_class")
 * @Column(name="created", type="integer", notNull=true)
 *
 * @property int created
 */
class SubSimpleClass extends SimpleClass
{

}