CakeAdapter.php
15.2 KB
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
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
<?php
/**
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Migrations;
use Cake\Database\Connection;
use PDO;
use Phinx\Db\Adapter\AdapterInterface;
use Phinx\Db\Table;
use Phinx\Db\Table\Column;
use Phinx\Db\Table\ForeignKey;
use Phinx\Db\Table\Index;
use Phinx\Migration\MigrationInterface;
use Symfony\Component\Console\Output\OutputInterface;
/**
* Decorates an AdapterInterface in order to proxy some method to the actual
* connection object.
*/
class CakeAdapter implements AdapterInterface
{
/**
* Decorated adapter
*
* @var \Phinx\Db\Adapter\AdapterInterface
*/
protected $adapter;
/**
* Database connection
*
* @var \Cake\Database\Connection
*/
protected $connection;
/**
* Constructor
*
* @param \Phinx\Db\Adapter\AdapterInterface $adapter The original adapter to decorate.
* @param \Cake\Database\Connection $connection The connection to actually use.
*/
public function __construct(AdapterInterface $adapter, Connection $connection)
{
$this->adapter = $adapter;
$this->connection = $connection;
$pdo = $adapter->getConnection();
if ($pdo->getAttribute(PDO::ATTR_ERRMODE) !== PDO::ERRMODE_EXCEPTION) {
$pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
}
$connection->driver()->connection($pdo);
}
/**
* Gets the database connection
*
* @return \PDO
*/
public function getConnection()
{
return $this->adapter->getConnection();
}
/**
* Get all migrated version numbers.
*
* @return array
*/
public function getVersions()
{
return $this->adapter->getVersions();
}
/**
* Set adapter configuration options.
*
* @param array $options
* @return AdapterInterface
*/
public function setOptions(array $options)
{
return $this->adapter->setOptions($options);
}
/**
* Get all adapter options.
*
* @return array
*/
public function getOptions()
{
return $this->adapter->getOptions();
}
/**
* Check if an option has been set.
*
* @param string $name
* @return bool
*/
public function hasOption($name)
{
return $this->adapter->hasOption($name);
}
/**
* Get a single adapter option, or null if the option does not exist.
*
* @param string $name
* @return mixed
*/
public function getOption($name)
{
return $this->adapter->getOption($name);
}
/**
* Sets the console output.
*
* @param OutputInterface $output Output
* @return AdapterInterface
*/
public function setOutput(OutputInterface $output)
{
return $this->adapter->setOutput($output);
}
/**
* Gets the console output.
*
* @return OutputInterface
*/
public function getOutput()
{
return $this->adapter->getOutput();
}
/**
* Sets the command start time
*
* @param int $time
* @return AdapterInterface
*/
public function setCommandStartTime($time)
{
return $this->adapter->setCommandStartTime($time);
}
/**
* Gets the command start time
*
* @return int
*/
public function getCommandStartTime()
{
return $this->adapter->getCommandStartTime();
}
/**
* Start timing a command.
*
* @return void
*/
public function startCommandTimer()
{
$this->adapter->startCommandTimer();
}
/**
* Stop timing the current command and write the elapsed time to the
* output.
*
* @return void
*/
public function endCommandTimer()
{
$this->adapter->endCommandTimer();
}
/**
* Write a Phinx command to the output.
*
* @param string $command Command Name
* @param array $args Command Args
* @return void
*/
public function writeCommand($command, $args = array())
{
$this->adapter->writeCommand($command, $args);
}
/**
* Records a migration being run.
*
* @param MigrationInterface $migration Migration
* @param string $direction Direction
* @param int $startTime Start Time
* @param int $endTime End Time
* @return AdapterInterface
*/
public function migrated(MigrationInterface $migration, $direction, $startTime, $endTime)
{
return $this->adapter->migrated($migration, $direction, $startTime, $endTime);
}
/**
* Does the schema table exist?
*
* @deprecated use hasTable instead.
* @return bool
*/
public function hasSchemaTable()
{
return $this->adapter->hasSchemaTable();
}
/**
* Creates the schema table.
*
* @return void
*/
public function createSchemaTable()
{
$this->adapter->createSchemaTable();
}
/**
* Returns the adapter type.
*
* @return string
*/
public function getAdapterType()
{
return $this->adapter->getAdapterType();
}
/**
* Initializes the database connection.
*
* @throws \RuntimeException When the requested database driver is not installed.
* @return void
*/
public function connect()
{
$this->adapter->connect();
}
/**
* Closes the database connection.
*
* @return void
*/
public function disconnect()
{
$this->adapter->disconnect();
}
/**
* Does the adapter support transactions?
*
* @return bool
*/
public function hasTransactions()
{
return $this->adapter->hasTransactions();
}
/**
* Begin a transaction.
*
* @return void
*/
public function beginTransaction()
{
$this->connection->begin();
}
/**
* Commit a transaction.
*
* @return void
*/
public function commitTransaction()
{
$this->connection->commit();
}
/**
* Rollback a transaction.
*
* @return void
*/
public function rollbackTransaction()
{
$this->connection->rollback();
}
/**
* Executes a SQL statement and returns the number of affected rows.
*
* @param string $sql SQL
* @return int
*/
public function execute($sql)
{
return $this->adapter->execute($sql);
}
/**
* Executes a SQL statement and returns the result as an array.
*
* @param string $sql SQL
* @return array
*/
public function query($sql)
{
return $this->adapter->query($sql);
}
/**
* Executes a query and returns only one row as an array.
*
* @param string $sql SQL
* @return array
*/
public function fetchRow($sql)
{
return $this->adapter->fetchRow($sql);
}
/**
* Executes a query and returns an array of rows.
*
* @param string $sql SQL
* @return array
*/
public function fetchAll($sql)
{
return $this->adapter->fetchAll($sql);
}
/**
* Inserts data into a table.
*
* @param Table $table where to insert data
* @param array $row
* @return void
*/
public function insert(Table $table, $row)
{
$this->adapter->insert($table, $row);
}
/**
* Quotes a table name for use in a query.
*
* @param string $tableName Table Name
* @return string
*/
public function quoteTableName($tableName)
{
return $this->adapter->quoteTableName($tableName);
}
/**
* Quotes a column name for use in a query.
*
* @param string $columnName Table Name
* @return string
*/
public function quoteColumnName($columnName)
{
return $this->adapter->quoteColumnName($columnName);
}
/**
* Checks to see if a table exists.
*
* @param string $tableName Table Name
* @return bool
*/
public function hasTable($tableName)
{
return $this->adapter->hasTable($tableName);
}
/**
* Creates the specified database table.
*
* @param Table $table Table
* @return void
*/
public function createTable(Table $table)
{
$this->adapter->createTable($table);
}
/**
* Renames the specified database table.
*
* @param string $tableName Table Name
* @param string $newName New Name
* @return void
*/
public function renameTable($tableName, $newName)
{
$this->adapter->renameTable($tableName, $newName);
}
/**
* Drops the specified database table.
*
* @param string $tableName Table Name
* @return void
*/
public function dropTable($tableName)
{
$this->adapter->dropTable($tableName);
}
/**
* Returns table columns
*
* @param string $tableName Table Name
* @return Column[]
*/
public function getColumns($tableName)
{
return $this->adapter->getColumns($tableName);
}
/**
* Checks to see if a column exists.
*
* @param string $tableName Table Name
* @param string $columnName Column Name
* @return bool
*/
public function hasColumn($tableName, $columnName)
{
return $this->adapter->hasColumn($tableName, $columnName);
}
/**
* Adds the specified column to a database table.
*
* @param Table $table Table
* @param Column $column Column
* @return void
*/
public function addColumn(Table $table, Column $column)
{
$this->adapter->addColumn($table, $column);
}
/**
* Renames the specified column.
*
* @param string $tableName Table Name
* @param string $columnName Column Name
* @param string $newColumnName New Column Name
* @return void
*/
public function renameColumn($tableName, $columnName, $newColumnName)
{
$this->adapter->renameColumn($tableName, $columnName, $newColumnName);
}
/**
* Change a table column type.
*
* @param string $tableName Table Name
* @param string $columnName Column Name
* @param Column $newColumn New Column
* @return Table
*/
public function changeColumn($tableName, $columnName, Column $newColumn)
{
return $this->adapter->changeColumn($tableName, $columnName, $newColumn);
}
/**
* Drops the specified column.
*
* @param string $tableName Table Name
* @param string $columnName Column Name
* @return void
*/
public function dropColumn($tableName, $columnName)
{
$this->adapter->dropColumn($tableName, $columnName);
}
/**
* Checks to see if an index exists.
*
* @param string $tableName Table Name
* @param mixed $columns Column(s)
* @return bool
*/
public function hasIndex($tableName, $columns)
{
return $this->adapter->hasIndex($tableName, $columns);
}
/**
* Checks to see if an index specified by name exists.
*
* @param string $tableName Table Name
* @param string $indexName
* @return bool
*/
public function hasIndexByName($tableName, $indexName)
{
return $this->adapter->hasIndexByName($tableName, $indexName);
}
/**
* Adds the specified index to a database table.
*
* @param Table $table Table
* @param Index $index Index
* @return void
*/
public function addIndex(Table $table, Index $index)
{
$this->adapter->addIndex($table, $index);
}
/**
* Drops the specified index from a database table.
*
* @param string $tableName
* @param mixed $columns Column(s)
* @return void
*/
public function dropIndex($tableName, $columns)
{
$this->adapter->dropIndex($tableName, $columns);
}
/**
* Drops the index specified by name from a database table.
*
* @param string $tableName
* @param string $indexName
* @return void
*/
public function dropIndexByName($tableName, $indexName)
{
$this->adapter->dropIndexByName($tableName, $indexName);
}
/**
* Checks to see if a foreign key exists.
*
* @param string $tableName
* @param string[] $columns Column(s)
* @param string|null $constraint Constraint name
* @return bool
*/
public function hasForeignKey($tableName, $columns, $constraint = null)
{
return $this->adapter->hasForeignKey($tableName, $columns, $constraint);
}
/**
* Adds the specified foreign key to a database table.
*
* @param Table $table
* @param ForeignKey $foreignKey
* @return void
*/
public function addForeignKey(Table $table, ForeignKey $foreignKey)
{
$this->adapter->addForeignKey($table, $foreignKey);
}
/**
* Drops the specified foreign key from a database table.
* If the adapter property is an instance of the \Phinx\Db\Adapter\SQLiteAdapter,
* a specific method will be called. The original one from Phinx contains a bug
* that can drop a table in certain conditions.
*
* @param string $tableName
* @param string[] $columns Column(s)
* @param string|null $constraint Constraint name
* @return void
*/
public function dropForeignKey($tableName, $columns, $constraint = null)
{
$this->adapter->dropForeignKey($tableName, $columns, $constraint);
}
/**
* Returns an array of the supported Phinx column types.
*
* @return array
*/
public function getColumnTypes()
{
return $this->adapter->getColumnTypes();
}
/**
* Checks that the given column is of a supported type.
*
* @param Column $column
* @return bool
*/
public function isValidColumnType(Column $column)
{
return $this->adapter->isValidColumnType($column);
}
/**
* Converts the Phinx logical type to the adapter's SQL type.
*
* @param string $type
* @param int|null $limit
* @return string
*/
public function getSqlType($type, $limit = null)
{
return $this->adapter->getSqlType($type, $limit);
}
/**
* Creates a new database.
*
* @param string $name Database Name
* @param array $options Options
* @return void
*/
public function createDatabase($name, $options = [])
{
$this->adapter->createDatabase($name, $options);
}
/**
* Checks to see if a database exists.
*
* @param string $name Database Name
* @return bool
*/
public function hasDatabase($name)
{
return $this->adapter->hasDatabase($name);
}
/**
* Drops the specified database.
*
* @param string $name Database Name
* @return void
*/
public function dropDatabase($name)
{
$this->adapter->dropDatabase($name);
}
}