-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathEagerLoadable.php
More file actions
314 lines (287 loc) · 7.6 KB
/
Copy pathEagerLoadable.php
File metadata and controls
314 lines (287 loc) · 7.6 KB
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
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\ORM;
/**
* Represents a single level in the associations tree to be eagerly loaded
* for a specific query. This contains all the information required to
* fetch the results from the database from an associations and all its children
* levels.
*
* @internal
*/
class EagerLoadable
{
/**
* The name of the association to load.
*
* @var string
*/
protected $_name;
/**
* A list of other associations to load from this level.
*
* @var \Cake\ORM\EagerLoadable[]
*/
protected $_associations = [];
/**
* The Association class instance to use for loading the records.
*
* @var \Cake\ORM\Association|null
*/
protected $_instance;
/**
* A list of options to pass to the association object for loading
* the records.
*
* @var array
*/
protected $_config = [];
/**
* A dotted separated string representing the path of associations
* that should be followed to fetch this level.
*
* @var string
*/
protected $_aliasPath;
/**
* A dotted separated string representing the path of entity properties
* in which results for this level should be placed.
*
* For example, in the following nested property:
*
* ```
* $article->author->company->country
* ```
*
* The property path of `country` will be `author.company`
*
* @var string|null
*/
protected $_propertyPath;
/**
* Whether or not this level can be fetched using a join.
*
* @var bool
*/
protected $_canBeJoined = false;
/**
* Whether or not this level was meant for a "matching" fetch
* operation
*
* @var bool|null
*/
protected $_forMatching;
/**
* The property name where the association result should be nested
* in the result.
*
* For example, in the following nested property:
*
* ```
* $article->author->company->country
* ```
*
* The target property of `country` will be just `country`
*
* @var string|null
*/
protected $_targetProperty;
/**
* Constructor. The $config parameter accepts the following array
* keys:
*
* - associations
* - instance
* - config
* - canBeJoined
* - aliasPath
* - propertyPath
* - forMatching
* - targetProperty
*
* The keys maps to the settable properties in this class.
*
* @param string $name The Association name.
* @param array $config The list of properties to set.
*/
public function __construct(string $name, array $config = [])
{
$this->_name = $name;
$allowed = [
'associations', 'instance', 'config', 'canBeJoined',
'aliasPath', 'propertyPath', 'forMatching', 'targetProperty',
];
foreach ($allowed as $property) {
if (isset($config[$property])) {
$this->{'_' . $property} = $config[$property];
}
}
}
/**
* Adds a new association to be loaded from this level.
*
* @param string $name The association name.
* @param \Cake\ORM\EagerLoadable $association The association to load.
* @return void
*/
public function addAssociation(string $name, EagerLoadable $association): void
{
$this->_associations[$name] = $association;
}
/**
* Returns the Association class instance to use for loading the records.
*
* @return \Cake\ORM\EagerLoadable[]
*/
public function associations(): array
{
return $this->_associations;
}
/**
* Gets the Association class instance to use for loading the records.
*
* @return \Cake\ORM\Association
* @throws \RuntimeException
*/
public function instance(): Association
{
if ($this->_instance === null) {
throw new \RuntimeException('No instance set.');
}
return $this->_instance;
}
/**
* Gets a dot separated string representing the path of associations
* that should be followed to fetch this level.
*
* @return string
*/
public function aliasPath(): string
{
return $this->_aliasPath;
}
/**
* Gets a dot separated string representing the path of entity properties
* in which results for this level should be placed.
*
* For example, in the following nested property:
*
* ```
* $article->author->company->country
* ```
*
* The property path of `country` will be `author.company`
*
* @return string|null
*/
public function propertyPath(): ?string
{
return $this->_propertyPath;
}
/**
* Sets whether or not this level can be fetched using a join.
*
* @param bool $possible The value to set.
* @return $this
*/
public function setCanBeJoined(bool $possible)
{
$this->_canBeJoined = (bool)$possible;
return $this;
}
/**
* Gets whether or not this level can be fetched using a join.
*
* @return bool
*/
public function canBeJoined(): bool
{
return $this->_canBeJoined;
}
/**
* Sets the list of options to pass to the association object for loading
* the records.
*
* @param array $config The value to set.
* @return $this
*/
public function setConfig(array $config)
{
$this->_config = $config;
return $this;
}
/**
* Gets the list of options to pass to the association object for loading
* the records.
*
* @return array
*/
public function getConfig(): array
{
return $this->_config;
}
/**
* Gets whether or not this level was meant for a
* "matching" fetch operation.
*
* @return bool|null
*/
public function forMatching(): ?bool
{
return $this->_forMatching;
}
/**
* The property name where the result of this association
* should be nested at the end.
*
* For example, in the following nested property:
*
* ```
* $article->author->company->country
* ```
*
* The target property of `country` will be just `country`
*
* @return string|null
*/
public function targetProperty(): ?string
{
return $this->_targetProperty;
}
/**
* Returns a representation of this object that can be passed to
* Cake\ORM\EagerLoader::contain()
*
* @return array
*/
public function asContainArray(): array
{
$associations = [];
foreach ($this->_associations as $assoc) {
$associations += $assoc->asContainArray();
}
$config = $this->_config;
if ($this->_forMatching !== null) {
$config = ['matching' => $this->_forMatching] + $config;
}
return [
$this->_name => [
'associations' => $associations,
'config' => $config,
],
];
}
}