Overview

Namespaces

  • Inlm
    • SchemaGenerator
      • Adapters
      • Bridges
        • PhpCli
      • Diffs
      • Dumpers
      • Extractors
      • Integrations
      • Loggers
      • Utils

Classes

  • Inlm\SchemaGenerator\Adapters\DibiAdapter
  • Inlm\SchemaGenerator\Adapters\MemoryAdapter
  • Inlm\SchemaGenerator\Adapters\NeonAdapter
  • Inlm\SchemaGenerator\Bridges\Dibi
  • Inlm\SchemaGenerator\Bridges\DibiMysql
  • Inlm\SchemaGenerator\Bridges\PhpCli\CreateMigrationCommand
  • Inlm\SchemaGenerator\Bridges\PhpCli\DiffCommand
  • Inlm\SchemaGenerator\Bridges\PhpCli\UpdateDatabaseCommand
  • Inlm\SchemaGenerator\Configuration
  • Inlm\SchemaGenerator\ConfigurationFactory
  • Inlm\SchemaGenerator\ConfigurationSerializer
  • Inlm\SchemaGenerator\Database
  • Inlm\SchemaGenerator\DataType
  • Inlm\SchemaGenerator\DiffGenerator
  • Inlm\SchemaGenerator\Diffs\AddedTableOption
  • Inlm\SchemaGenerator\Diffs\CreatedForeignKey
  • Inlm\SchemaGenerator\Diffs\CreatedTable
  • Inlm\SchemaGenerator\Diffs\CreatedTableColumn
  • Inlm\SchemaGenerator\Diffs\CreatedTableIndex
  • Inlm\SchemaGenerator\Diffs\RemovedForeignKey
  • Inlm\SchemaGenerator\Diffs\RemovedTable
  • Inlm\SchemaGenerator\Diffs\RemovedTableColumn
  • Inlm\SchemaGenerator\Diffs\RemovedTableIndex
  • Inlm\SchemaGenerator\Diffs\RemovedTableOption
  • Inlm\SchemaGenerator\Diffs\UpdatedForeignKey
  • Inlm\SchemaGenerator\Diffs\UpdatedTable
  • Inlm\SchemaGenerator\Diffs\UpdatedTableColumn
  • Inlm\SchemaGenerator\Diffs\UpdatedTableComment
  • Inlm\SchemaGenerator\Diffs\UpdatedTableIndex
  • Inlm\SchemaGenerator\Diffs\UpdatedTableOption
  • Inlm\SchemaGenerator\Dumpers\AbstractSqlDumper
  • Inlm\SchemaGenerator\Dumpers\DibiDumper
  • Inlm\SchemaGenerator\Dumpers\NullDumper
  • Inlm\SchemaGenerator\Dumpers\SqlDumper
  • Inlm\SchemaGenerator\Dumpers\SqlMemoryDumper
  • Inlm\SchemaGenerator\Extractors\DibiExtractor
  • Inlm\SchemaGenerator\Extractors\LeanMapperExtractor
  • Inlm\SchemaGenerator\Extractors\NeonExtractor
  • Inlm\SchemaGenerator\Integrations\AbstractIntegration
  • Inlm\SchemaGenerator\Integrations\LeanMapperIntegration
  • Inlm\SchemaGenerator\Loggers\MemoryLogger
  • Inlm\SchemaGenerator\Loggers\OutputLogger
  • Inlm\SchemaGenerator\SchemaGenerator
  • Inlm\SchemaGenerator\Utils\DataTypeParser
  • Inlm\SchemaGenerator\Utils\DataTypeProcessor
  • Inlm\SchemaGenerator\Utils\Generator
  • Inlm\SchemaGenerator\Utils\GeneratorColumn
  • Inlm\SchemaGenerator\Utils\GeneratorHasManyTable
  • Inlm\SchemaGenerator\Utils\GeneratorIndex
  • Inlm\SchemaGenerator\Utils\GeneratorTable

Interfaces

  • Inlm\SchemaGenerator\IAdapter
  • Inlm\SchemaGenerator\IDumper
  • Inlm\SchemaGenerator\IExtractor
  • Inlm\SchemaGenerator\IIntegration
  • Inlm\SchemaGenerator\ILogger

