Completed
Pull Request — master (#2412)
by Benoît
20:15
created

_getPortableTableIndexesList()   B

Complexity

Conditions 11
Paths 99

Size

Total Lines 60
Code Lines 36

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 34
CRAP Score 11.0028

Importance

Changes 0
Metric Value
eloc 36
dl 0
loc 60
ccs 34
cts 35
cp 0.9714
rs 7.3166
c 0
b 0
f 0
cc 11
nc 99
nop 2
crap 11.0028

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
namespace Doctrine\DBAL\Schema;
4
5
use Doctrine\DBAL\Connection;
6
use Doctrine\DBAL\ConnectionException;
7
use Doctrine\DBAL\DBALException;
8
use Doctrine\DBAL\Event\SchemaColumnDefinitionEventArgs;
9
use Doctrine\DBAL\Event\SchemaIndexDefinitionEventArgs;
10
use Doctrine\DBAL\Events;
11
use Doctrine\DBAL\Platforms\AbstractPlatform;
12
use Throwable;
13
use function array_filter;
14
use function array_intersect;
15
use function array_map;
16
use function array_values;
17
use function call_user_func_array;
18
use function count;
19
use function func_get_args;
20
use function is_array;
21
use function preg_match;
22
use function str_replace;
23
use function strtolower;
24
25
/**
26
 * Base class for schema managers. Schema managers are used to inspect and/or
27
 * modify the database schema/structure.
28
 */
29
abstract class AbstractSchemaManager
30
{
31
    /**
32
     * Holds instance of the Doctrine connection for this schema manager.
33
     *
34
     * @var Connection
35
     */
36
    protected $_conn;
37
38
    /**
39
     * Holds instance of the database platform used for this schema manager.
40
     *
41
     * @var AbstractPlatform
42
     */
43
    protected $_platform;
44
45
    /**
46
     * Constructor. Accepts the Connection instance to manage the schema for.
47
     */
48 1350
    public function __construct(Connection $conn, ?AbstractPlatform $platform = null)
49
    {
50 1350
        $this->_conn     = $conn;
51 1350
        $this->_platform = $platform ?: $this->_conn->getDatabasePlatform();
52 1350
    }
53
54
    /**
55
     * Returns the associated platform.
56
     *
57
     * @return AbstractPlatform
58
     */
59 383
    public function getDatabasePlatform()
60
    {
61 383
        return $this->_platform;
62
    }
63
64
    /**
65
     * Tries any method on the schema manager. Normally a method throws an
66
     * exception when your DBMS doesn't support it or if an error occurs.
67
     * This method allows you to try and method on your SchemaManager
68
     * instance and will return false if it does not work or is not supported.
69
     *
70
     * <code>
71
     * $result = $sm->tryMethod('dropView', 'view_name');
72
     * </code>
73
     *
74
     * @return mixed
75
     */
76 1863
    public function tryMethod()
77
    {
78 1863
        $args   = func_get_args();
79 1863
        $method = $args[0];
80 1863
        unset($args[0]);
81 1863
        $args = array_values($args);
82
83
        try {
84 1863
            return call_user_func_array([$this, $method], $args);
85 1387
        } catch (Throwable $e) {
86 1387
            return false;
87
        }
88
    }
89
90
    /**
91
     * Lists the available databases for this connection.
92
     *
93
     * @return string[]
94
     */
95 35
    public function listDatabases()
96
    {
97 35
        $sql = $this->_platform->getListDatabasesSQL();
98
99 34
        $databases = $this->_conn->fetchAll($sql);
100
101 34
        return $this->_getPortableDatabasesList($databases);
102
    }
103
104
    /**
105
     * Returns a list of all namespaces in the current database.
106
     *
107
     * @return string[]
108
     */
109 16
    public function listNamespaceNames()
110
    {
111 16
        $sql = $this->_platform->getListNamespacesSQL();
112
113 16
        $namespaces = $this->_conn->fetchAll($sql);
114
115 16
        return $this->getPortableNamespacesList($namespaces);
116
    }
117
118
    /**
119
     * Lists the available sequences for this connection.
120
     *
121
     * @param string|null $database
122
     *
123
     * @return Sequence[]
124
     */
125 53
    public function listSequences($database = null)
126
    {
127 53
        if ($database === null) {
128 53
            $database = $this->_conn->getDatabase();
129
        }
130 53
        $sql = $this->_platform->getListSequencesSQL($database);
131
132 53
        $sequences = $this->_conn->fetchAll($sql);
133
134 53
        return $this->filterAssetNames($this->_getPortableSequencesList($sequences));
135
    }
136
137
    /**
138
     * Lists the columns for a given table.
139
     *
140
     * In contrast to other libraries and to the old version of Doctrine,
141
     * this column definition does try to contain the 'primary' field for
142
     * the reason that it is not portable across different RDBMS. Use
143
     * {@see listTableIndexes($tableName)} to retrieve the primary key
144
     * of a table. We're a RDBMS specifies more details these are held
145
     * in the platformDetails array.
146
     *
147
     * @param string      $table    The name of the table.
148
     * @param string|null $database
149
     *
150
     * @return Column[]
151
     */
152 916
    public function listTableColumns($table, $database = null)
153
    {
154 916
        if (! $database) {
155 915
            $database = $this->_conn->getDatabase();
156
        }
157
158 916
        $sql = $this->_platform->getListTableColumnsSQL($table, $database);
159
160 916
        $tableColumns = $this->_conn->fetchAll($sql);
161
162 916
        return $this->_getPortableTableColumnList($table, $database, $tableColumns);
163
    }
164
165
    /**
166
     * Lists the indexes for a given table returning an array of Index instances.
167
     *
168
     * Keys of the portable indexes list are all lower-cased.
169
     *
170
     * @param string $table The name of the table.
171
     *
172
     * @return Index[]
173
     */
174 692
    public function listTableIndexes($table)
175
    {
176 692
        $sql = $this->_platform->getListTableIndexesSQL($table, $this->_conn->getDatabase());
177
178 692
        $tableIndexes = $this->_conn->fetchAll($sql);
179
180 692
        return $this->_getPortableTableIndexesList($tableIndexes, $table);
181
    }
182
183
    /**
184
     * Returns true if all the given tables exist.
185
     *
186
     * @param string[] $tableNames
187
     *
188
     * @return bool
189
     */
190 1427
    public function tablesExist($tableNames)
191
    {
192 1427
        $tableNames = array_map('strtolower', (array) $tableNames);
193
194 1427
        return count($tableNames) === count(array_intersect($tableNames, array_map('strtolower', $this->listTableNames())));
195
    }
196
197
    /**
198
     * Returns a list of all tables in the current database.
199
     *
200
     * @return string[]
201
     */
202 1431
    public function listTableNames()
203
    {
204 1431
        $sql = $this->_platform->getListTablesSQL();
205
206 1431
        $tables     = $this->_conn->fetchAll($sql);
207 1431
        $tableNames = $this->_getPortableTablesList($tables);
208
209 1431
        return $this->filterAssetNames($tableNames);
210
    }
211
212
    /**
213
     * Filters asset names if they are configured to return only a subset of all
214
     * the found elements.
215
     *
216
     * @param mixed[] $assetNames
217
     *
218
     * @return mixed[]
219
     */
220 1493
    protected function filterAssetNames($assetNames)
221
    {
222 1493
        $filter = $this->_conn->getConfiguration()->getSchemaAssetsFilter();
223 1493
        if (! $filter) {
224 1493
            return $assetNames;
225
        }
226
227 6
        return array_values(array_filter($assetNames, $filter));
228
    }
229
230
    /**
231
     * @deprecated Use Configuration::getSchemaAssetsFilter() instead
232
     *
233
     * @return string|null
234
     */
235
    protected function getFilterSchemaAssetsExpression()
236
    {
237
        return $this->_conn->getConfiguration()->getFilterSchemaAssetsExpression();
1 ignored issue
show
Deprecated Code introduced by
The function Doctrine\DBAL\Configurat...chemaAssetsExpression() has been deprecated: Use Configuration::getSchemaAssetsFilter() instead ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

237
        return /** @scrutinizer ignore-deprecated */ $this->_conn->getConfiguration()->getFilterSchemaAssetsExpression();

This function has been deprecated. The supplier of the function has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the function will be removed and what other function to use instead.

Loading history...
238
    }
239
240
    /**
241
     * Lists the tables for this connection.
242
     *
243
     * @return Table[]
244
     */
245 102
    public function listTables()
246
    {
247 102
        $tableNames = $this->listTableNames();
248
249 102
        $tables = [];
250 102
        foreach ($tableNames as $tableName) {
251 83
            $tables[] = $this->listTableDetails($tableName);
252
        }
253
254 102
        return $tables;
255
    }
256
257
    /**
258
     * @param string $tableName
259
     *
260
     * @return Table
261
     */
262 645
    public function listTableDetails($tableName)
263
    {
264 645
        $columns     = $this->listTableColumns($tableName);
265 645
        $foreignKeys = [];
266 645
        if ($this->_platform->supportsForeignKeyConstraints()) {
267 580
            $foreignKeys = $this->listTableForeignKeys($tableName);
268
        }
269 645
        $indexes = $this->listTableIndexes($tableName);
270
271 645
        return new Table($tableName, $columns, $indexes, $foreignKeys, false, []);
272
    }
273
274
    /**
275
     * Lists the views this connection has.
276
     *
277
     * @return View[]
278
     */
279 19
    public function listViews()
280
    {
281 19
        $database = $this->_conn->getDatabase();
282 19
        $sql      = $this->_platform->getListViewsSQL($database);
283 19
        $views    = $this->_conn->fetchAll($sql);
284
285 19
        return $this->_getPortableViewsList($views);
286
    }
287
288
    /**
289
     * Lists the foreign keys for the given table.
290
     *
291
     * @param string      $table    The name of the table.
292
     * @param string|null $database
293
     *
294
     * @return ForeignKeyConstraint[]
295
     */
296 643
    public function listTableForeignKeys($table, $database = null)
297
    {
298 643
        if ($database === null) {
299 643
            $database = $this->_conn->getDatabase();
300
        }
301 643
        $sql              = $this->_platform->getListTableForeignKeysSQL($table, $database);
0 ignored issues
show
Unused Code introduced by
The call to Doctrine\DBAL\Platforms\...stTableForeignKeysSQL() has too many arguments starting with $database. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

301
        /** @scrutinizer ignore-call */ 
302
        $sql              = $this->_platform->getListTableForeignKeysSQL($table, $database);

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. Please note the @ignore annotation hint above.

Loading history...
302 643
        $tableForeignKeys = $this->_conn->fetchAll($sql);
303
304 643
        return $this->_getPortableTableForeignKeysList($tableForeignKeys);
305
    }
306
307
    /* drop*() Methods */
308
309
    /**
310
     * Drops a database.
311
     *
312
     * NOTE: You can not drop the database this SchemaManager is currently connected to.
313
     *
314
     * @param string $database The name of the database to drop.
315
     *
316
     * @return void
317
     */
318 34
    public function dropDatabase($database)
319
    {
320 34
        $this->_execSql($this->_platform->getDropDatabaseSQL($database));
321 23
    }
322
323
    /**
324
     * Drops the given table.
325
     *
326
     * @param string $tableName The name of the table to drop.
327
     *
328
     * @return void
329
     */
330 2117
    public function dropTable($tableName)
331
    {
332 2117
        $this->_execSql($this->_platform->getDropTableSQL($tableName));
333 1038
    }
334
335
    /**
336
     * Drops the index from the given table.
337
     *
338
     * @param Index|string $index The name of the index.
339
     * @param Table|string $table The name of the table.
340
     *
341
     * @return void
342
     */
343 19
    public function dropIndex($index, $table)
344
    {
345 19
        if ($index instanceof Index) {
346
            $index = $index->getQuotedName($this->_platform);
347
        }
348
349 19
        $this->_execSql($this->_platform->getDropIndexSQL($index, $table));
350 19
    }
351
352
    /**
353
     * Drops the constraint from the given table.
354
     *
355
     * @param Table|string $table The name of the table.
356
     *
357
     * @return void
358
     */
359
    public function dropConstraint(Constraint $constraint, $table)
360
    {
361
        $this->_execSql($this->_platform->getDropConstraintSQL($constraint, $table));
362
    }
363
364
    /**
365
     * Drops a foreign key from a table.
366
     *
367
     * @param ForeignKeyConstraint|string $foreignKey The name of the foreign key.
368
     * @param Table|string                $table      The name of the table with the foreign key.
369
     *
370
     * @return void
371
     */
372
    public function dropForeignKey($foreignKey, $table)
373
    {
374
        $this->_execSql($this->_platform->getDropForeignKeySQL($foreignKey, $table));
375
    }
376
377
    /**
378
     * Drops a sequence with a given name.
379
     *
380
     * @param string $name The name of the sequence to drop.
381
     *
382
     * @return void
383
     */
384 18
    public function dropSequence($name)
385
    {
386 18
        $this->_execSql($this->_platform->getDropSequenceSQL($name));
387
    }
388
389
    /**
390
     * Drops a view.
391
     *
392
     * @param string $name The name of the view.
393
     *
394
     * @return void
395
     */
396 25
    public function dropView($name)
397
    {
398 25
        $this->_execSql($this->_platform->getDropViewSQL($name));
399
    }
400
401
    /* create*() Methods */
402
403
    /**
404
     * Creates a new database.
405
     *
406
     * @param string $database The name of the database to create.
407
     *
408
     * @return void
409
     */
410 32
    public function createDatabase($database)
411
    {
412 32
        $this->_execSql($this->_platform->getCreateDatabaseSQL($database));
413 32
    }
414
415
    /**
416
     * Creates a new table.
417
     *
418
     * @return void
419
     */
420 2745
    public function createTable(Table $table)
421
    {
422 2745
        $createFlags = AbstractPlatform::CREATE_INDEXES|AbstractPlatform::CREATE_FOREIGNKEYS;
423 2745
        $this->_execSql($this->_platform->getCreateTableSQL($table, $createFlags));
424 2052
    }
425
426
    /**
427
     * Creates a new sequence.
428
     *
429
     * @param Sequence $sequence
430
     *
431
     * @return void
432
     *
433
     * @throws ConnectionException If something fails at database level.
434
     */
435 44
    public function createSequence($sequence)
436
    {
437 44
        $this->_execSql($this->_platform->getCreateSequenceSQL($sequence));
438 38
    }
439
440
    /**
441
     * Creates a constraint on a table.
442
     *
443
     * @param Table|string $table
444
     *
445
     * @return void
446
     */
447 1
    public function createConstraint(Constraint $constraint, $table)
448
    {
449 1
        $this->_execSql($this->_platform->getCreateConstraintSQL($constraint, $table));
450 1
    }
451
452
    /**
453
     * Creates a new index on a table.
454
     *
455
     * @param Table|string $table The name of the table on which the index is to be created.
456
     *
457
     * @return void
458
     */
459 19
    public function createIndex(Index $index, $table)
460
    {
461 19
        $this->_execSql($this->_platform->getCreateIndexSQL($index, $table));
462 19
    }
463
464
    /**
465
     * Creates a new foreign key.
466
     *
467
     * @param ForeignKeyConstraint $foreignKey The ForeignKey instance.
468
     * @param Table|string         $table      The name of the table on which the foreign key is to be created.
469
     *
470
     * @return void
471
     */
472 36
    public function createForeignKey(ForeignKeyConstraint $foreignKey, $table)
473
    {
474 36
        $this->_execSql($this->_platform->getCreateForeignKeySQL($foreignKey, $table));
475 36
    }
476
477
    /**
478
     * Creates a new view.
479
     *
480
     * @return void
481
     */
482 25
    public function createView(View $view)
483
    {
484 25
        $this->_execSql($this->_platform->getCreateViewSQL($view->getQuotedName($this->_platform), $view->getSql()));
485 25
    }
486
487
    /* dropAndCreate*() Methods */
488
489
    /**
490
     * Drops and creates a constraint.
491
     *
492
     * @see dropConstraint()
493
     * @see createConstraint()
494
     *
495
     * @param Table|string $table
496
     *
497
     * @return void
498
     */
499
    public function dropAndCreateConstraint(Constraint $constraint, $table)
500
    {
501
        $this->tryMethod('dropConstraint', $constraint, $table);
502
        $this->createConstraint($constraint, $table);
503
    }
504
505
    /**
506
     * Drops and creates a new index on a table.
507
     *
508
     * @param Table|string $table The name of the table on which the index is to be created.
509
     *
510
     * @return void
511
     */
512 19
    public function dropAndCreateIndex(Index $index, $table)
513
    {
514 19
        $this->tryMethod('dropIndex', $index->getQuotedName($this->_platform), $table);
515 19
        $this->createIndex($index, $table);
516 19
    }
517
518
    /**
519
     * Drops and creates a new foreign key.
520
     *
521
     * @param ForeignKeyConstraint $foreignKey An associative array that defines properties of the foreign key to be created.
522
     * @param Table|string         $table      The name of the table on which the foreign key is to be created.
523
     *
524
     * @return void
525
     */
526
    public function dropAndCreateForeignKey(ForeignKeyConstraint $foreignKey, $table)
527
    {
528
        $this->tryMethod('dropForeignKey', $foreignKey, $table);
529
        $this->createForeignKey($foreignKey, $table);
530
    }
531
532
    /**
533
     * Drops and create a new sequence.
534
     *
535
     * @return void
536
     *
537
     * @throws ConnectionException If something fails at database level.
538
     */
539 18
    public function dropAndCreateSequence(Sequence $sequence)
540
    {
541 18
        $this->tryMethod('dropSequence', $sequence->getQuotedName($this->_platform));
542 18
        $this->createSequence($sequence);
543 18
    }
544
545
    /**
546
     * Drops and creates a new table.
547
     *
548
     * @return void
549
     */
550 1268
    public function dropAndCreateTable(Table $table)
551
    {
552 1268
        $this->tryMethod('dropTable', $table->getQuotedName($this->_platform));
553 1268
        $this->createTable($table);
554 1268
    }
555
556
    /**
557
     * Drops and creates a new database.
558
     *
559
     * @param string $database The name of the database to create.
560
     *
561
     * @return void
562
     */
563 35
    public function dropAndCreateDatabase($database)
564
    {
565 35
        $this->tryMethod('dropDatabase', $database);
566 35
        $this->createDatabase($database);
567 35
    }
568
569
    /**
570
     * Drops and creates a new view.
571
     *
572
     * @return void
573
     */
574 25
    public function dropAndCreateView(View $view)
575
    {
576 25
        $this->tryMethod('dropView', $view->getQuotedName($this->_platform));
577 25
        $this->createView($view);
578 25
    }
579
580
    /* alterTable() Methods */
581
582
    /**
583
     * Alters an existing tables schema.
584
     *
585
     * @return void
586
     */
587 346
    public function alterTable(TableDiff $tableDiff)
588
    {
589 346
        $queries = $this->_platform->getAlterTableSQL($tableDiff);
590 346
        if (! is_array($queries) || ! count($queries)) {
591 6
            return;
592
        }
593
594 340
        foreach ($queries as $ddlQuery) {
595 340
            $this->_execSql($ddlQuery);
596
        }
597 340
    }
598
599
    /**
600
     * Renames a given table to another name.
601
     *
602
     * @param string $name    The current name of the table.
603
     * @param string $newName The new name of the table.
604
     *
605
     * @return void
606
     */
607 1
    public function renameTable($name, $newName)
608
    {
609 1
        $tableDiff          = new TableDiff($name);
610 1
        $tableDiff->newName = $newName;
611 1
        $this->alterTable($tableDiff);
612 1
    }
613
614
    /**
615
     * Methods for filtering return values of list*() methods to convert
616
     * the native DBMS data definition to a portable Doctrine definition
617
     */
618
619
    /**
620
     * @param mixed[] $databases
621
     *
622
     * @return string[]
623
     */
624 34
    protected function _getPortableDatabasesList($databases)
625
    {
626 34
        $list = [];
627 34
        foreach ($databases as $value) {
628 34
            $value = $this->_getPortableDatabaseDefinition($value);
629
630 34
            if (! $value) {
631
                continue;
632
            }
633
634 34
            $list[] = $value;
635
        }
636
637 34
        return $list;
638
    }
639
640
    /**
641
     * Converts a list of namespace names from the native DBMS data definition to a portable Doctrine definition.
642
     *
643
     * @param mixed[][] $namespaces The list of namespace names in the native DBMS data definition.
644
     *
645
     * @return string[]
646
     */
647 16
    protected function getPortableNamespacesList(array $namespaces)
648
    {
649 16
        $namespacesList = [];
650
651 16
        foreach ($namespaces as $namespace) {
652 16
            $namespacesList[] = $this->getPortableNamespaceDefinition($namespace);
653
        }
654
655 16
        return $namespacesList;
656
    }
657
658
    /**
659
     * @param mixed $database
660
     *
661
     * @return mixed
662
     */
663
    protected function _getPortableDatabaseDefinition($database)
664
    {
665
        return $database;
666
    }
667
668
    /**
669
     * Converts a namespace definition from the native DBMS data definition to a portable Doctrine definition.
670
     *
671
     * @param mixed[] $namespace The native DBMS namespace definition.
672
     *
673
     * @return mixed
674
     */
675
    protected function getPortableNamespaceDefinition(array $namespace)
676
    {
677
        return $namespace;
678
    }
679
680
    /**
681
     * @param mixed[][] $functions
682
     *
683
     * @return mixed[][]
684
     */
685
    protected function _getPortableFunctionsList($functions)
686
    {
687
        $list = [];
688
        foreach ($functions as $value) {
689
            $value = $this->_getPortableFunctionDefinition($value);
690
691
            if (! $value) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $value of type array<mixed,mixed> is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
692
                continue;
693
            }
694
695
            $list[] = $value;
696
        }
697
698
        return $list;
699
    }
700
701
    /**
702
     * @param mixed[] $function
703
     *
704
     * @return mixed
705
     */
706
    protected function _getPortableFunctionDefinition($function)
707
    {
708
        return $function;
709
    }
710
711
    /**
712
     * @param mixed[][] $triggers
713
     *
714
     * @return mixed[][]
715
     */
716
    protected function _getPortableTriggersList($triggers)
717
    {
718
        $list = [];
719
        foreach ($triggers as $value) {
720
            $value = $this->_getPortableTriggerDefinition($value);
721
722
            if (! $value) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $value of type array<mixed,mixed> is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
723
                continue;
724
            }
725
726
            $list[] = $value;
727
        }
728
729
        return $list;
730
    }
