300 lines
7.9 KiB
PHP
300 lines
7.9 KiB
PHP
<?php
|
|
/*
|
|
* $Id: Builder.php 2939 2007-10-19 14:23:42Z Jonathan.Wage $
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* This software consists of voluntary contributions made by many individuals
|
|
* and is licensed under the LGPL. For more information, see
|
|
* <http://www.phpdoctrine.org>.
|
|
*/
|
|
|
|
/**
|
|
* Doctrine_Builder_Migration
|
|
*
|
|
* @package Doctrine
|
|
* @subpackage Builder
|
|
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
|
|
* @author Jonathan H. Wage <jwage@mac.com>
|
|
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
|
* @link www.phpdoctrine.com
|
|
* @since 1.0
|
|
* @version $Revision: 2939 $
|
|
*/
|
|
class Doctrine_Builder_Migration extends Doctrine_Builder
|
|
{
|
|
/**
|
|
* migrationsPath
|
|
*
|
|
* The path to your migration classes directory
|
|
*
|
|
* @var string
|
|
*/
|
|
private $_migrationsPath = '';
|
|
|
|
/**
|
|
* suffix
|
|
*
|
|
* File suffix to use when writing class definitions
|
|
*
|
|
* @var string $suffix
|
|
*/
|
|
private $_suffix = '.class.php';
|
|
|
|
/**
|
|
* tpl
|
|
*
|
|
* Class template used for writing classes
|
|
*
|
|
* @var $_tpl
|
|
*/
|
|
private static $_tpl;
|
|
|
|
/**
|
|
* __construct
|
|
*
|
|
* @return void
|
|
*/
|
|
public function __construct($migrationsPath = null)
|
|
{
|
|
if ($migrationsPath) {
|
|
$this->setMigrationsPath($migrationsPath);
|
|
}
|
|
|
|
$this->_loadTemplate();
|
|
}
|
|
|
|
/**
|
|
* setMigrationsPath
|
|
*
|
|
* @param string path the path where migration classes are stored and being generated
|
|
* @return
|
|
*/
|
|
public function setMigrationsPath($path)
|
|
{
|
|
Doctrine_Lib::makeDirectories($path);
|
|
|
|
$this->_migrationsPath = $path;
|
|
}
|
|
|
|
/**
|
|
* getMigrationsPath
|
|
*
|
|
* @return string the path where migration classes are stored and being generated
|
|
*/
|
|
public function getMigrationsPath()
|
|
{
|
|
return $this->_migrationsPath;
|
|
}
|
|
|
|
/**
|
|
* loadTemplate
|
|
*
|
|
* Loads the class template used for generating classes
|
|
*
|
|
* @return void
|
|
*/
|
|
protected function _loadTemplate()
|
|
{
|
|
if (isset(self::$_tpl)) {
|
|
return;
|
|
}
|
|
|
|
self::$_tpl =<<<END
|
|
/**
|
|
* This class has been auto-generated by the Doctrine ORM Framework
|
|
*/
|
|
class %s extends %s
|
|
{
|
|
public function up()
|
|
{
|
|
%s
|
|
}
|
|
|
|
public function down()
|
|
{
|
|
%s
|
|
}
|
|
}
|
|
END;
|
|
}
|
|
|
|
/**
|
|
* generateMigrationsFromDb
|
|
*
|
|
* @return void
|
|
*/
|
|
public function generateMigrationsFromDb()
|
|
{
|
|
$directory = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'tmp_doctrine_models';
|
|
|
|
Doctrine::generateModelsFromDb($directory);
|
|
|
|
$result = $this->generateMigrationsFromModels($directory);
|
|
|
|
Doctrine_Lib::removeDirectories($directory);
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* generateMigrationsFromModels
|
|
*
|
|
* @param string $modelsPath
|
|
* @return void
|
|
*/
|
|
public function generateMigrationsFromModels($modelsPath = null)
|
|
{
|
|
if ($modelsPath) {
|
|
$models = Doctrine::loadModels($modelsPath);
|
|
}
|
|
|
|
$models = Doctrine::getLoadedModels();
|
|
|
|
$foreignKeys = array();
|
|
|
|
foreach ($models as $model) {
|
|
$export = Doctrine::getTable($model)->getExportableFormat();
|
|
|
|
$foreignKeys[$export['tableName']] = $export['options']['foreignKeys'];
|
|
|
|
$up = $this->buildCreateTable($export);
|
|
$down = $this->buildDropTable($export);
|
|
|
|
$className = 'Add' . Doctrine::classify($export['tableName']);
|
|
|
|
$this->generateMigrationClass($className, array(), $up, $down);
|
|
}
|
|
|
|
$className = 'ApplyForeignKeyConstraints';
|
|
|
|
$up = '';
|
|
$down = '';
|
|
foreach ($foreignKeys as $tableName => $definitions) {
|
|
$tableForeignKeyNames[$tableName] = array();
|
|
|
|
foreach ($definitions as $definition) {
|
|
$definition['name'] = $tableName . '_' . $definition['foreignTable'] . '_' . $definition['local'] . '_' . $definition['foreign'];
|
|
|
|
$up .= $this->buildCreateForeignKey($tableName, $definition);
|
|
$down .= $this->buildDropForeignKey($tableName, $definition);
|
|
}
|
|
}
|
|
|
|
$this->generateMigrationClass($className, array(), $up, $down);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* buildCreateForeignKey
|
|
*
|
|
* @param string $tableName
|
|
* @param string $definition
|
|
* @return void
|
|
*/
|
|
public function buildCreateForeignKey($tableName, $definition)
|
|
{
|
|
return "\t\t\$this->createForeignKey('" . $tableName . "', " . var_export($definition, true) . ");";
|
|
}
|
|
|
|
/**
|
|
* buildDropForeignKey
|
|
*
|
|
* @param string $tableName
|
|
* @param string $definition
|
|
* @return void
|
|
*/
|
|
public function buildDropForeignKey($tableName, $definition)
|
|
{
|
|
return "\t\t\$this->dropForeignKey('" . $tableName . "', '" . $definition['name'] . "');\n";
|
|
}
|
|
|
|
/**
|
|
* buildCreateTable
|
|
*
|
|
* @param string $tableData
|
|
* @return void
|
|
*/
|
|
public function buildCreateTable($tableData)
|
|
{
|
|
$code = "\t\t\$this->createTable('" . $tableData['tableName'] . "', ";
|
|
|
|
$code .= var_export($tableData['columns'], true) . ", ";
|
|
|
|
$code .= var_export(array('indexes' => $tableData['options']['indexes'], 'primary' => $tableData['options']['primary']), true);
|
|
|
|
$code .= ");";
|
|
|
|
return $code;
|
|
}
|
|
|
|
/**
|
|
* buildDropTable
|
|
*
|
|
* @param string $tableData
|
|
* @return string
|
|
*/
|
|
public function buildDropTable($tableData)
|
|
{
|
|
return "\t\t\$this->dropTable('" . $tableData['tableName'] . "');";
|
|
}
|
|
|
|
/**
|
|
* generateMigrationClass
|
|
*
|
|
* @return void
|
|
*/
|
|
public function generateMigrationClass($className, $options = array(), $up = null, $down = null, $return = false)
|
|
{
|
|
if ($return || !$this->getMigrationsPath()) {
|
|
return $this->buildMigrationClass($className, null, $options, $up, $down);
|
|
} else {
|
|
if ( ! $this->getMigrationsPath()) {
|
|
throw new Doctrine_Migration_Exception('You must specify the path to your migrations.');
|
|
}
|
|
|
|
$migration = new Doctrine_Migration($this->getMigrationsPath());
|
|
$next = (string) $migration->getNextVersion();
|
|
|
|
$fileName = str_repeat('0', (3 - strlen($next))) . $next . '_' . Doctrine::tableize($className) . $this->_suffix;
|
|
|
|
$class = $this->buildMigrationClass($className, $fileName, $options, $up, $down);
|
|
|
|
$path = $this->getMigrationsPath() . DIRECTORY_SEPARATOR . $fileName;
|
|
|
|
file_put_contents($path, $class);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* buildMigrationClass
|
|
*
|
|
* @return string
|
|
*/
|
|
public function buildMigrationClass($className, $fileName = null, $options = array(), $up = null, $down = null)
|
|
{
|
|
$extends = isset($options['extends']) ? $options['extends']:'Doctrine_Migration';
|
|
|
|
$content = '<?php' . PHP_EOL;
|
|
|
|
$content .= sprintf(self::$_tpl, $className,
|
|
$extends,
|
|
$up,
|
|
$down);
|
|
|
|
|
|
return $content;
|
|
}
|
|
}
|