achrafsoltani/migration-service-provider

Doctrine migration service provider for Silex. Based on knplabs/migration-service-provider

MigrationServiceProvider

, _(*1)

This is a simple homebrew schema migration system for silex and doctrine., _(*2)

Install

Installation

$ composer require achrafsoltani/migration-service-provider

Setup

``` {.php} require_once DIR.'/vendor/autoload.php';, <sub>(*3)</sub>

use Silex\Application; use Silex\Provider\DoctrineServiceProvider; use Gridonic\Provider\ConsoleServiceProvider; use AchrafSoltani\Provider\MigrationServiceProvider;, <sub>(*4)</sub>

$app = new Application();, <sub>(*5)</sub>

$app->register(new Silex\Provider\DoctrineServiceProvider(), array( 'db.options' => array( // db options ), ));, <sub>(*6)</sub>

$app->register(new ConsoleServiceProvider(), array( // console options ));, <sub>(*7)</sub>

// Usage, <sub>(*8)</sub>

$app->run();, <sub>(*9)</sub>

```php
$app->register(new MigrationServiceProvider(), array(
    'migration.path' => __DIR__.'/../src/Resources/migrations',
    'migration.register_before_handler' => true,
    'migration.migrations_table_name'   => 'migration_version',
    'migration.db' => $app['db']
));

Migration Example

<?php

// I'm using a custom namespace with a custom loader
namespace Core\User\Migration;

use Doctrine\DBAL\Schema\Schema;
use AchrafSoltani\Migration\AbstractMigration;
use Silex\Application;

// Custom class, demonstration only
use Core\User\Model\User;

/**
 * Class UsersMigration
 *
 * @package Core\User\Migration
 */
class UsersMigration extends AbstractMigration
{
    /**
     * @param Schema $schema
     */
    public function schemaUp(Schema $schema)
    {
        // before app is started, do the following.
        $table = $schema->createTable('users');
        $table->addColumn('id', 'integer', array(
            'unsigned'      => true,
            'autoincrement' => true
        ));
        $table->addColumn('username', 'string', array('notnull' => true, 'default' => '', 'length' => 100));
        $table->addColumn('password', 'string', array('notnull' => true, 'default' => '', 'length' => 255));
        $table->addColumn('roles', 'string', array('notnull' => true, 'default' => '', 'length' => 255));
        $table->setPrimaryKey(array("id"));
        $table->addUniqueIndex(array("username"));
    }

    public function appUp(Application $app)
    {
        // create default user
        // My model manager class takes a Doctrine\DBAL\Connection instance as parameter
        // This part is fully custom, for demontration purpose only
        $user_model = new User($app['db']);
        $user_data = array(
            'username' => 'achraf',
            'password' => $app['security.encoder.digest']->encodePassword('password', ''),
            'roles'    => 'ROLE_USER'
        );
        $user_model->create($user_data);
    }

    public function getMigrationInfo()
    {
        return 'Added users table';
    }
}

// Very important to add if you wanna organise your migration files within namespaced folders
// if not specified, the migration will be expected to be in the \Migration namespace
return __NAMESPACE__;

Running migrations

There are two ways of running migrations, <sub>(*10)</sub>

Using the before handler

If you pass a migration.register_before_handler (set to true) when registering the service, then a before handler will be registered for migration to be run. It means that the migration manager will be run for each hit to your application., <sub>(*11)</sub>

You might want to enable this behavior for development mode, but please don't do that in production!, <sub>(*12)</sub>

Using the migration:migrate command

If you installed the console service provider right, you can use the migration:migrate command, so your app does not have to run the migrations each time when your web-Application is called., <sub>(*13)</sub>

Writing migrations

A migration consist of a single file, holding a migration class. By design, the migration file must be named something like <version>_<migration_name>Migration.php and located in src/Resources/migrations, and the class <migration_name>Migration. For example, if your migration adds a bar field to the foo table, and is the 5th migration of your schema, you should name your file 05_FooBarMigration.php, and the class would be named FooBarMigration., <sub>(*14)</sub>

In addition to these naming conventions, your migration class must extends Gridonic\Migration\AbstractMigration, which provides a few helping method such as getVersion and default implementations for migration methods., <sub>(*15)</sub>

The migration methods consist of 4 methods, which are called in this order:, <sub>(*16)</sub>

• schemaUp
• appUp
• schemaDown
• appDown

schemaUp

You get a Doctrine\DBAL\Schema\Schema instance where you can add, remove or modify the schema of your database., <sub>(*17)</sub>

appUp

After the schemaUp, you can edit the application - you get a Silex\Application instance for that. Here you can modify existing data after you have added a column., <sub>(*18)</sub>

schemaDown

After the appUp, you can modify the schema of your database again. You get a Doctrine\DBAL\Schema\Schema instance which you can use., <sub>(*19)</sub>

appDown

Last but not least, you can work again with a Silex\Application instance. Modify the existing data or something like this., <sub>(*20)</sub>

Migration infos

There's one last method you should know about: getMigrationInfos. This method should return a self-explanatory description of the migration (it is optional though, and you can skip its implementation). If you use Twig, we have built in a migration_infos for twig - perhaps a function just for the developer-mode., <sub>(*21)</sub>

You can then use it with something like that:, <sub>(*22)</sub>

      Migration informations: {{ migration_infos }}

Full API documentation

• The official documentation for Doctrine's DBAL Schema Manager
• Original KnpLabs\migration-service-provider
• Original Gridonic\migration-service-provider

Licence

The MigrationServiceProvider is licensed under the MIT license. The original library from is taken from the KnpLabs., <sub>(*23)</sub>