You are browsing a version that is no longer maintained.
Maintained
4.0 (upcoming) 3.9 (upcoming) 3.8.2 (current)
Unmaintained
3.7 3.6 3.5 3.4 3.3 3.2 3.1 3.0 2.3 2.2 2.1 2.0 1.8 1.7

Custom Integration

For up to date code take a look at the doctrine migrations command line integration. None the less the main steps required to make a functional integration are presented below.

Installation

First you need to require Doctrine Migrations as a dependency of your code

$ composer require doctrine/migrations

Then you have to require the composer autoloader to use the classes from the Doctrine\DBAL\Migrations namespace in your project:

1$autoloadFiles = array(
    __DIR__ . '/../vendor/autoload.php',
    __DIR__ . '/../../../autoload.php'
);

$autoloader = false;
foreach ($autoloadFiles as $autoloadFile) {
    if (file_exists($autoloadFile)) {
        require_once $autoloadFile;
        $autoloader = true;
    }
}

if (!$autoloader) {
    die('vendor/autoload.php could not be found. Did you run `php composer.phar install`?');
}


2


3


4


5


6


7


8


9


10


11


12


13


14


15


16

Now the above autoloader is able to load a class like the following:

$ /path/to/migrations/lib/Doctrine/DBAL/Migrations/Migrations/Migration.php

Register Console Commands

Now that we have setup the autoloaders we are ready to add the migration console commands to our Doctrine Command Line Interface:

1// ...

$cli->addCommands(array(
    // Migrations Commands
    new \Doctrine\DBAL\Migrations\Tools\Console\Command\ExecuteCommand(),
    new \Doctrine\DBAL\Migrations\Tools\Console\Command\GenerateCommand(),
    new \Doctrine\DBAL\Migrations\Tools\Console\Command\LatestCommand(),
    new \Doctrine\DBAL\Migrations\Tools\Console\Command\MigrateCommand(),
    new \Doctrine\DBAL\Migrations\Tools\Console\Command\DiffCommand(),
    new \Doctrine\DBAL\Migrations\Tools\Console\Command\UpToDateCommand(),
    new \Doctrine\DBAL\Migrations\Tools\Console\Command\StatusCommand(),
    new \Doctrine\DBAL\Migrations\Tools\Console\Command\VersionCommand()
));


2


3


4


5


6


7


8


9


10


11


12


13

Register Console helpers

Additionally you have to make sure the 'db' and 'dialog' Helpers are added to your Symfony Console HelperSet in a cli-config.php file.

This file can be either in the directory you are calling the console tool from or in as config subfolder.

1$db = \Doctrine\DBAL\DriverManager::getConnection($params);
// or
$em = \Doctrine\ORM\EntityManager::create($params);
$db = $em->getConnection();

$helperSet = new \Symfony\Component\Console\Helper\HelperSet(array(
    'db' => new \Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper($db),
    'question' => new \Symfony\Component\Console\Helper\QuestionHelper(),
));

return $helperset;


2


3


4


5


6


7


8


9


10


11

Note that the db helper is not required as you might want to pass the connection information from the command line directly.

You will see that you have a few new commands when you execute the following command:

$ ./doctrine list migrations
Doctrine Command Line Interface version 1.2.1

Usage:
  [options] command [arguments]

Options:
  --help           -h Display this help message.
  --quiet          -q Do not output any message.
  --verbose        -v Increase verbosity of messages.
  --version        -V Display this program version.
  --color          -c Force ANSI color output.
  --no-interaction -n Do not ask any interactive question.

Available commands for the "migrations" namespace:
  :diff      Generate a migration by comparing your current database to your mapping information.
  :execute   Execute a single migration version up or down manually.
  :generate  Generate a blank migration class.
  :migrate   Execute a migration to a specified version or the latest available version.
  :status    View the status of a set of migrations.
  :version   Manually add and delete migration versions from the version table.