731
732
    /**
733
     * @param mixed[] $trigger
734
     *
735
     * @return mixed
736
     */
737
    protected function _getPortableTriggerDefinition($trigger)
738
    {
739
        return $trigger;
740
    }
741
742
    /**
743
     * @param mixed[][] $sequences
744
     *
745
     * @return Sequence[]
746
     */
747 17
    protected function _getPortableSequencesList($sequences)
748
    {
749 17
        $list = [];
750 17
        foreach ($sequences as $value) {
751 17
            $value = $this->_getPortableSequenceDefinition($value);
752
753 17
            if (! $value) {
754
                continue;
755
            }
756
757 17
            $list[] = $value;
758
        }
759
760 17
        return $list;
761
    }
762
763
    /**
764
     * @param mixed[] $sequence
765
     *
766
     * @return Sequence
767
     *
768
     * @throws DBALException
769
     */
770
    protected function _getPortableSequenceDefinition($sequence)
771
    {
772
        throw DBALException::notSupported('Sequences');
773
    }
774
775
    /**
776
     * Independent of the database the keys of the column list result are lowercased.
777
     *
778
     * The name of the created column instance however is kept in its case.
779
     *
780
     * @param string    $table        The name of the table.
781
     * @param string    $database
782
     * @param mixed[][] $tableColumns
783
     *
784
     * @return Column[]
785
     */
