|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* Phinx |
|
4
|
|
|
* |
|
5
|
|
|
* (The MIT license) |
|
6
|
|
|
* |
|
7
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy |
|
8
|
|
|
* of this software and associated * documentation files (the "Software"), to |
|
9
|
|
|
* deal in the Software without restriction, including without limitation the |
|
10
|
|
|
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
|
11
|
|
|
* sell copies of the Software, and to permit persons to whom the Software is |
|
12
|
|
|
* furnished to do so, subject to the following conditions: |
|
13
|
|
|
* |
|
14
|
|
|
* The above copyright notice and this permission notice shall be included in |
|
15
|
|
|
* all copies or substantial portions of the Software. |
|
16
|
|
|
* |
|
17
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
18
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
19
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|
20
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
21
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
|
22
|
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS |
|
23
|
|
|
* IN THE SOFTWARE. |
|
24
|
|
|
*/ |
|
25
|
|
|
namespace Phinx\Db\Action; |
|
26
|
|
|
|
|
27
|
|
|
use InvalidArgumentException; |
|
28
|
|
|
use Phinx\Db\Table\ForeignKey; |
|
29
|
|
|
use Phinx\Db\Table\Table; |
|
30
|
|
|
|
|
31
|
|
|
class AddForeignKey extends Action |
|
32
|
|
|
{ |
|
33
|
|
|
|
|
34
|
|
|
/** |
|
35
|
|
|
* The foreign key to add |
|
36
|
|
|
* |
|
37
|
|
|
* @var ForeignKey |
|
38
|
|
|
*/ |
|
39
|
|
|
protected $foreignKey; |
|
40
|
|
|
|
|
41
|
|
|
/** |
|
42
|
|
|
* Constructor |
|
43
|
|
|
* |
|
44
|
|
|
* @param Table $table The table to add the foreign key to |
|
45
|
|
|
* @param ForeignKey $fk The foreign key to add |
|
46
|
|
|
*/ |
|
47
|
|
|
public function __construct(Table $table, ForeignKey $fk) |
|
48
|
|
|
{ |
|
49
|
|
|
parent::__construct($table); |
|
50
|
|
|
$this->foreignKey = $fk; |
|
51
|
|
|
} |
|
52
|
|
|
|
|
53
|
|
|
/** |
|
54
|
|
|
* Creats a new AddForeignKey object after building the foreign key with |
|
55
|
|
|
* the passed attibutes |
|
56
|
|
|
* |
|
57
|
|
|
* @param Table $table The table object to add the foreign key to |
|
58
|
|
|
* @param string|string[] $columns The columns for the foreign key |
|
59
|
|
|
* @param Table|string $referencedTable The table the foreign key references |
|
60
|
|
|
* @param string $referencedColumns The columns in the referenced table |
|
61
|
|
|
* @param array $options Extra options for the foreign key |
|
62
|
|
|
* @param string|null $name The name of the foreing key |
|
63
|
|
|
* @return AddForeignKey |
|
64
|
|
|
*/ |
|
65
|
|
|
public static function build(Table $table, $columns, $referencedTable, $referencedColumns = ['id'], array $options = [], $name = null) |
|
66
|
|
|
{ |
|
67
|
|
|
if (is_string($referencedColumns)) { |
|
68
|
|
|
$referencedColumns = [$referencedColumns]; // str to array |
|
69
|
|
|
} |
|
70
|
|
|
|
|
71
|
|
|
if (is_string($referencedTable)) { |
|
72
|
|
|
$referencedTable = new Table($referencedTable); |
|
73
|
|
|
} |
|
74
|
|
|
|
|
75
|
|
|
$fk = new ForeignKey(); |
|
76
|
|
|
$fk->setReferencedTable($referencedTable) |
|
77
|
|
|
->setColumns($columns) |
|
78
|
|
|
->setReferencedColumns($referencedColumns) |
|
79
|
|
|
->setOptions($options); |
|
80
|
|
|
|
|
81
|
|
|
if ($name !== null) { |
|
82
|
|
|
$fk->setConstraint($name); |
|
83
|
|
|
} |
|
84
|
|
|
|
|
85
|
|
|
return new static($table, $fk); |
|
86
|
|
|
} |
|
87
|
|
|
|
|
88
|
|
|
/** |
|
89
|
|
|
* Returns the foreign key to be added |
|
90
|
|
|
* |
|
91
|
|
|
* @return ForeignKey |
|
92
|
|
|
*/ |
|
93
|
|
|
public function getForeignKey() |
|
94
|
|
|
{ |
|
95
|
|
|
return $this->foreignKey; |
|
96
|
|
|
} |
|
97
|
|
|
} |
|
98
|
|
|
|
cakephp /
phinx
