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
|
<?php
namespace ipl\Orm;
use ArrayIterator;
use ipl\Orm\Exception\InvalidRelationException;
use ipl\Orm\Relation\BelongsTo;
use ipl\Orm\Relation\BelongsToMany;
use ipl\Orm\Relation\HasMany;
use ipl\Orm\Relation\HasOne;
use IteratorAggregate;
use Traversable;
use function ipl\Stdlib\get_php_type;
/**
* Collection of a model's relations.
*/
class Relations implements IteratorAggregate
{
/** @var Relation[] */
protected $relations = [];
/**
* Get whether a relation with the given name exists
*
* @param string $name
*
* @return bool
*/
public function has($name)
{
return isset($this->relations[$name]);
}
/**
* Get the relation with the given name
*
* @param string $name
*
* @return Relation
*
* @throws \InvalidArgumentException If the relation with the given name does not exist
*/
public function get($name)
{
$this->assertRelationExists($name);
return $this->relations[$name];
}
/**
* Add the given relation to the collection
*
* @param Relation $relation
*
* @return $this
*
* @throws \InvalidArgumentException If a relation with the given name already exists
*/
public function add(Relation $relation)
{
$name = $relation->getName();
$this->assertRelationDoesNotYetExist($name);
$this->relations[$name] = $relation;
return $this;
}
/**
* Create a new relation from the given class, name and target model class
*
* @param string $class Class of the relation to create
* @param string $name Name of the relation
* @param string $targetClass Target model class
*
* @return BelongsTo|BelongsToMany|HasMany|HasOne|Relation
*
* @throws \InvalidArgumentException If the target model class is not of type string
*/
public function create($class, $name, $targetClass)
{
$relation = new $class();
if (! $relation instanceof Relation) {
throw new \InvalidArgumentException(sprintf(
'%s() expects parameter 1 to be a subclass of %s, %s given',
__METHOD__,
Relation::class,
get_php_type($relation)
));
}
// Test target model
$target = new $targetClass();
if (! $target instanceof Model) {
throw new \InvalidArgumentException(sprintf(
'%s() expects parameter 3 to be a subclass of %s, %s given',
__METHOD__,
Model::class,
get_php_type($target)
));
}
/** @var Relation $relation */
$relation
->setName($name)
->setTarget($target)
->setTargetClass($targetClass);
return $relation;
}
/**
* Define a one-to-one relationship
*
* @param string $name Name of the relation
* @param string $targetClass Target model class
*
* @return HasOne
*/
public function hasOne($name, $targetClass)
{
$relation = $this->create(HasOne::class, $name, $targetClass);
$this->add($relation);
return $relation;
}
/**
* Define a one-to-many relationship
*
* @param string $name Name of the relation
* @param string $targetClass Target model class
*
* @return HasMany
*/
public function hasMany($name, $targetClass)
{
$relation = $this->create(HasMany::class, $name, $targetClass);
$this->add($relation);
return $relation;
}
/**
* Define the inverse of a one-to-one or one-to-many relationship
*
* @param string $name Name of the relation
* @param string $targetClass Target model class
*
* @return BelongsTo
*/
public function belongsTo($name, $targetClass)
{
$relation = $this->create(BelongsTo::class, $name, $targetClass);
$this->add($relation);
return $relation;
}
/**
* Define a many-to-many relationship
*
* @param string $name Name of the relation
* @param string $targetClass Target model class
*
* @return BelongsToMany
*/
public function belongsToMany($name, $targetClass)
{
$relation = $this->create(BelongsToMany::class, $name, $targetClass);
$this->add($relation);
return $relation;
}
public function getIterator(): Traversable
{
return new ArrayIterator($this->relations);
}
/**
* Throw exception if a relation with the given name already exists
*
* @param string $name
*/
protected function assertRelationDoesNotYetExist($name)
{
if ($this->has($name)) {
throw new \InvalidArgumentException("Relation '$name' already exists");
}
}
/**
* Throw exception if a relation with the given name does not exist
*
* @param string $name
*/
protected function assertRelationExists($name)
{
if (! $this->has($name)) {
throw new InvalidRelationException($name);
}
}
}
|