786 916
    protected function _getPortableTableColumnList($table, $database, $tableColumns)
787
    {
788 916
        $eventManager = $this->_platform->getEventManager();
789
790 916
        $list = [];
791 916
        foreach ($tableColumns as $tableColumn) {
792 916
            $column           = null;
793 916
            $defaultPrevented = false;
794
795 916
            if ($eventManager !== null && $eventManager->hasListeners(Events::onSchemaColumnDefinition)) {
796 19
                $eventArgs = new SchemaColumnDefinitionEventArgs($tableColumn, $table, $database, $this->_conn);
797 19
                $eventManager->dispatchEvent(Events::onSchemaColumnDefinition, $eventArgs);
798
799 19
                $defaultPrevented = $eventArgs->isDefaultPrevented();
800 19
                $column           = $eventArgs->getColumn();
801
            }
802
803 916
            if (! $defaultPrevented) {
804 916
                $column = $this->_getPortableTableColumnDefinition($tableColumn);
805
            }
806
807 916
            if (! $column) {
808
                continue;
809
            }
810
811 916
            $name        = strtolower($column->getQuotedName($this->_platform));
812 916
            $list[$name] = $column;
813
        }
814
815 916
        return $list;
816
    }
817
818
    /**
819
     * Gets Table Column Definition.
820
     *
821
     * @param mixed[] $tableColumn
822
     *
823
     * @return Column
824
     */
