/
Table.php
433 lines (401 loc) · 10.6 KB
/
Table.php
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
<?php
/**
* PHP Version 5.4
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* 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
* @since CakePHP(tm) v 3.0.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
namespace Cake\Database\Schema;
use Cake\Database\Exception;
use Cake\Database\Connection;
/**
* Represents a single table in a database schema.
*
* Can either be populated using the reflection API's
* or by incrementally building an instance using
* methods.
*
* Once created Table instances can be added to
* Schema\Collection objects.
*/
class Table {
/**
* The name of the table
*
* @var string
*/
protected $_table;
/**
* Columns in the table.
*
* @var array
*/
protected $_columns = [];
/**
* Indexes in the table.
*
* @var array
*/
protected $_indexes = [];
/**
* Constraints in the table.
*
* @var array
*/
protected $_constraints = [];
/**
* Options for the table.
*
* @var array
*/
protected $_options = [];
/**
* The valid keys that can be used in a column
* definition.
*
* @var array
*/
protected $_columnKeys = [
'type' => null,
'length' => null,
'precision' => null,
'null' => null,
'default' => null,
'fixed' => null,
'comment' => null,
];
/**
* The valid keys that can be used in an index
* definition.
*
* @var array
*/
protected $_indexKeys = [
'type' => null,
'columns' => [],
'length' => [],
'references' => [],
'update' => 'restrict',
'delete' => 'restrict',
];
/**
* Names of the valid index types.
*
* @var array
*/
protected $_validIndexTypes = [
self::INDEX_INDEX,
self::INDEX_FULLTEXT,
];
/**
* Names of the valid constraint types.
*
* @var array
*/
protected $_validConstraintTypes = [
self::CONSTRAINT_PRIMARY,
self::CONSTRAINT_UNIQUE,
self::CONSTRAINT_FOREIGN,
];
const CONSTRAINT_PRIMARY = 'primary';
const CONSTRAINT_UNIQUE = 'unique';
const CONSTRAINT_FOREIGN = 'foreign';
const INDEX_INDEX = 'index';
const INDEX_FULLTEXT = 'fulltext';
/**
* Constructor.
*
* @param string $table The table name.
* @param array $columns The list of columns for the schema.
*/
public function __construct($table, $columns = array()) {
$this->_table = $table;
foreach ($columns as $field => $definition) {
$this->addColumn($field, $definition);
}
}
/**
* Get the name of the table.
*
* @return string
*/
public function name() {
return $this->_table;
}
/**
* Add a column to the table.
*
* ### Attributes
*
* Columns can have several attributes:
*
* - `type` The type of the column. This should be
* one of CakePHP's abstract types.
* - `length` The length of the column.
* - `precision` The number of decimal places to store
* for float and decimal types.
* - `default` The default value of the column.
* - `null` Whether or not the column can hold nulls.
* - `fixed` Whether or not the column is a fixed length column.
* this is only useful for string colums.
*
* In addition to the above keys, the following keys are
* implemented in some database dialects, but not all:
*
* - `comment` The comment for the column.
*
* @param string $name The name of the column
* @param array $attrs The attributes for the column.
* @return Table $this
*/
public function addColumn($name, $attrs) {
if (is_string($attrs)) {
$attrs = ['type' => $attrs];
}
$attrs = array_intersect_key($attrs, $this->_columnKeys);
$this->_columns[$name] = $attrs + $this->_columnKeys;
return $this;
}
/**
* Get the column names in the table.
*
* @return array
*/
public function columns() {
return array_keys($this->_columns);
}
/**
* Get column data in the table.
*
* @param string $name The column name.
* @return array|null Column data or null.
*/
public function column($name) {
if (!isset($this->_columns[$name])) {
return null;
}
return $this->_columns[$name];
}
/**
* Add an index.
*
* Used to add indexes, and full text indexes in platforms that support
* them.
*
* ### Attributes
*
* - `type` The type of index being added.
* - `columns` The columns in the index.
*
* @param string $name The name of the index.
* @param array $attrs The attributes for the index.
* @return Table $this
* @throws Cake\Database\Exception
*/
public function addIndex($name, $attrs) {
if (is_string($attrs)) {
$attrs = ['type' => $attrs];
}
$attrs = array_intersect_key($attrs, $this->_indexKeys);
$attrs = $attrs + $this->_indexKeys;
unset($attrs['references'], $attrs['update'], $attrs['delete']);
if (!in_array($attrs['type'], $this->_validIndexTypes, true)) {
throw new Exception(__d('cake_dev', 'Invalid index type "%s"', $attrs['type']));
}
foreach ($attrs['columns'] as $field) {
if (empty($this->_columns[$field])) {
throw new Exception(__d('cake_dev', 'Columns used in indexes must already exist.'));
}
}
$this->_indexes[$name] = $attrs;
return $this;
}
/**
* Get the names of all the indexes in the table.
*
* @return array
*/
public function indexes() {
return array_keys($this->_indexes);
}
/**
* Read information about an index based on name.
*
* @param string $name The name of the index.
* @return array|null Array of index data, or null
*/
public function index($name) {
if (!isset($this->_indexes[$name])) {
return null;
}
return $this->_indexes[$name];
}
/**
* Get the column(s) used for the primary key.
*
* @return array|null Column name(s) for the primary key.
* Null will be returned if a table has no primary key.
*/
public function primaryKey() {
foreach ($this->_constraints as $name => $data) {
if ($data['type'] === self::CONSTRAINT_PRIMARY) {
return $data['columns'];
}
}
return null;
}
/**
* Add a constraint.
*
* Used to add constraints to a table. For example primary keys, unique
* keys and foriegn keys.
*
* ### Attributes
*
* - `type` The type of constraint being added.
* - `columns` The columns in the index.
* - `references` The table, column a foreign key references.
* - `update` The behavior on update. Options are 'restrict', `null`, 'cascade', 'none'.
* - `delete` The behavior on delete. Options are 'restrict', `null`, 'cascade', 'none'.
*
* The default for 'update' & 'delete' is 'cascade'.
*
* @param string $name The name of the constraint.
* @param array $attrs The attributes for the constraint.
* @return Table $this
* @throws Cake\Database\Exception
*/
public function addConstraint($name, $attrs) {
if (is_string($attrs)) {
$attrs = ['type' => $attrs];
}
$attrs = array_intersect_key($attrs, $this->_indexKeys);
$attrs = $attrs + $this->_indexKeys;
if (!in_array($attrs['type'], $this->_validConstraintTypes, true)) {
throw new Exception(__d('cake_dev', 'Invalid constraint type "%s"', $attrs['type']));
}
foreach ($attrs['columns'] as $field) {
if (empty($this->_columns[$field])) {
throw new Exception(__d('cake_dev', 'Columns used in constraints must already exist.'));
}
}
if ($attrs['type'] === static::CONSTRAINT_FOREIGN) {
$attrs = $this->_checkForeignKey($attrs);
} else {
unset($attrs['references'], $attrs['update'], $attrs['delete']);
}
$this->_constraints[$name] = $attrs;
return $this;
}
/**
* Helper method to check/validate foreign keys.
*
* @param array $attrs Attributes to set.
* @return array
*/
protected function _checkForeignKey($attrs) {
if (count($attrs['references']) < 2) {
throw new Exception(__d('cake_dev', 'References must contain a table and column.'));
}
$validActions = ['cascade', 'restrict', null, 'none'];
if (!in_array($attrs['update'], $validActions)) {
throw new Exception(__d('cake_dev', 'Update action is invalid.'));
}
if (!in_array($attrs['delete'], $validActions)) {
throw new Exception(__d('cake_dev', 'Delete action is invalid.'));
}
return $attrs;
}
/**
* Get the names of all the constraints in the table.
*
* @return array
*/
public function constraints() {
return array_keys($this->_constraints);
}
/**
* Read information about an constraint based on name.
*
* @param string $name The name of the constraint.
* @return array|null Array of constraint data, or null
*/
public function constraint($name) {
if (!isset($this->_constraints[$name])) {
return null;
}
return $this->_constraints[$name];
}
/**
* Get/set the options for a table.
*
* Table options allow you to set platform specific table level options.
* For example the engine type in MySQL.
*
* @param array|null $options The options to set, or null to read options.
* @return this|array Either the table instance, or an array of options when reading.
*/
public function options($options = null) {
if ($options === null) {
return $this->_options;
}
$this->_options = array_merge($this->_options, $options);
return $this;
}
/**
* Generate the SQL to create the Table.
*
* Uses the connection to access the schema dialect
* to generate platform specific SQL.
*
* @param Connection $connection The connection to generate SQL for
* @return array List of SQL statements to create the table and the
* required indexes.
*/
public function createSql(Connection $connection) {
$dialect = $connection->driver()->schemaDialect();
$columns = $constraints = $indexes = [];
foreach (array_keys($this->_columns) as $name) {
$columns[] = $dialect->columnSql($this, $name);
}
foreach (array_keys($this->_constraints) as $name) {
$constraints[] = $dialect->constraintSql($this, $name);
}
foreach (array_keys($this->_indexes) as $name) {
$indexes[] = $dialect->indexSql($this, $name);
}
return $dialect->createTableSql($this, $columns, $constraints, $indexes);
}
/**
* Generate the SQL to drop a table.
*
* Uses the connection to access the schema dialect to generate platform
* specific SQL.
*
* @param Connection $connection The connection to generate SQL for.
* @return array SQL to drop a table.
*/
public function dropSql(Connection $connection) {
$dialect = $connection->driver()->schemaDialect();
return $dialect->dropTableSql($this);
}
/**
* Generate the SQL statements to truncate a table
*
* @param Connection $connection The connection to generate SQL for.
* @return array SQL to drop a table.
*/
public function truncateSql(Connection $connection) {
$dialect = $connection->driver()->schemaDialect();
return $dialect->truncateTableSql($this);
}
}