doctrine /
dbal
| Total Complexity | 85 |
| Total Lines | 474 |
| Duplicated Lines | 0 % |
| Coverage | 83.33% |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Complex classes like PostgreSqlSchemaManager often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use PostgreSqlSchemaManager, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 32 | class PostgreSqlSchemaManager extends AbstractSchemaManager |
||
| 33 | { |
||
| 34 | /** @var string[] */ |
||
| 35 | private $existingSchemaPaths; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * Gets all the existing schema names. |
||
| 39 | * |
||
| 40 | * @return string[] |
||
| 41 | */ |
||
| 42 | 676 | public function getSchemaNames() |
|
| 43 | { |
||
| 44 | 676 | $statement = $this->_conn->executeQuery("SELECT nspname FROM pg_namespace WHERE nspname !~ '^pg_.*' AND nspname != 'information_schema'"); |
|
| 45 | |||
| 46 | 676 | return $statement->fetchAll(FetchMode::COLUMN); |
|
| 47 | } |
||
| 48 | |||
| 49 | /** |
||
| 50 | * Returns an array of schema search paths. |
||
| 51 | * |
||
| 52 | * This is a PostgreSQL only function. |
||
| 53 | * |
||
| 54 | * @return string[] |
||
| 55 | */ |
||
| 56 | 676 | public function getSchemaSearchPaths() |
|
| 57 | { |
||
| 58 | 676 | $params = $this->_conn->getParams(); |
|
| 59 | 676 | $schema = explode(',', $this->_conn->fetchColumn('SHOW search_path')); |
|
|
Bug
introduced
by
|
|||
| 60 | |||
| 61 | 676 | if (isset($params['user'])) { |
|
| 62 | 676 | $schema = str_replace('"$user"', $params['user'], $schema); |
|
| 63 | } |
||
| 64 | |||
| 65 | 676 | return array_map('trim', $schema); |
|
| 66 | } |
||
| 67 | |||
| 68 | /** |
||
| 69 | * Gets names of all existing schemas in the current users search path. |
||
| 70 | * |
||
| 71 | * This is a PostgreSQL only function. |
||
| 72 | * |
||
| 73 | * @return string[] |
||
| 74 | */ |
||
| 75 | 676 | public function getExistingSchemaSearchPaths() |
|
| 76 | { |
||
| 77 | 676 | if ($this->existingSchemaPaths === null) { |
|
| 78 | 676 | $this->determineExistingSchemaSearchPaths(); |
|
| 79 | } |
||
| 80 | |||
| 81 | 676 | return $this->existingSchemaPaths; |
|
| 82 | } |
||
| 83 | |||
| 84 | /** |
||
| 85 | * Sets or resets the order of the existing schemas in the current search path of the user. |
||
| 86 | * |
||
| 87 | * This is a PostgreSQL only function. |
||
| 88 | * |
||
| 89 | * @return void |
||
| 90 | */ |
||
| 91 | 676 | public function determineExistingSchemaSearchPaths() |
|
| 92 | { |
||
| 93 | 676 | $names = $this->getSchemaNames(); |
|
| 94 | 676 | $paths = $this->getSchemaSearchPaths(); |
|
| 95 | |||
| 96 | $this->existingSchemaPaths = array_filter($paths, static function ($v) use ($names) { |
||
| 97 | 676 | return in_array($v, $names); |
|
| 98 | 676 | }); |
|
| 99 | 676 | } |
|
| 100 | |||
| 101 | /** |
||
| 102 | * {@inheritdoc} |
||
| 103 | */ |
||
| 104 | 676 | public function dropDatabase($database) |
|
| 105 | { |
||
| 106 | try { |
||
| 107 | 676 | parent::dropDatabase($database); |
|
| 108 | 676 | } catch (DriverException $exception) { |
|
| 109 | // If we have a SQLSTATE 55006, the drop database operation failed |
||
| 110 | // because of active connections on the database. |
||
| 111 | // To force dropping the database, we first have to close all active connections |
||
| 112 | // on that database and issue the drop database operation again. |
||
| 113 | 676 | if ($exception->getSQLState() !== '55006') { |
|
| 114 | 676 | throw $exception; |
|
| 115 | } |
||
| 116 | |||
| 117 | 374 | assert($this->_platform instanceof PostgreSqlPlatform); |
|
| 118 | |||
| 119 | 374 | $this->_execSql( |
|
| 120 | [ |
||
| 121 | 374 | $this->_platform->getDisallowDatabaseConnectionsSQL($database), |
|
| 122 | 374 | $this->_platform->getCloseActiveDatabaseConnectionsSQL($database), |
|
| 123 | ] |
||
| 124 | ); |
||
| 125 | |||
| 126 | 374 | parent::dropDatabase($database); |
|
| 127 | } |
||
| 128 | 374 | } |
|
| 129 | |||
| 130 | /** |
||
| 131 | * {@inheritdoc} |
||
| 132 | */ |
||
| 133 | 503 | protected function _getPortableTableForeignKeyDefinition($tableForeignKey) |
|
| 134 | { |
||
| 135 | 503 | $onUpdate = null; |
|
| 136 | 503 | $onDelete = null; |
|
| 137 | 503 | $localColumns = []; |
|
| 138 | 503 | $foreignColumns = []; |
|
| 139 | 503 | $foreignTable = null; |
|
| 140 | |||
| 141 | 503 | if (preg_match('(ON UPDATE ([a-zA-Z0-9]+( (NULL|ACTION|DEFAULT))?))', $tableForeignKey['condef'], $match)) { |
|
| 142 | 496 | $onUpdate = $match[1]; |
|
| 143 | } |
||
| 144 | 503 | if (preg_match('(ON DELETE ([a-zA-Z0-9]+( (NULL|ACTION|DEFAULT))?))', $tableForeignKey['condef'], $match)) { |
|
| 145 | 482 | $onDelete = $match[1]; |
|
| 146 | } |
||
| 147 | |||
| 148 | 503 | if (preg_match('/FOREIGN KEY \((.+)\) REFERENCES (.+)\((.+)\)/', $tableForeignKey['condef'], $values)) { |
|
| 149 | // PostgreSQL returns identifiers that are keywords with quotes, we need them later, don't get |
||
| 150 | // the idea to trim them here. |
||
| 151 | 503 | $localColumns = array_map('trim', explode(',', $values[1])); |
|
| 152 | 503 | $foreignColumns = array_map('trim', explode(',', $values[3])); |
|
| 153 | 503 | $foreignTable = $values[2]; |
|
| 154 | } |
||
| 155 | |||
| 156 | 503 | return new ForeignKeyConstraint( |
|
| 157 | 503 | $localColumns, |
|
| 158 | $foreignTable, |
||
| 159 | $foreignColumns, |
||
| 160 | 503 | $tableForeignKey['conname'], |
|
| 161 | 503 | ['onUpdate' => $onUpdate, 'onDelete' => $onDelete] |
|
| 162 | ); |
||
| 163 | } |
||
| 164 | |||
| 165 | /** |
||
| 166 | * {@inheritdoc} |
||
| 167 | */ |
||
| 168 | protected function _getPortableTriggerDefinition($trigger) |
||
| 169 | { |
||
| 170 | return $trigger['trigger_name']; |
||
| 171 | } |
||
| 172 | |||
| 173 | /** |
||
| 174 | * {@inheritdoc} |
||
| 175 | */ |
||
| 176 | 255 | protected function _getPortableViewDefinition($view) |
|
| 177 | { |
||
| 178 | 255 | return new View($view['schemaname'] . '.' . $view['viewname'], $view['definition']); |
|
| 179 | } |
||
| 180 | |||
| 181 | /** |
||
| 182 | * {@inheritdoc} |
||
| 183 | */ |
||
| 184 | protected function _getPortableUserDefinition($user) |
||
| 185 | { |
||
| 186 | return [ |
||
| 187 | 'user' => $user['usename'], |
||
| 188 | 'password' => $user['passwd'], |
||
| 189 | ]; |
||
| 190 | } |
||
| 191 | |||
| 192 | /** |
||
| 193 | * {@inheritdoc} |
||
| 194 | */ |
||
| 195 | 676 | protected function _getPortableTableDefinition($table) |
|
| 196 | { |
||
| 197 | 676 | $schemas = $this->getExistingSchemaSearchPaths(); |
|
| 198 | 676 | $firstSchema = array_shift($schemas); |
|
| 199 | |||
| 200 | 676 | if ($table['schema_name'] === $firstSchema) { |
|
| 201 | 676 | return $table['table_name']; |
|
| 202 | } |
||
| 203 | |||
| 204 | 503 | return $table['schema_name'] . '.' . $table['table_name']; |
|
| 205 | } |
||
| 206 | |||
| 207 | /** |
||
| 208 | * {@inheritdoc} |
||
| 209 | * |
||
| 210 | * @link http://ezcomponents.org/docs/api/trunk/DatabaseSchema/ezcDbSchemaPgsqlReader.html |
||
| 211 | */ |
||
| 212 | 627 | protected function _getPortableTableIndexesList($tableIndexes, $tableName = null) |
|
| 213 | { |
||
| 214 | 627 | $buffer = []; |
|
| 215 | 627 | foreach ($tableIndexes as $row) { |
|
| 216 | 531 | $colNumbers = array_map('intval', explode(' ', $row['indkey'])); |
|
| 217 | 531 | $columnNameSql = sprintf( |
|
| 218 | 'SELECT attnum, attname FROM pg_attribute WHERE attrelid=%d AND attnum IN (%s) ORDER BY attnum ASC', |
||
| 219 | 531 | $row['indrelid'], |
|
| 220 | 531 | implode(' ,', $colNumbers) |
|
| 221 | ); |
||
| 222 | |||
| 223 | 531 | $stmt = $this->_conn->executeQuery($columnNameSql); |
|
| 224 | 531 | $indexColumns = $stmt->fetchAll(); |
|
| 225 | |||
| 226 | // required for getting the order of the columns right. |
||
| 227 | 531 | foreach ($colNumbers as $colNum) { |
|
| 228 | 531 | foreach ($indexColumns as $colRow) { |
|
| 229 | 531 | if ($colNum !== $colRow['attnum']) { |
|
| 230 | 440 | continue; |
|
| 231 | } |
||
| 232 | |||
| 233 | 531 | $buffer[] = [ |
|
| 234 | 531 | 'key_name' => $row['relname'], |
|
| 235 | 531 | 'column_name' => trim($colRow['attname']), |
|
| 236 | 531 | 'non_unique' => ! $row['indisunique'], |
|
| 237 | 531 | 'primary' => $row['indisprimary'], |
|
| 238 | 531 | 'where' => $row['where'], |
|
| 239 | ]; |
||
| 240 | } |
||
| 241 | } |
||
| 242 | } |
||
| 243 | |||
| 244 | 627 | return parent::_getPortableTableIndexesList($buffer, $tableName); |
|
| 245 | } |
||
| 246 | |||
| 247 | /** |
||
| 248 | * {@inheritdoc} |
||
| 249 | */ |
||
| 250 | 374 | protected function _getPortableDatabaseDefinition($database) |
|
| 253 | } |
||
| 254 | |||
| 255 | /** |
||
| 256 | * {@inheritdoc} |
||
| 257 | */ |
||
| 258 | 367 | protected function _getPortableSequencesList($sequences) |
|
| 259 | { |
||
| 260 | 367 | $sequenceDefinitions = []; |
|
| 261 | |||
| 262 | 367 | foreach ($sequences as $sequence) { |
|
| 263 | 367 | if ($sequence['schemaname'] !== 'public') { |
|
| 264 | 367 | $sequenceName = $sequence['schemaname'] . '.' . $sequence['relname']; |
|
| 265 | } else { |
||
| 266 | 367 | $sequenceName = $sequence['relname']; |
|
| 267 | } |
||
| 268 | |||
| 269 | 367 | $sequenceDefinitions[$sequenceName] = $sequence; |
|
| 270 | } |
||
| 271 | |||
| 272 | 367 | $list = []; |
|
| 273 | |||
| 274 | 367 | foreach ($this->filterAssetNames(array_keys($sequenceDefinitions)) as $sequenceName) { |
|
| 275 | 367 | $list[] = $this->_getPortableSequenceDefinition($sequenceDefinitions[$sequenceName]); |
|
| 276 | } |
||
| 277 | |||
| 278 | 367 | return $list; |
|
| 279 | } |
||
| 280 | |||
| 281 | /** |
||
| 282 | * {@inheritdoc} |
||
| 283 | */ |
||
| 284 | 346 | protected function getPortableNamespaceDefinition(array $namespace) |
|
| 285 | { |
||
| 286 | 346 | return $namespace['nspname']; |
|
| 287 | } |
||
| 288 | |||
| 289 | /** |
||
| 290 | * {@inheritdoc} |
||
| 291 | */ |
||
| 292 | 367 | protected function _getPortableSequenceDefinition($sequence) |
|
| 308 | } |
||
| 309 | |||
| 310 | /** |
||
| 311 | * {@inheritdoc} |
||
| 312 | */ |
||
| 313 | 627 | protected function _getPortableTableColumnDefinition($tableColumn) |
|
| 314 | { |
||
| 315 | 627 | $tableColumn = array_change_key_case($tableColumn, CASE_LOWER); |
|
| 316 | |||
| 317 | 627 | if (strtolower($tableColumn['type']) === 'varchar' || strtolower($tableColumn['type']) === 'bpchar') { |
|
| 318 | // get length from varchar definition |
||
| 319 | 613 | $length = preg_replace('~.*\(([0-9]*)\).*~', '$1', $tableColumn['complete_type']); |
|
| 320 | 613 | $tableColumn['length'] = $length; |
|
| 321 | } |
||
| 322 | |||
| 323 | 627 | $matches = []; |
|
| 324 | |||
| 325 | 627 | $autoincrement = false; |
|
| 326 | 627 | if (preg_match("/^nextval\('(.*)'(::.*)?\)$/", $tableColumn['default'], $matches)) { |
|
| 327 | 524 | $tableColumn['sequence'] = $matches[1]; |
|
| 328 | 524 | $tableColumn['default'] = null; |
|
| 329 | 524 | $autoincrement = true; |
|
| 330 | } |
||
| 331 | |||
| 332 | 627 | if (preg_match("/^['(](.*)[')]::/", $tableColumn['default'], $matches)) { |
|
| 333 | 613 | $tableColumn['default'] = $matches[1]; |
|
| 334 | 627 | } elseif (preg_match('/^NULL::/', $tableColumn['default'])) { |
|
| 335 | 613 | $tableColumn['default'] = null; |
|
| 336 | } |
||
| 337 | |||
| 338 | 627 | $length = $tableColumn['length'] ?? null; |
|
| 339 | 627 | if ($length === '-1' && isset($tableColumn['atttypmod'])) { |
|
| 340 | $length = $tableColumn['atttypmod'] - 4; |
||
| 341 | } |
||
| 342 | 627 | if ((int) $length <= 0) { |
|
| 343 | 627 | $length = null; |
|
| 344 | } |
||
| 345 | 627 | $fixed = null; |
|
| 346 | |||
| 347 | 627 | if (! isset($tableColumn['name'])) { |
|
| 348 | 627 | $tableColumn['name'] = ''; |
|
| 349 | } |
||
| 350 | |||
| 351 | 627 | $precision = null; |
|
| 352 | 627 | $scale = null; |
|
| 353 | 627 | $jsonb = null; |
|
| 354 | |||
| 355 | 627 | $dbType = strtolower($tableColumn['type']); |
|
| 356 | 627 | if (strlen($tableColumn['domain_type']) && ! $this->_platform->hasDoctrineTypeMappingFor($tableColumn['type'])) { |
|
| 357 | 531 | $dbType = strtolower($tableColumn['domain_type']); |
|
| 358 | 531 | $tableColumn['complete_type'] = $tableColumn['domain_complete_type']; |
|
| 359 | } |
||
| 360 | |||
| 361 | 627 | $type = $this->_platform->getDoctrineTypeMapping($dbType); |
|
| 362 | 627 | $type = $this->extractDoctrineTypeFromComment($tableColumn['comment'], $type); |
|
| 363 | 627 | $tableColumn['comment'] = $this->removeDoctrineTypeFromComment($tableColumn['comment'], $type); |
|
| 364 | |||
| 365 | 627 | switch ($dbType) { |
|
| 366 | case 'smallint': |
||
| 367 | case 'int2': |
||
| 368 | 423 | $tableColumn['default'] = $this->fixVersion94NegativeNumericDefaultValue($tableColumn['default']); |
|
| 369 | 423 | $length = null; |
|
| 370 | 423 | break; |
|
| 371 | case 'int': |
||
| 372 | case 'int4': |
||
| 373 | case 'integer': |
||
| 374 | 627 | $tableColumn['default'] = $this->fixVersion94NegativeNumericDefaultValue($tableColumn['default']); |
|
| 375 | 627 | $length = null; |
|
| 376 | 627 | break; |
|
| 377 | case 'bigint': |
||
| 378 | case 'int8': |
||
| 379 | 423 | $tableColumn['default'] = $this->fixVersion94NegativeNumericDefaultValue($tableColumn['default']); |
|
| 380 | 423 | $length = null; |
|
| 381 | 423 | break; |
|
| 382 | case 'bool': |
||
| 383 | case 'boolean': |
||
| 384 | 620 | if ($tableColumn['default'] === 'true') { |
|
| 385 | $tableColumn['default'] = true; |
||
| 386 | } |
||
| 387 | |||
| 388 | 620 | if ($tableColumn['default'] === 'false') { |
|
| 389 | 620 | $tableColumn['default'] = false; |
|
| 390 | } |
||
| 391 | |||
| 392 | 620 | $length = null; |
|
| 393 | 620 | break; |
|
| 394 | case 'text': |
||
| 395 | case '_varchar': |
||
| 396 | case 'varchar': |
||
| 397 | 613 | $tableColumn['default'] = $this->parseDefaultExpression($tableColumn['default']); |
|
| 398 | 613 | $fixed = false; |
|
| 399 | 613 | break; |
|
| 400 | case 'interval': |
||
| 401 | $fixed = false; |
||
| 402 | break; |
||
| 403 | case 'char': |
||
| 404 | case 'bpchar': |
||
| 405 | 447 | $fixed = true; |
|
| 406 | 447 | break; |
|
| 407 | case 'float': |
||
| 408 | case 'float4': |
||
| 409 | case 'float8': |
||
| 410 | case 'double': |
||
| 411 | case 'double precision': |
||
| 412 | case 'real': |
||
| 413 | case 'decimal': |
||
| 414 | case 'money': |
||
| 415 | case 'numeric': |
||
| 416 | 531 | $tableColumn['default'] = $this->fixVersion94NegativeNumericDefaultValue($tableColumn['default']); |
|
| 417 | |||
| 418 | 531 | if (preg_match('([A-Za-z]+\(([0-9]+)\,([0-9]+)\))', $tableColumn['complete_type'], $match)) { |
|
| 419 | 531 | $precision = $match[1]; |
|
| 420 | 531 | $scale = $match[2]; |
|
| 421 | 531 | $length = null; |
|
| 422 | } |
||
| 423 | 531 | break; |
|
| 424 | case 'year': |
||
| 425 | $length = null; |
||
| 426 | break; |
||
| 427 | |||
| 428 | // PostgreSQL 9.4+ only |
||
| 429 | case 'jsonb': |
||
| 430 | 313 | $jsonb = true; |
|
| 431 | 313 | break; |
|
| 432 | } |
||
| 433 | |||
| 434 | 627 | if ($tableColumn['default'] && preg_match("('([^']+)'::)", $tableColumn['default'], $match)) { |
|
| 435 | 613 | $tableColumn['default'] = $match[1]; |
|
| 436 | } |
||
| 437 | |||
| 438 | $options = [ |
||
| 439 | 627 | 'length' => $length, |
|
| 440 | 627 | 'notnull' => (bool) $tableColumn['isnotnull'], |
|
| 441 | 627 | 'default' => $tableColumn['default'], |
|
| 442 | 627 | 'precision' => $precision, |
|
| 443 | 627 | 'scale' => $scale, |
|
| 444 | 627 | 'fixed' => $fixed, |
|
| 445 | 'unsigned' => false, |
||
| 446 | 627 | 'autoincrement' => $autoincrement, |
|
| 447 | 627 | 'comment' => isset($tableColumn['comment']) && $tableColumn['comment'] !== '' |
|
| 448 | 220 | ? $tableColumn['comment'] |
|
| 449 | : null, |
||
| 450 | ]; |
||
| 451 | |||
| 452 | 627 | $column = new Column($tableColumn['field'], Type::getType($type), $options); |
|
| 453 | |||
| 454 | 627 | if (isset($tableColumn['collation']) && ! empty($tableColumn['collation'])) { |
|
| 455 | $column->setPlatformOption('collation', $tableColumn['collation']); |
||
| 456 | } |
||
| 457 | |||
| 458 | 627 | if (in_array($column->getType()->getName(), [Types::JSON_ARRAY, Types::JSON], true)) { |
|
| 459 | 340 | $column->setPlatformOption('jsonb', $jsonb); |
|
| 460 | } |
||
| 461 | |||
| 462 | 627 | return $column; |
|
| 463 | } |
||
| 464 | |||
| 465 | /** |
||
| 466 | * PostgreSQL 9.4 puts parentheses around negative numeric default values that need to be stripped eventually. |
||
| 467 | * |
||
| 468 | * @param mixed $defaultValue |
||
| 469 | * |
||
| 470 | * @return mixed |
||
| 471 | */ |
||
| 472 | 627 | private function fixVersion94NegativeNumericDefaultValue($defaultValue) |
|
| 473 | { |
||
| 474 | 627 | if (strpos($defaultValue, '(') === 0) { |
|
| 475 | 181 | return trim($defaultValue, '()'); |
|
| 476 | } |
||
| 477 | |||
| 478 | 627 | return $defaultValue; |
|
| 479 | } |
||
| 480 | |||
| 481 | /** |
||
| 482 | * Parses a default value expression as given by PostgreSQL |
||
| 483 | */ |
||
| 484 | 613 | private function parseDefaultExpression(?string $default) : ?string |
|
| 491 | } |
||
| 492 | |||
| 493 | 627 | public function listTableDetails($tableName) : Table |
|
| 508 |
Loading history...