825
    abstract protected function _getPortableTableColumnDefinition($tableColumn);
826
827
    /**
828
     * Aggregates and groups the index results according to the required data result.
829
     *
830
     * @param mixed[][]   $tableIndexRows
831
     * @param string|null $tableName
832
     *
833
     * @return Index[]
834
     */
835 748
    protected function _getPortableTableIndexesList($tableIndexRows, $tableName = null)
836
    {
837 748
        $result = [];
838 748
        foreach ($tableIndexRows as $tableIndex) {
839 438
            $indexName = $keyName = $tableIndex['key_name'];
840 438
            if ($tableIndex['primary']) {
841 372
                $keyName = 'primary';
842
            }
843 438
            $keyName = strtolower($keyName);
844
845 438
            if (! isset($result[$keyName])) {
846
                $options = [
847 438
                    'lengths' => [],
848
                ];
849
850 438
                if (isset($tableIndex['where'])) {
851 18
                    $options['where'] = $tableIndex['where'];
852
                }
853
854 438
                $result[$keyName] = [
855 438
                    'name' => $indexName,
856
                    'columns' => [],
857 438
                    'unique' => $tableIndex['non_unique'] ? false : true,
858 438
                    'primary' => $tableIndex['primary'],
859 438
                    'flags' => $tableIndex['flags'] ?? [],
860 438
                    'options' => $options,
861
                ];
862
            }
863
864 438
            $result[$keyName]['columns'][]            = $tableIndex['column_name'];
865 438
            $result[$keyName]['options']['lengths'][] = $tableIndex['length'] ?? null;
866
        }
867
868 748
        $eventManager = $this->_platform->getEventManager();
869
870 748
        $indexes = [];
871 748
        foreach ($result as $indexKey => $data) {
872 438
            $index            = null;
873 438
            $defaultPrevented = false;
874
875 438
            if ($eventManager !== null && $eventManager->hasListeners(Events::onSchemaIndexDefinition)) {
876 19
                $eventArgs = new SchemaIndexDefinitionEventArgs($data, $tableName, $this->_conn);
877 19
                $eventManager->dispatchEvent(Events::onSchemaIndexDefinition, $eventArgs);
878
879 19
                $defaultPrevented = $eventArgs->isDefaultPrevented();
880 19
                $index            = $eventArgs->getIndex();
881
            }
882
883 438
            if (! $defaultPrevented) {
884 438
                $index = new Index($data['name'], $data['columns'], $data['unique'], $data['primary'], $data['flags'], $data['options']);
885
            }
886
887 438
            if (! $index) {
888
                continue;
889
            }
890
891 438
            $indexes[$indexKey] = $index;
892
        }
893
894 748
        return $indexes;
895
    }
