1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* Cycle ORM Schema Builder. |
4
|
|
|
* |
5
|
|
|
* @license MIT |
6
|
|
|
* @author Anton Titov (Wolfy-J) |
7
|
|
|
*/ |
8
|
|
|
declare(strict_types=1); |
9
|
|
|
|
10
|
|
|
namespace Cycle\Schema\Relation; |
11
|
|
|
|
12
|
|
|
use Cycle\ORM\Relation; |
13
|
|
|
use Cycle\Schema\Exception\RelationException; |
14
|
|
|
use Cycle\Schema\InversableInterface; |
15
|
|
|
use Cycle\Schema\Registry; |
16
|
|
|
use Cycle\Schema\Relation\Traits\FieldTrait; |
17
|
|
|
use Cycle\Schema\Relation\Traits\ForeignKeyTrait; |
18
|
|
|
use Cycle\Schema\RelationInterface; |
19
|
|
|
|
20
|
|
|
final class ManyToMany extends RelationSchema implements InversableInterface |
21
|
|
|
{ |
22
|
|
|
use FieldTrait, ForeignKeyTrait; |
23
|
|
|
|
24
|
|
|
// internal relation type |
25
|
|
|
protected const RELATION_TYPE = Relation::MANY_TO_MANY; |
26
|
|
|
|
27
|
|
|
// relation schema options |
28
|
|
|
protected const RELATION_SCHEMA = [ |
29
|
|
|
// save with parent |
30
|
|
|
Relation::CASCADE => true, |
31
|
|
|
|
32
|
|
|
// do not pre-load relation by default |
33
|
|
|
Relation::LOAD => null, |
34
|
|
|
|
35
|
|
|
// nullable by default |
36
|
|
|
Relation::NULLABLE => true, |
37
|
|
|
|
38
|
|
|
// custom where condition |
39
|
|
|
Relation::WHERE => [], |
40
|
|
|
|
41
|
|
|
// inner key of parent record will be used to fill "THOUGHT_INNER_KEY" in pivot table |
42
|
|
|
Relation::INNER_KEY => '{source:primaryKey}', |
43
|
|
|
|
44
|
|
|
// we are going to use primary key of outer table to fill "THOUGHT_OUTER_KEY" in pivot table |
45
|
|
|
// this is technically "inner" key of outer record, we will name it "outer key" for simplicity |
46
|
|
|
Relation::OUTER_KEY => '{target:primaryKey}', |
47
|
|
|
|
48
|
|
|
// thought entity role name |
49
|
|
|
Relation::THOUGH_ENTITY => null, |
50
|
|
|
|
51
|
|
|
// name field where parent record inner key will be stored in pivot table, role + innerKey |
52
|
|
|
// by default |
53
|
|
|
Relation::THOUGH_INNER_KEY => '{source:role}_{innerKey}', |
54
|
|
|
|
55
|
|
|
// name field where inner key of outer record (outer key) will be stored in pivot table, |
56
|
|
|
// role + outerKey by default |
57
|
|
|
Relation::THOUGH_OUTER_KEY => '{target:role}_{outerKey}', |
58
|
|
|
|
59
|
|
|
// custom pivot where |
60
|
|
|
Relation::THOUGH_WHERE => [], |
61
|
|
|
|
62
|
|
|
// rendering options |
63
|
|
|
RelationSchema::INDEX_CREATE => true, |
64
|
|
|
RelationSchema::FK_CREATE => true, |
65
|
|
|
RelationSchema::FK_ACTION => 'CASCADE' |
66
|
|
|
]; |
67
|
|
|
|
68
|
|
|
/** |
69
|
|
|
* @param Registry $registry |
70
|
|
|
*/ |
71
|
|
|
public function compute(Registry $registry) |
72
|
|
|
{ |
73
|
|
|
parent::compute($registry); |
74
|
|
|
|
75
|
|
|
$source = $registry->getEntity($this->source); |
76
|
|
|
$target = $registry->getEntity($this->target); |
77
|
|
|
|
78
|
|
|
$thought = $registry->getEntity($this->options->get(Relation::THOUGH_ENTITY)); |
79
|
|
|
|
80
|
|
|
if ($registry->getDatabase($source) !== $registry->getDatabase($target)) { |
81
|
|
|
throw new RelationException(sprintf( |
82
|
|
|
"Relation ManyToMany can only link entities from same database (%s, %s)", |
83
|
|
|
$source->getRole(), |
84
|
|
|
$target->getRole() |
85
|
|
|
)); |
86
|
|
|
} |
87
|
|
|
|
88
|
|
|
if ($registry->getDatabase($source) !== $registry->getDatabase($thought)) { |
89
|
|
|
throw new RelationException(sprintf( |
90
|
|
|
"Relation ManyToMany can only link entities from same database (%s, %s)", |
91
|
|
|
$source->getRole(), |
92
|
|
|
$thought->getRole() |
93
|
|
|
)); |
94
|
|
|
} |
95
|
|
|
|
96
|
|
|
$this->ensureField( |
97
|
|
|
$thought, |
98
|
|
|
$this->options->get(Relation::THOUGH_INNER_KEY), |
99
|
|
|
$this->getField($source, Relation::INNER_KEY), |
100
|
|
|
$this->options->get(Relation::NULLABLE) |
|
|
|
|
101
|
|
|
); |
102
|
|
|
|
103
|
|
|
$this->ensureField( |
104
|
|
|
$thought, |
105
|
|
|
$this->options->get(Relation::THOUGH_OUTER_KEY), |
106
|
|
|
$this->getField($target, Relation::OUTER_KEY), |
107
|
|
|
$this->options->get(Relation::NULLABLE) |
108
|
|
|
); |
109
|
|
|
} |
110
|
|
|
|
111
|
|
|
/** |
112
|
|
|
* @param Registry $registry |
113
|
|
|
*/ |
114
|
|
|
public function render(Registry $registry) |
115
|
|
|
{ |
116
|
|
|
$source = $registry->getEntity($this->source); |
117
|
|
|
$target = $registry->getEntity($this->target); |
118
|
|
|
|
119
|
|
|
$thought = $registry->getEntity($this->options->get(Relation::THOUGH_ENTITY)); |
120
|
|
|
|
121
|
|
|
$sourceField = $this->getField($source, Relation::INNER_KEY); |
122
|
|
|
$targetField = $this->getField($target, Relation::OUTER_KEY); |
123
|
|
|
|
124
|
|
|
$thoughtSourceField = $this->getField($thought, Relation::THOUGH_INNER_KEY); |
125
|
|
|
$thoughtTargetField = $this->getField($thought, Relation::THOUGH_OUTER_KEY); |
126
|
|
|
|
127
|
|
|
$table = $registry->getTableSchema($thought); |
128
|
|
|
|
129
|
|
|
if ($this->options->get(self::INDEX_CREATE)) { |
130
|
|
|
$table->index([ |
131
|
|
|
$thoughtSourceField->getColumn(), |
132
|
|
|
$thoughtTargetField->getColumn() |
133
|
|
|
])->unique(true); |
134
|
|
|
} |
135
|
|
|
|
136
|
|
|
if ($this->options->get(self::FK_CREATE)) { |
137
|
|
|
$this->createForeignKey($registry, $source, $thought, $sourceField, $thoughtSourceField); |
138
|
|
|
$this->createForeignKey($registry, $target, $thought, $targetField, $thoughtTargetField); |
139
|
|
|
} |
140
|
|
|
} |
141
|
|
|
|
142
|
|
|
/** |
143
|
|
|
* @param Registry $registry |
144
|
|
|
* @return array |
145
|
|
|
*/ |
146
|
|
|
public function inverseTargets(Registry $registry): array |
147
|
|
|
{ |
148
|
|
|
return [ |
149
|
|
|
$registry->getEntity($this->target) |
150
|
|
|
]; |
151
|
|
|
} |
152
|
|
|
|
153
|
|
|
/** |
154
|
|
|
* @param RelationInterface $relation |
155
|
|
|
* @param string $into |
156
|
|
|
* @param int|null $load |
157
|
|
|
* @return RelationInterface |
158
|
|
|
* |
159
|
|
|
* @throws RelationException |
160
|
|
|
*/ |
161
|
|
|
public function inverseRelation(RelationInterface $relation, string $into, ?int $load = null): RelationInterface |
162
|
|
|
{ |
163
|
|
|
if (!$relation instanceof self) { |
164
|
|
|
throw new RelationException("ManyToMany relation can only be inversed into ManyToMany"); |
165
|
|
|
} |
166
|
|
|
|
167
|
|
|
if (!empty($this->options->get(Relation::THOUGH_WHERE)) || !empty($this->options->get(Relation::WHERE))) { |
168
|
|
|
throw new RelationException("Unable to inverse ManyToMany relation with where constrain"); |
169
|
|
|
} |
170
|
|
|
|
171
|
|
|
return $relation->withContext( |
172
|
|
|
$into, |
173
|
|
|
$this->target, |
174
|
|
|
$this->source, |
175
|
|
|
$this->options->withOptions([ |
176
|
|
|
Relation::LOAD => $load, |
177
|
|
|
Relation::INNER_KEY => $this->options->get(Relation::OUTER_KEY), |
178
|
|
|
Relation::OUTER_KEY => $this->options->get(Relation::INNER_KEY), |
179
|
|
|
Relation::THOUGH_INNER_KEY => $this->options->get(Relation::THOUGH_OUTER_KEY), |
180
|
|
|
Relation::THOUGH_OUTER_KEY => $this->options->get(Relation::THOUGH_INNER_KEY), |
181
|
|
|
]) |
182
|
|
|
); |
183
|
|
|
} |
184
|
|
|
} |