Edit me

マイグレーション

プラグイン用のテーブル作成・削除を行う場合、マイグレーションという仕組みを使います。マイグレーションには極力テーブル追加、削除処理に止めておきます。
但し、プラグインがバージョンアップされた時にしか実行されない処理があれば、マイグレーションで行う方が簡単です。

  • マイグレーションではテーブル作成、削除を行う
  • プラグインバージョンアップ時にPluginManagerのupdate関数で対処できないケースのみマイグレーションファイル内に記述
    →複数回バージョンアップが発生した時にupdate関数では対処し辛い等

マイグレーションファイルの配置場所

マイグレーションファイルは本体と同じくResourceディレクトリ配下に置きます。

[プラグインコード]
  ├── Resource
  │   ├── doctrine
  │   │   └── Plugin.XXXX.Entity.XXXX.dcm.yml
  │   │   └── migration
  │   │       └── VersionYYYYMMDDHHMMSS.php

※本体ではマイグレーションファイルは

php app/console migrations:generate

というコマンドを実行すれば自動的に作成されますが、プラグインの所定のディレクトリに対して作成する機能は提供されていません。
上記コマンドを実行し、本体側に出来たマイグレーションファイルをプラグインの所定のディレクトリまでコピーするか、既存ファイルをコピーをしてクラス名等を置き換えて作成してください。

マイグレーションでのテーブル作成・削除

プラグイン用テーブルの作成・削除の処理内容はプラグイン仕様書の「3.プラグインを作る」の「マイグレーション」を参照してください。

項目の追加・削除

テーブルの追加・削除以外に項目追加、削除や制約変更も可能です。

<?php

namespace DoctrineMigrations;

use Doctrine\DBAL\Migrations\AbstractMigration;
use Doctrine\DBAL\Schema\Schema;

/**
 * Auto-generated Migration: Please modify to your needs!
 */
class VersionYYYYMMDDHHMMSS extends AbstractMigration
{

    const NAME = 'テーブル名';

    /**
     * @param Schema $schema
     */
    public function up(Schema $schema)
    {
        // this up() migration is auto-generated, please modify it to your needs
        if ($schema->hasTable(self::NAME)) {
            return true;
        }
        $table = $schema->getTable(self::NAME);
        $table->addColumn('nickname', 'string', array('notnull' => true, 'length' => 50));
        $table->changeColumn('email', 'string', array('notnull' => false, 'length' => 250));
    }

    /**
     * @param Schema $schema
     */
    public function down(Schema $schema)
    {
        // this down() migration is auto-generated, please modify it to your needs
        if (!$schema->hasTable(self::NAME)) {
            return true;
        }
        $table = $schema->getTable(self::NAME);
        $table->dropColumn('nickname');
    }
}
Tags: plugin