896
897
    /**
898
     * @param mixed[][] $tables
899
     *
900
     * @return string[]
901
     */
902 1431
    protected function _getPortableTablesList($tables)
903
    {
904 1431
        $list = [];
905 1431
        foreach ($tables as $value) {
906 1412
            $value = $this->_getPortableTableDefinition($value);
907
908 1412
            if (! $value) {
909
                continue;
910
            }
911
912 1412
            $list[] = $value;
913
        }
914
915 1431
        return $list;
916
    }
917
918
    /**
919
     * @param mixed $table
920
     *
921
     * @return string
922
     */
923
    protected function _getPortableTableDefinition($table)
924
    {
925
        return $table;
926
    }
927
928
    /**
929
     * @param mixed[][] $users
930
     *
931
     * @return string[][]
932
     */
933
    protected function _getPortableUsersList($users)
934
    {
935
        $list = [];
936
        foreach ($users as $value) {
937
            $value = $this->_getPortableUserDefinition($value);
938
939
            if (! $value) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $value of type array<mixed,mixed> is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
940
                continue;
941
            }
942
943
            $list[] = $value;
944
        }
945
946
        return $list;
947
    }
948
949
    /**
950
     * @param mixed[] $user
951
     *
952
     * @return mixed[]
953
     */
954
    protected function _getPortableUserDefinition($user)