Exceptions

  • Inlm\SchemaGenerator\DuplicatedException
  • Inlm\SchemaGenerator\EmptyException
  • Inlm\SchemaGenerator\Exception
  • Inlm\SchemaGenerator\FileSystemException
  • Inlm\SchemaGenerator\IncompatibleException
  • Inlm\SchemaGenerator\InvalidArgumentException
  • Inlm\SchemaGenerator\InvalidStateException
  • Inlm\SchemaGenerator\MissingArgumentException
  • Inlm\SchemaGenerator\MissingException
  • Inlm\SchemaGenerator\StaticClassException
  • Inlm\SchemaGenerator\UnsupportedException
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 
<?php

    namespace Inlm\SchemaGenerator\Utils;

    use CzProject\SqlSchema;
    use Inlm\SchemaGenerator\Database;
    use Inlm\SchemaGenerator\DataType;
    use Inlm\SchemaGenerator\DuplicatedException;
    use Inlm\SchemaGenerator\InvalidArgumentException;
    use Inlm\SchemaGenerator\MissingException;
    use Inlm\SchemaGenerator\SchemaGenerator;


    class Generator
    {
        /** @var array */
        private $options;

        /** @var string|NULL */
        private $databaseType;

        /** @var SqlSchema\Schema */
        private $schema;

        /** @var array  [name => GeneratorTable] */
        private $tables = array();

        /** @var array  [name => GeneratorColumn] */
        private $columns = array();

        /** @var array */
        private $indexes = array();

        /** @var array */
        private $relationships = array();

        /** @var array  [name => GeneratorHasManyTable] */
        private $hasManyTables = array();


        public function __construct(array $options = array(), $databaseType = NULL)
        {
            $this->options = $options;
            $this->databaseType = $databaseType;
            $this->schema = new SqlSchema\Schema;
        }


        /**
         * @return SqlSchema\Schema
         */
        public function finalize()
        {
            $this->createHasManyTables();
            $this->createRelationships();

            // tries to create primary indexes
            foreach ($this->tables as $tableName => $table) {
                $primaryColumn = $table->getPrimaryColumn();

                if ($primaryColumn !== NULL && !$this->hasPrimaryIndex($tableName)) {
                    $this->addPrimaryIndex($tableName, $primaryColumn);
                }
            }

            // for Single Table Inheritance - makes some columns nullable
            foreach ($this->columns as $tableName => $columns) {
                if (!isset($this->tables[$tableName])) {
                    continue;
                }

                foreach ($columns as $column) {
                    $definition = $column->getDefinition();

                    if (!$definition->isNullable() && $column->getNumberOfCreation() < $this->tables[$tableName]->getNumberOfCreation()) {
                        $definition->setNullable();
                    }
                }
            }

            return $this->schema;
        }


        /**
         * @param  string
         * @param  string
         * @param  string
         * @param  string
         * @return static
         */
        public function addRelationship($sourceTable, $sourceColumn, $targetTable)
        {
            if (isset($this->relationships[$sourceTable][$sourceColumn])) {
                if ($this->relationships[$sourceTable][$sourceColumn] !== $targetTable) {
                    throw new DuplicatedException("Already exists relationship for column '$sourceTable'.'$sourceColumn'.");
                }
            }

            $this->relationships[$sourceTable][$sourceColumn] = $targetTable;
            return $this;
        }


        /**
         * @param  string
         * @return static
         */
        public function addHasManyTable($tableName, $sourceTable, $sourceColumn, $targetTable, $targetColumn)
        {
            $hasManyTable = new GeneratorHasManyTable($sourceTable, $sourceColumn, $tableName, $targetTable, $targetColumn);

            if (isset($this->hasManyTables[$tableName]) && $this->hasManyTables[$tableName]->hasDifferences($hasManyTable)) {
                throw new DuplicatedException("HasManyTable already exists for different relation.");
            }

            $this->hasManyTables[$tableName] = $hasManyTable;
            $this->addRelationship($tableName, $sourceColumn, $sourceTable);
            $this->addRelationship($tableName, $targetColumn, $targetTable);
            return $this;
        }


        /**
         * @return void
         */
        protected function createHasManyTables()
        {
            foreach ($this->hasManyTables as $hasManyTable => $data) {
                if (!$this->hasTable($hasManyTable)) {
                    $this->createTable($hasManyTable);
                    $this->addColumn($hasManyTable, $data->getSourceColumn(), NULL);
                    $this->addColumn($hasManyTable, $data->getTargetColumn(), NULL);
                    $this->addPrimaryIndex($hasManyTable, array($data->getSourceColumn(), $data->getTargetColumn()));
                    $this->addIndex($hasManyTable, $data->getTargetColumn());
                }
            }
        }


        /**
         * @return void
         */
        protected function createRelationships()
        {
            foreach ($this->relationships as $sourceTable => $sourceColumns) {
                foreach ($sourceColumns as $sourceColumn => $targetTable) {
                    if (!$this->hasTable($sourceTable)) {
                        throw new MissingException("Missing source table '$sourceTable' for relationship '$sourceTable'.'$sourceColumn' => '$targetTable'.");
                    }

                    if (!$this->hasTable($targetTable)) {
                        throw new MissingException("Missing target table '$targetTable' for relationship '$sourceTable'.'$sourceColumn' => '$targetTable'.");
                    }

                    if ($this->tables[$targetTable]->getPrimaryColumn() === NULL) {
                        throw new MissingException("Table '$targetTable' has no primary column.");
                    }

                    $targetColumn = $this->tables[$targetTable]->getPrimaryColumn();

                    $_sourceTable = $this->tables[$sourceTable]->getDefinition();
                    $_sourceColumn = $_sourceTable->getColumn($sourceColumn);

                    $_targetTable = $this->tables[$targetTable]->getDefinition();
                    $_targetColumn = $_targetTable->getColumn($targetColumn);

                    if ($_sourceColumn === NULL) {
                        throw new MissingException("Missing column '$sourceTable'.'$sourceColumn'.");
                    }

                    if ($_targetColumn === NULL) {
                        throw new MissingException("Missing column '$targetTable'.'$targetColumn'.");
                    }

                    $_sourceType = $_sourceColumn->getType();
                    $_targetType = $_targetColumn->getType();

                    if ($_sourceType !== NULL) {
                        throw new DuplicatedException("Column '$sourceTable'.'$sourceColumn' has already data type. Column is required in relationship '$sourceTable'.'$sourceColumn' => '$targetTable'.");
                    }

                    if ($_targetType === NULL) {
                        throw new MissingException("Column '$targetTable'.'$targetColumn' has no data type. Column is required in relationship '$sourceTable'.'$sourceColumn' => '$targetTable'.");
                    }

                    $_sourceColumn->setType($_targetColumn->getType());
                    $_sourceColumn->setParameters($_targetColumn->getParameters());
                    $_sourceColumn->setOptions($_targetColumn->getOptions());

                    $foreignKeyName = $this->formatForeignKey($sourceTable, $sourceColumn);
                    $_sourceTable->addForeignKey(
                        $foreignKeyName,
                        $sourceColumn,
                        $targetTable,
                        $targetColumn
                    );

                    if ($this->databaseType === Database::MYSQL) { // foreign keys requires index
                        if (!$this->hasIndexWithFirstColumn($sourceTable, $sourceColumn)) {
                            $this->addTableIndex($sourceTable, SqlSchema\Index::TYPE_INDEX, $sourceColumn, $foreignKeyName);
                        }
                    }
                }
            }
        }


        /**
         * @param  string
         * @param  string|NULL
         * @return static
         */
        public function createTable($tableName, $primaryColumn = NULL)
        {
            if (!isset($this->tables[$tableName])) {
                $table = $this->schema->addTable($tableName);

                foreach ($this->options as $option => $optionValue) {
                    $table->setOption($option, $optionValue);
                }

                $this->tables[$tableName] = new GeneratorTable($table, $primaryColumn);

            } else {
                if ($this->tables[$tableName]->getPrimaryColumn() !== $primaryColumn) {
                    throw new \RuntimeException("Table '$tableName' already exists with another primary column '{$this->tables[$tableName]->getPrimaryColumn()}'.");
                }
            }

            $this->tables[$tableName]->markAsCreated();
            return $this;
        }


        /**
         * @param  string
         * @return SqlSchema\Table
         */
        protected function getTableDefinition($tableName)
        {
            if (!$this->hasTable($tableName)) {
                throw new MissingException("Missing table '$tableName'.");
            }

            return $this->tables[$tableName]->getDefinition();
        }


        /**
         * @param  string
         * @return bool
         */
        protected function hasTable($tableName)
        {
            return isset($this->tables[$tableName]);
        }


        /**
         * @param  string
         * @param  string|NULL
         * @return static
         */
        public function setTableComment($tableName, $comment)
        {
            $comment = trim($comment);
            $this->getTableDefinition($tableName)->setComment($comment !== '' ? $comment : NULL);
        }


        /**
         * @param  string
         * @param  string
         * @param  string|NULL
         * @return static
         */
        public function setTableOption($tableName, $option, $value)
        {
            $this->getTableDefinition($tableName)->setOption(strtoupper($option), $value !== '' ? $value : NULL);
        }


        /**
         * @param  string
         * @param  string
         * @param  DataType
         * @return static
         */
        public function addColumn($tableName, $columnName, DataType $columnType = NULL)
        {
            if (isset($this->columns[$tableName][$columnName])) {
                $column = $this->columns[$tableName][$columnName]->getDefinition();

                if ($columnType) {
                    $oldType = $column->getType();
                    $oldParameters = $column->getParameters();
                    $oldOptions = $column->getOptions();

                    if ($oldType === NULL && empty($oldParameters) && empty($oldOptions)) { // type is not filled
                        $column->setType($columnType->getType());
                        $column->setParameters($columnType->getParameters());
                        $column->setOptions($columnType->getOptions());

                    } elseif (!$columnType->isCompatible($column->getType(), $column->getParameters(), $column->getOptions())) {
                        throw new InvalidArgumentException("Type is not compatible with column $tableName.$columnName");
                    }
                }

                $this->columns[$tableName][$columnName]->markAsCreated();
                return $column;
            }

            $table = $this->getTableDefinition($tableName);
            $column = $table->addColumn($columnName, NULL, array(), array());

            if ($columnType) {
                $column->setType($columnType->getType());
                $column->setParameters($columnType->getParameters());
                $column->setOptions($columnType->getOptions());
            }

            $this->columns[$tableName][$columnName] = new GeneratorColumn($column);
            $this->columns[$tableName][$columnName]->markAsCreated();
            return $this;
        }


        /**
         * @param  string
         * @param  string
         * @param  bool
         * @return static
         */
        public function setColumnNullable($tableName, $columnName, $isNullable = TRUE)
        {
            $this->getColumnDefinition($tableName, $columnName)->setNullable($isNullable);
            return $this;
        }


        /**
         * @param  string
         * @param  string
         * @param  string|NULL
         * @return static
         */
        public function setColumnComment($tableName, $columnName, $comment)
        {
            $this->getColumnDefinition($tableName, $columnName)->setComment($comment);
            return $this;
        }


        /**
         * @param  string
         * @param  string
         * @param  bool
         * @return static
         */
        public function setColumnAutoIncrement($tableName, $columnName, $isAutoIncrement = TRUE)
        {
            $this->getColumnDefinition($tableName, $columnName)->setAutoIncrement($isAutoIncrement);
            return $this;
        }


        /**
         * @param  string
         * @return SqlSchema\Column
         */
        protected function getColumnDefinition($tableName, $columnName)
        {
            if (!isset($this->columns[$tableName][$columnName])) {
                throw new MissingException("Missing column '$tableName.$columnName'.");
            }

            return $this->columns[$tableName][$columnName]->getDefinition();
        }


        /**
         * @param  string
         * @param  string|string[]
         * @return static
         */
        public function addIndex($tableName, $columns)
        {
            $this->addTableIndex($tableName, SqlSchema\Index::TYPE_INDEX, $columns);
            return $this;
        }


        /**
         * @param  string
         * @param  string|string[]
         * @return static
         */
        public function addUniqueIndex($tableName, $columns)
        {
            $this->addTableIndex($tableName, SqlSchema\Index::TYPE_UNIQUE, $columns);
            return $this;
        }


        /**
         * @param  string
         * @param  string|string[]
         * @return static
         */
        public function addPrimaryIndex($tableName, $columns)
        {
            $this->addTableIndex($tableName, SqlSchema\Index::TYPE_PRIMARY, $columns);
            return $this;
        }


        /**
         * @param  string
         * @return bool
         */
        protected function hasPrimaryIndex($tableName)
        {
            return isset($this->indexes[$tableName][NULL]);
        }


        /**
         * @param  string
         * @param  string
         * @return bool
         */
        protected function hasIndexWithFirstColumn($tableName, $columnName)
        {
            if (!isset($this->indexes[$tableName])) {
                return FALSE;
            }

            foreach ($this->indexes[$tableName] as $indexName => $generatorIndex) {
                $definition = $generatorIndex->getDefinition();

                foreach ($definition->getColumns() as $indexColumn) {
                    if ($indexColumn->getName() === $columnName) {
                        return TRUE;
                    }

                    break;
                }
            }

            return FALSE;
        }


        /**
         * @param  string
         * @param  string
         * @param  string|string[]
         * @param  string|NULL
         * @return void
         */
        protected function addTableIndex($tableName, $type, $columns, $indexName = NULL)
        {
            if ($indexName === NULL) {
                $indexName = $type !== SqlSchema\Index::TYPE_PRIMARY ? $this->formatIndexName($columns) : NULL;
            }

            if (isset($this->indexes[$tableName][$indexName])) {
                $this->indexes[$tableName][$indexName]->checkCompatibility($type, $columns);
                return;
            }

            $table = $this->getTableDefinition($tableName);
            $this->indexes[$tableName][$indexName] = new GeneratorIndex($tableName, $table->addIndex($indexName, $columns, $type));
        }


        /**
         * @param  string|string[]
         * @return string
         */
        protected function formatIndexName($columns)
        {
            if (!is_array($columns)) {
                $columns = array($columns);
            }
            return implode('_', $columns);
        }


        /**
         * @param  string|string[]
         * @return string
         */
        protected function formatForeignKey($table, $columns)
        {
            if (!is_array($columns)) {
                $columns = array($columns);
            }
            return $table . '_fk_' . implode('_', $columns);
        }
    }
inlm/schema-generator v0.6.0 API documentation API documentation generated by ApiGen