/
ForeignKey.php
121 lines (105 loc) · 2.68 KB
/
ForeignKey.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
<?php
/* ===========================================================================
* Copyright 2018 Zindex Software
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============================================================================ */
namespace Opis\Database\Schema;
class ForeignKey
{
/** @var string */
protected $refTable;
/** @var string[] */
protected $refColumns;
/** @var array */
protected $actions = [];
/** @var string[] */
protected $columns;
/**
* ForeignKey constructor.
* @param string[] $columns
*/
public function __construct(array $columns)
{
$this->columns = $columns;
}
/**
* @param string $on
* @param string $action
* @return $this
*/
protected function addAction(string $on, string $action): self
{
$action = strtoupper($action);
if (!in_array($action, ['RESTRICT', 'CASCADE', 'NO ACTION', 'SET NULL'])) {
return $this;
}
$this->actions[$on] = $action;
return $this;
}
/**
* @return string
*/
public function getReferencedTable(): string
{
return $this->refTable;
}
/**
* @return string[]
*/
public function getReferencedColumns(): array
{
return $this->refColumns;
}
/**
* @return string[]
*/
public function getColumns(): array
{
return $this->columns;
}
/**
* @return array
*/
public function getActions(): array
{
return $this->actions;
}
/**
* @param string $table
* @param string ...$columns
* @return $this
*/
public function references(string $table, string ...$columns): self
{
$this->refTable = $table;
$this->refColumns = $columns;
return $this;
}
/**
* @param string $action
* @return $this
*/
public function onDelete(string $action): self
{
return $this->addAction('ON DELETE', $action);
}
/**
* @param string $action
* @return $this
*/
public function onUpdate(string $action): self
{
return $this->addAction('ON UPDATE', $action);
}
}