955
    {
956
        return $user;
957
    }
958
959
    /**
960
     * @param mixed[][] $views
961
     *
962
     * @return View[]
963
     */
964 19
    protected function _getPortableViewsList($views)
965
    {
966 19
        $list = [];
967 19
        foreach ($views as $value) {
968 19
            $view = $this->_getPortableViewDefinition($value);
969
970 19
            if (! $view) {
971
                continue;
972
            }
973
974 19
            $viewName        = strtolower($view->getQuotedName($this->_platform));
975 19
            $list[$viewName] = $view;
976
        }
977
978 19
        return $list;
979
    }
980
981
    /**
982
     * @param mixed[] $view
983
     *
984
     * @return View|false
985
     */
986
    protected function _getPortableViewDefinition($view)
987
    {
988
        return false;
989
    }
990
991
    /**
992
     * @param mixed[][] $tableForeignKeys
993
     *
994
     * @return ForeignKeyConstraint[]
995
     */
996 331
    protected function _getPortableTableForeignKeysList($tableForeignKeys)
997
    {
998 331
        $list = [];
999 331
        foreach ($tableForeignKeys as $value) {
1000 107
            $value = $this->_getPortableTableForeignKeyDefinition($value);
1001
1002 107
            if (! $value) {
1003
                continue;
1004
            }
1005
1006 107
            $list[] = $value;
1007
        }
1008
1009 331
        return $list;
1010
    }
