Skip to content

Instantly share code, notes, and snippets.

@matperez

matperez/commands\MigrateController.php

Created February 1, 2016 18:36
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save matperez/d03ea70a624dbaa621be to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save matperez/d03ea70a624dbaa621be to your computer and use it in GitHub Desktop.
Download ZIP
yii2 massive migrations
Raw
commands\MigrateController.php
<?php
namespace app\commands;
use app\interfaces\IMigrationAware;
use Yii;
use yii\base\Module;
use yii\console\Exception;
/**
* MigrateController
* Use at application config
*
* ~~~
* 'controlerMap' => [
* 'migrate' => [
* 'class' => \app\commands\MigrateController::class,
* ]
* ]
**/
class MigrateController extends \yii\console\controllers\MigrateController
{
/**
* @var array
*/
public $migrationLookup = [];
/**
* @var array
*/
private $_migrationFiles;
/**
* @inheritDoc
*/
public function init()
{
parent::init();
$this->migrationLookup = [];
foreach (Yii::$app->modules as $id => $module) {
$this->migrationLookup = array_merge($this->migrationLookup, $this->getModuleMigrationPaths($id));
}
}
/**
* @param string $id
* @return array
*/
protected function getModuleMigrationPaths($id)
{
$module = Yii::$app->getModule($id);
$paths = [];
if ($module instanceof Module) {
if ($module instanceof IMigrationAware) {
$paths []= $module->getMigrationPath();
}
foreach ($module->getModules() as $subId => $subModule) {
$subPaths = $this->getModuleMigrationPaths($subId);
$paths = array_merge($paths, $subPaths);
}
}
return $paths;
}
/**
* List of migration class at all entire path
* @return array
*/
protected function getMigrationFiles()
{
if ($this->_migrationFiles === null) {
$this->_migrationFiles = [];
$directories = array_merge($this->migrationLookup, [$this->migrationPath]);
foreach (array_unique($directories) as $dir) {
$dir = Yii::getAlias($dir, false);
if ($dir && is_dir($dir)) {
$handle = opendir($dir);
while (($file = readdir($handle)) !== false) {
if ($file === '.' || $file === '..') {
continue;
}
$path = $dir . DIRECTORY_SEPARATOR . $file;
if (preg_match('/^(m(\d{6}_\d{6})_.*?)\.php$/', $file, $matches) && is_file($path)) {
$this->_migrationFiles[$matches[1]] = $path;
}
}
closedir($handle);
}
}
ksort($this->_migrationFiles);
}
return $this->_migrationFiles;
}
/**
* @inheritdoc
*/
protected function createMigration($class)
{
$file = $this->getMigrationFiles()[$class];
require_once($file);
return new $class(['db' => $this->db]);
}
/**
* @inheritdoc
*/
protected function getNewMigrations()
{
$applied = [];
foreach ($this->getMigrationHistory(null) as $version => $time) {
$applied[substr($version, 1, 13)] = true;
}
$migrations = [];
foreach ($this->getMigrationFiles() as $version => $path) {
if (!isset($applied[substr($version, 1, 13)])) {
$migrations[] = $version;
}
}
return $migrations;
}
/**
* Upgrades the application by applying new migration.
* For example,
*
* ~~~
* yii migrate/partial-up 101129_185401 # using timestamp
* yii migrate/partial-up m101129_185401_create_user_table # using full name
* ~~~
*
* @param string $version the version at which the migration history should be marked.
* This can be either the timestamp or the full name of the migration.
* @return int CLI exit code
* @throws Exception if the version argument is invalid or the version cannot be found.
*/
public function actionPartialUp($version)
{
$originalVersion = $version;
if (preg_match('/^m?(\d{6}_\d{6})(_.*?)?$/', $version, $matches)) {
$version = 'm' . $matches[1];
} else {
throw new Exception("The version argument must be either a timestamp (e.g. 101129_185401)\nor the full name of a migration (e.g. m101129_185401_create_user_table).");
}
$migrations = $this->getNewMigrations();
foreach ($migrations as $migration) {
if (strpos($migration, $version . '_') === 0) {
if ($this->confirm("Apply the $migration migration?")) {
if (!$this->migrateUp($migration)) {
echo "\nMigration failed.\n";
return self::EXIT_CODE_ERROR;
}
return self::EXIT_CODE_NORMAL;
}
return;
}
}
throw new Exception("Unable to find the version '$originalVersion'.");
}
/**
* Downgrades the application by reverting old migration.
* For example,
*
* ~~~
* yii migrate/partial-down 101129_185401 # using timestamp
* yii migrate/partial-down m101129_185401_create_user_table # using full name
* ~~~
*
* @param string $version the version at which the migration history should be marked.
* This can be either the timestamp or the full name of the migration.
* @return int CLI exit code
* @throws Exception if the version argument is invalid or the version cannot be found.
*/
public function actionPartialDown($version)
{
$originalVersion = $version;
if (preg_match('/^m?(\d{6}_\d{6})(_.*?)?$/', $version, $matches)) {
$version = 'm' . $matches[1];
} else {
throw new Exception("The version argument must be either a timestamp (e.g. 101129_185401)\nor the full name of a migration (e.g. m101129_185401_create_user_table).");
}
$migrations = array_keys($this->getMigrationHistory(null));
foreach ($migrations as $migration) {
if (strpos($migration, $version . '_') === 0) {
if ($this->confirm("Revert the $migration migration?")) {
if (!$this->migrateDown($migration)) {
echo "\nMigration failed.\n";
return self::EXIT_CODE_ERROR;
}
return self::EXIT_CODE_NORMAL;
}
return;
}
}
throw new Exception("Unable to find the version '$originalVersion'.");
}
/**
* Redoes partial migration.
*
* This command will first revert the specified migrations, and then apply
* them again. For example,
*
* ~~~
* yii migrate/partial-redo 101129_185401 # using timestamp
* yii migrate/partial-redo m101129_185401_create_user_table # using full name
* ~~~
*
* @param string $version the version at which the migration history should be marked.
* This can be either the timestamp or the full name of the migration.
* @return int CLI exit code
* @throws Exception if the version argument is invalid or the version cannot be found.
*/
public function actionPartialRedo($version)
{
$originalVersion = $version;
if (preg_match('/^m?(\d{6}_\d{6})(_.*?)?$/', $version, $matches)) {
$version = 'm' . $matches[1];
} else {
throw new Exception("The version argument must be either a timestamp (e.g. 101129_185401)\nor the full name of a migration (e.g. m101129_185401_create_user_table).");
}
$migrations = array_keys($this->getMigrationHistory(null));
foreach ($migrations as $migration) {
if (strpos($migration, $version . '_') === 0) {
if ($this->confirm("Redo the $migration migration?")) {
if (!$this->migrateDown($migration)) {
echo "\nMigration failed.\n";
return self::EXIT_CODE_ERROR;
}
if (!$this->migrateUp($migration)) {
echo "\nMigration failed.\n";
return self::EXIT_CODE_ERROR;
}
return self::EXIT_CODE_NORMAL;
}
return;
}
}
throw new Exception("Unable to find the version '$originalVersion'.");
}
}
Raw
interfaces\IMigrationAware.php
<?php
namespace app\interfaces;
interface IMigrationAware
{
/**
* @return string
*/
public function getMigrationPath();
}
Raw
modules\some\Module.php
<?php
namespace app\modules\some;
use yii\base\Module;
use app\interfaces\IMigrationAware;
class Module extends Module implements IMigrationAware
{
/**
* @inheritDoc
*/
public function getMigrationPath()
{
return __DIR__.'/migrations';
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment