ModuleMigrateController.php

<?php
/**
 * ModuleMigrateController class file
 * @copyright Copyright (c) 2014 Galament
 * @license http://www.yiiframework.com/license/
 */

namespace bariew\moduleMigration;

use yii\console\Application;
use yii\console\controllers\MigrateController;
use yii\console\Exception;
use Yii;

/**
 * Runs migrations from module /migrations folder.
 *
 * @author Pavel Bariev <bariew@yandex.ru>
 */
class ModuleMigrateController extends MigrateController
{
    /**
     * @var array module base paths
     */
    public $allMigrationPaths = [];
    /**
     * @var array paths to migrations like [path => migrationName]
     */
    public $migrationFiles = [];

    public $dumpTemplateFile = '@bariew/moduleMigration/dumpTemplate.php';

    protected $sourceMigrationPath = null;


    /**
     * @inheritdoc
     */
    public function beforeAction($action)
    {
        if (!parent::beforeAction($action)) {
            return false;
        }
        if ($action->id !== 'create' && is_object($this->db->schemaCache)) {
            $this->db->schemaCache->flush();
        }

        $this->sourceMigrationPath = $this->migrationPath;
        if (is_array($this->migrationPath)) {
            $this->allMigrationPaths = array_merge($this->migrationPath, $this->allMigrationPaths);
        } else {
            $this->allMigrationPaths[0] = $this->migrationPath;
        }

        $this->attachModuleMigrations();
        $this->setMigrationFiles();
        return true;
    }

    /**
     * @inheritdoc
     */
    protected function getNewMigrations()
    {
        $result = [];
        foreach ($this->allMigrationPaths as $paths) {
            if (!is_array($paths)) {
                $paths = [$paths];
            }

            foreach ($paths as $path) {
                $this->migrationPath = $path;
                if (!file_exists($path)) {
                    continue;
                }
                $result = array_merge($result, parent::getNewMigrations());
            }
        }
        $this->migrationPath = $this->sourceMigrationPath;
        sort($result);
        return $result;
    }

    /**
     * gets path to migration file
     * @param string $name migration name
     * @param bool|string $path module migrations base path
     * @return string path to migration file
     */
    protected function getMigrationFile($name, $path = false)
    {
        $path = $path ? $path : $this->migrationPath;
        return $path . DIRECTORY_SEPARATOR . $name . '.php';
    }

    /**
     * @inheritdoc
     */
    protected function createMigration($class)
    {
        if (!$file = array_search($class, $this->migrationFiles)) {
            return false;
        }
        require_once($file);
        return new $class(['db' => $this->db]);
    }

    /**
     * creates $allMigrationPaths attribute from module base paths
     */
    protected function attachModuleMigrations()
    {
        foreach (Yii::$app->modules as $name => $config) {
            $basePath = Yii::$app->getModule($name)->basePath;
            $path = $basePath . DIRECTORY_SEPARATOR. 'migrations';
            if (isset($this->migrationPath[0]) && $this->migrationPath[0] == $path) {
                continue;
            }
            if (file_exists($path) && !is_file($path)) {
                $this->allMigrationPaths[$name] = $path;
            }
        }
    }

    /**
     * Creates $migrationFiles array
     * @return array list of migrations like [path=>migrationName]
     */
    protected function setMigrationFiles()
    {
        $result = [];
        foreach ($this->allMigrationPaths as $paths) {
            if (!is_array($paths)) {
                $paths = [$paths];
            }

            foreach ($paths as $path) {
                if (!file_exists($path) || is_file($path)) {
                    continue;
                }
                $handle = opendir($path);
                while (($file = readdir($handle)) !== false) {
                    if ($file === '.' || $file === '..') {
                        continue;
                    }
                    $filePath = $path . DIRECTORY_SEPARATOR . $file;
                    if (preg_match('/^(m(\d{6}_\d{6})_.*?)\.php$/', $file, $matches) && is_file($filePath)) {
                        $result[$filePath] = $matches[1];
                    }
                }
                closedir($handle);
            }
        }
        return $this->migrationFiles = $result;
    }

    /**
     * Migrates current module up.
     * @param string $module module name.
     * @param string|integer $limit migrations limit.
     */
    public function actionModuleUp($module, $limit = 'all')
    {
        $this->setModuleMigrationPaths($module);
        parent::actionUp($limit);
    }

    /**
     * Migrates current module down.
     * @param string $module module name.
     * @param string|integer $limit migrations limit.
     */
    public function actionModuleDown($module, $limit = 'all')
    {
        $this->setModuleMigrationPaths($module);
        parent::actionDown($limit);
    }

    /**
     * Generate any table data migration into @app/migrations folder
     * @param string $table name of table to dump
     * @param int $remove truncate table before migrate/up
     * @throws Exception if no data found
     */
    public function actionDataDump($table, $remove = 1)
    {
        $className = 'm' . gmdate('ymd_His') . '_' . $table . '_dump';
        if (!$data = $this->db->createCommand("SELECT * FROM {{{$table}}}")->queryAll()) {
            throw new Exception("No data found");
        }
        $columns = DbHelper::dataColumns($data);
        $sql = DbHelper::insertUpdate($table, $columns, $data)->getSql();
        $file = $this->migrationPath . DIRECTORY_SEPARATOR . $className . '.php';
        $content = $this->renderFile(Yii::getAlias($this->dumpTemplateFile), compact(
                'className', 'remove', 'sql', 'table'
            ));
        file_put_contents($file, $content);
        echo "New migration created successfully.\n";
    }

    /**
     * Creates a new migration.
     *
     * This command creates a new migration using the available migration template.
     * After using this command, developers should modify the created migration
     * skeleton by filling up the actual migration logic.
     *
     * ~~~
     * yii migrate/create create_user_table
     * yii migrate/create create_user_table module_name
     * ~~~
     *
     * @param string $name the name of the new migration. This should only contain
     * letters, digits and/or underscores.
     * @param string $module name of module for the new migration. Module must exist
     * and contain 'migrations' path
     * @throws Exception if the name argument is invalid.
     */

    public function actionCreate($name, $module = null)
    {
        if (!empty($module)) {
            if (empty($this->allMigrationPaths[$module])) {
                throw new Exception("Module $module does not exist or does not contains 'migrations' directory");
            }
            $this->migrationPath = $this->allMigrationPaths[$module];
        }
        parent::actionCreate($name);
    }

    /**
     * Sets modules array - leaves only module migrations.
     * @param string $module module name.
     */
    protected function setModuleMigrationPaths($module)
    {
        $paths = [Yii::getAlias('@app/runtime/tmp')];
        if (isset($this->allMigrationPaths[$module])) {
            $paths[$module] = $this->allMigrationPaths[$module];
        }
        $this->allMigrationPaths = $paths;
        $this->setMigrationFiles();
    }

    /**
     * @inheritdoc
     */
    protected function getMigrationHistory($limit)
    {
        $history = parent::getMigrationHistory($limit);
        foreach ($history as $name => $time) {
            if (!$this->migrationExists($name)) {
                unset($history[$name]);
            }
        }
        return $history;
    }

    /**
     * Checks if a migration exists
     * @param string $name the name of the migration to check for.
     * @return bool
     */
    protected function migrationExists($name)
    {
        return in_array($name, $this->migrationFiles);
    }

    public function stderr($string)
    {
        return Yii::$app instanceof Application
            ? parent::stderr($string)
            : true;
    }

    public function stdout($string)
    {
        return Yii::$app instanceof Application
            ? parent::stdout($string)
            : true;
    }
}