1011
1012
    /**
1013
     * @param mixed $tableForeignKey
1014
     *
1015
     * @return ForeignKeyConstraint
1016
     */
1017
    protected function _getPortableTableForeignKeyDefinition($tableForeignKey)
1018
    {
1019
        return $tableForeignKey;
1020
    }
1021
1022
    /**
1023
     * @param string[]|string $sql
1024
     *
1025
     * @return void
1026
     */
1027 3015
    protected function _execSql($sql)
1028
    {
1029 3015
        foreach ((array) $sql as $query) {
1030 3015
            $this->_conn->executeUpdate($query);
1031
        }
1032 2147
    }
1033
1034
    /**
1035
     * Creates a schema instance for the current database.
1036
     *
1037
     * @return Schema
1038
     */
1039 76
    public function createSchema()
1040
    {
1041 76
        $namespaces = [];
1042
1043 76
        if ($this->_platform->supportsSchemas()) {
1044 8
            $namespaces = $this->listNamespaceNames();
1045
        }
1046
1047 76
        $sequences = [];
1048
1049 76
        if ($this->_platform->supportsSequences()) {
1050 9
            $sequences = $this->listSequences();
1051
        }
1052
1053 76
        $tables = $this->listTables();
1054
1055 76
        return new Schema($tables, $sequences, $this->createSchemaConfig(), $namespaces);
1056
    }
1057
1058
    /**
1059
     * Creates the configuration for this schema.
1060
     *
1061
     * @return SchemaConfig
1062
     */
1063 334
    public function createSchemaConfig()
1064
    {
1065 334
        $schemaConfig = new SchemaConfig();
1066 334
        $schemaConfig->setMaxIdentifierLength($this->_platform->getMaxIdentifierLength());
1067
1068 334
        $searchPaths = $this->getSchemaSearchPaths();
1069 334
        if (isset($searchPaths[0])) {
1070 248
            $schemaConfig->setName($searchPaths[0]);
1071
        }
1072
1073 334
        $params = $this->_conn->getParams();
1074 334
        if (! isset($params['defaultTableOptions'])) {
1075 334
            $params['defaultTableOptions'] = [];
1076
        }
1077 334
        if (! isset($params['defaultTableOptions']['charset']) && isset($params['charset'])) {
1078 19
            $params['defaultTableOptions']['charset'] = $params['charset'];
1079
        }
1080 334
        $schemaConfig->setDefaultTableOptions($params['defaultTableOptions']);
1081
1082 334
        return $schemaConfig;
1083
    }
1084
1085
    /**
1086
     * The search path for namespaces in the currently connected database.
1087
     *
1088
     * The first entry is usually the default namespace in the Schema. All
1089
     * further namespaces contain tables/sequences which can also be addressed
1090
     * with a short, not full-qualified name.
1091
     *
1092
     * For databases that don't support subschema/namespaces this method
1093
     * returns the name of the currently connected database.
1094
     *
1095
     * @return string[]
1096
     */
1097 244
    public function getSchemaSearchPaths()
1098
    {
1099 244
        return [$this->_conn->getDatabase()];
1100
    }
1101
1102
    /**
1103
     * Given a table comment this method tries to extract a typehint for Doctrine Type, or returns
1104
     * the type given as default.
1105
     *
1106
     * @param string $comment
1107
     * @param string $currentType
1108
     *
1109
     * @return string
1110
     */
1111 977
    public function extractDoctrineTypeFromComment($comment, $currentType)
1112
    {
1113 977
        if (preg_match('(\(DC2Type:(((?!\)).)+)\))', $comment, $match)) {
1114 214
            $currentType = $match[1];
1115
        }
1116
1117 977
        return $currentType;
1118
    }
1119
1120
    /**
1121
     * @param string $comment
1122
     * @param string $type
1123
     *
1124
     * @return string
1125
     */
1126 851
    public function removeDoctrineTypeFromComment($comment, $type)
1127
    {
1128 851
        return str_replace('(DC2Type:' . $type . ')', '', $comment);
1129
    }
1130
}
1131