1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
|
4
|
|
|
namespace Arrilot\BitrixModels\Queries; |
5
|
|
|
|
6
|
|
|
|
7
|
|
|
use Arrilot\BitrixModels\Models\BaseBitrixModel; |
8
|
|
|
use Illuminate\Support\Collection; |
9
|
|
|
|
10
|
|
|
/** |
11
|
|
|
* BaseRelationQuery содержит основные методы и свойства для загрузки релейшенов |
12
|
|
|
* |
13
|
|
|
* @method BaseBitrixModel first() |
14
|
|
|
* @method Collection|BaseBitrixModel[] getList() |
15
|
|
|
* @property array $select |
16
|
|
|
*/ |
17
|
|
|
trait BaseRelationQuery |
18
|
|
|
{ |
19
|
|
|
/** |
20
|
|
|
* @var bool - когда запрос представляет связь с один-ко-многим. Если true, вернуться все найденные модели, иначе только первая |
21
|
|
|
*/ |
22
|
|
|
public $multiple; |
23
|
|
|
/** |
24
|
|
|
* @var string - настройка связи моделей. ключ_у_связанной_модели |
25
|
|
|
*/ |
26
|
|
|
public $foreignKey; |
27
|
|
|
/** |
28
|
|
|
* @var string - настройка связи моделей. ключ_у_текущей_модели |
29
|
|
|
*/ |
30
|
|
|
public $localKey; |
31
|
|
|
/** |
32
|
|
|
* @var BaseBitrixModel - модель, для которой производится загрузка релейшена |
33
|
|
|
*/ |
34
|
|
|
public $primaryModel; |
35
|
|
|
/** |
36
|
|
|
* @var array - список связей, которые должны быть подгружены при выполнении запроса |
37
|
|
|
*/ |
38
|
|
|
public $with; |
39
|
|
|
/** |
40
|
|
|
* @var string - название отношения, обратное текущему отношению |
41
|
|
|
*/ |
42
|
|
|
public $inverseOf; |
43
|
|
|
|
44
|
|
|
/** |
45
|
|
|
* Установить название отношения, обратное текущему отношению |
46
|
|
|
* |
47
|
|
|
* @param string $relationName |
48
|
|
|
* @return $this |
49
|
|
|
*/ |
50
|
|
|
public function inverseOf($relationName) |
51
|
|
|
{ |
52
|
|
|
$this->inverseOf = $relationName; |
53
|
|
|
return $this; |
54
|
|
|
} |
55
|
|
|
|
56
|
|
|
/** |
57
|
|
|
* Найти связанные записи для определенной модели [[$this->primaryModel]] |
58
|
|
|
* Этот метод вызывается когда релейшн вызывается ленивой загрузкой $model->relation |
59
|
|
|
* @return Collection|BaseBitrixModel[]|BaseBitrixModel - связанные модели |
60
|
|
|
* @throws \Exception |
61
|
|
|
*/ |
62
|
|
|
public function findFor() |
63
|
|
|
{ |
64
|
|
|
return $this->multiple ? $this->getList() : $this->first(); |
65
|
|
|
} |
66
|
|
|
|
67
|
|
|
/** |
68
|
|
|
* Определяет связи, которые должны быть загружены при выполнении запроса |
69
|
|
|
* |
70
|
|
|
* Передавая массив можно указать ключем - название релейшена, а значением - коллбек для кастомизации запроса |
71
|
|
|
* |
72
|
|
|
* @param array|string $with - связи, которые необходимо жадно подгрузить |
73
|
|
|
* // Загрузить Customer и сразу для каждой модели подгрузить orders и country |
74
|
|
|
* Customer::query()->with(['orders', 'country'])->getList(); |
75
|
|
|
* |
76
|
|
|
* // Загрузить Customer и сразу для каждой модели подгрузить orders, а также для orders загрузить address |
77
|
|
|
* Customer::find()->with('orders.address')->getList(); |
78
|
|
|
* |
79
|
|
|
* // Загрузить Customer и сразу для каждой модели подгрузить country и orders (только активные) |
80
|
|
|
* Customer::find()->with([ |
81
|
|
|
* 'orders' => function (BaseQuery $query) { |
82
|
|
|
* $query->filter(['ACTIVE' => 'Y']); |
83
|
|
|
* }, |
84
|
|
|
* 'country', |
85
|
|
|
* ])->all(); |
86
|
|
|
* |
87
|
|
|
* @return $this |
88
|
|
|
*/ |
89
|
|
|
public function with($with) |
90
|
|
|
{ |
91
|
|
|
$with = (array)$with; |
92
|
|
|
if (empty($this->with)) { |
93
|
|
|
$this->with = $with; |
94
|
|
|
} elseif (!empty($with)) { |
95
|
|
|
foreach ($with as $name => $value) { |
96
|
|
|
if (is_int($name)) { |
97
|
|
|
// дубликаты связей будут устранены в normalizeRelations() |
98
|
|
|
$this->with[] = $value; |
99
|
|
|
} else { |
100
|
|
|
$this->with[$name] = $value; |
101
|
|
|
} |
102
|
|
|
} |
103
|
|
|
} |
104
|
|
|
|
105
|
|
|
return $this; |
106
|
|
|
} |
107
|
|
|
|
108
|
|
|
/** |
109
|
|
|
* Добавить фильтр для загрзуки связи относительно моделей |
110
|
|
|
* @param Collection|BaseBitrixModel[] $models |
111
|
|
|
*/ |
112
|
|
|
protected function filterByModels($models) |
113
|
|
|
{ |
114
|
|
|
$values = []; |
115
|
|
|
foreach ($models as $model) { |
116
|
|
|
if (($value = $model[$this->foreignKey]) !== null) { |
117
|
|
|
if (is_array($value)) { |
118
|
|
|
$values = array_merge($values, $value); |
119
|
|
|
} else { |
120
|
|
|
$values[] = $value; |
121
|
|
|
} |
122
|
|
|
} |
123
|
|
|
} |
124
|
|
|
|
125
|
|
|
if (empty($values)) { |
126
|
|
|
$this->stopQuery(); |
|
|
|
|
127
|
|
|
} |
128
|
|
|
|
129
|
|
|
$primary = $this->localKey; |
130
|
|
|
if (preg_match('/^PROPERTY_(.*)_VALUE$/', $primary, $matches) && !empty($matches[1])) { |
131
|
|
|
$primary = 'PROPERTY_' . $matches[1]; |
132
|
|
|
} |
133
|
|
|
|
134
|
|
|
$this->filter([$primary => array_unique($values, SORT_REGULAR)]); |
|
|
|
|
135
|
|
|
$this->select[] = $primary; |
136
|
|
|
} |
137
|
|
|
|
138
|
|
|
/** |
139
|
|
|
* Подгрузить связанные модели для уже загруденных моделей |
140
|
|
|
* @param array $with - массив релейшенов, которые необходимо подгрузить |
141
|
|
|
* @param Collection|BaseBitrixModel[] $models модели, для которых загружать связи |
142
|
|
|
*/ |
143
|
|
|
public function findWith($with, &$models) |
144
|
|
|
{ |
145
|
|
|
// --- получаем модель, на основании которой будем брать запросы релейшенов |
146
|
|
|
$primaryModel = reset($models); |
147
|
|
|
if (!$primaryModel instanceof BaseBitrixModel) { |
148
|
|
|
$primaryModel = $this->model; |
|
|
|
|
149
|
|
|
} |
150
|
|
|
|
151
|
|
|
$relations = $this->normalizeRelations($primaryModel, $with); |
152
|
|
|
/* @var $relation BaseQuery */ |
153
|
|
|
foreach ($relations as $name => $relation) { |
154
|
|
|
$relation->populateRelation($name, $models); |
155
|
|
|
} |
156
|
|
|
} |
157
|
|
|
|
158
|
|
|
/** |
159
|
|
|
* @param BaseBitrixModel $model - модель пустышка, чтобы получить запросы |
160
|
|
|
* @param array $with |
161
|
|
|
* @return BaseQuery[] |
162
|
|
|
*/ |
163
|
|
|
private function normalizeRelations($model, $with) |
164
|
|
|
{ |
165
|
|
|
$relations = []; |
166
|
|
|
foreach ($with as $name => $callback) { |
167
|
|
|
if (is_int($name)) { // Если ключ - число, значит в значении написано название релейшена |
168
|
|
|
$name = $callback; |
169
|
|
|
$callback = null; |
170
|
|
|
} |
171
|
|
|
|
172
|
|
|
if (($pos = strpos($name, '.')) !== false) { // Если есть точка, значит указан вложенный релейшн |
173
|
|
|
$childName = substr($name, $pos + 1); // Название дочернего релейшена |
174
|
|
|
$name = substr($name, 0, $pos); // Название текущего релейшена |
175
|
|
|
} else { |
176
|
|
|
$childName = null; |
177
|
|
|
} |
178
|
|
|
|
179
|
|
|
if (!isset($relations[$name])) { // Указываем новый релейшн |
180
|
|
|
$relation = $model->getRelation($name); // Берем запрос |
181
|
|
|
$relation->primaryModel = null; |
182
|
|
|
$relations[$name] = $relation; |
183
|
|
|
} else { |
184
|
|
|
$relation = $relations[$name]; |
185
|
|
|
} |
186
|
|
|
|
187
|
|
|
if (isset($childName)) { |
188
|
|
|
$relation->with[$childName] = $callback; |
189
|
|
|
} elseif ($callback !== null) { |
190
|
|
|
call_user_func($callback, $relation); |
191
|
|
|
} |
192
|
|
|
} |
193
|
|
|
|
194
|
|
|
return $relations; |
195
|
|
|
} |
196
|
|
|
/** |
197
|
|
|
* Находит связанные записи и заполняет их в первичных моделях. |
198
|
|
|
* @param string $name - имя релейшена |
199
|
|
|
* @param array $primaryModels - первичные модели |
200
|
|
|
* @return Collection|BaseBitrixModel[] - найденные модели |
201
|
|
|
*/ |
202
|
|
|
public function populateRelation($name, &$primaryModels) |
203
|
|
|
{ |
204
|
|
|
$this->filterByModels($primaryModels); |
205
|
|
|
|
206
|
|
|
$models = $this->getList(); |
207
|
|
|
$buckets = $this->buildBuckets($models, $this->foreignKey); |
|
|
|
|
208
|
|
|
|
209
|
|
|
foreach ($primaryModels as $i => $primaryModel) { |
210
|
|
|
if ($this->multiple && is_array($keys = $primaryModel[$this->foreignKey])) { |
211
|
|
|
$value = []; |
212
|
|
|
foreach ($keys as $key) { |
213
|
|
|
$key = $this->normalizeModelKey($key); |
214
|
|
|
if (isset($buckets[$key])) { |
215
|
|
|
$value = array_merge($value, $buckets[$key]); |
216
|
|
|
} |
217
|
|
|
} |
218
|
|
|
} else { |
219
|
|
|
$key = $this->getModelKey($primaryModel, $this->foreignKey); |
220
|
|
|
$value = isset($buckets[$key]) ? $buckets[$key] : ($this->multiple ? [] : null); |
221
|
|
|
} |
222
|
|
|
|
223
|
|
|
$primaryModel->populateRelation($name, is_array($value) ? new Collection($value) : $value); |
224
|
|
|
} |
225
|
|
|
|
226
|
|
|
if ($this->inverseOf !== null) { |
227
|
|
|
$this->populateInverseRelation($primaryModels, $models, $name, $this->inverseOf); |
228
|
|
|
} |
229
|
|
|
|
230
|
|
|
return $models; |
231
|
|
|
} |
232
|
|
|
|
233
|
|
|
/** |
234
|
|
|
* Сгруппировать найденные модели |
235
|
|
|
* @param array $models |
236
|
|
|
* @param array|string $linkKeys |
237
|
|
|
* @param bool $checkMultiple |
238
|
|
|
* @return array |
239
|
|
|
*/ |
240
|
|
|
private function buildBuckets($models, $linkKeys, $checkMultiple = true) |
241
|
|
|
{ |
242
|
|
|
$buckets = []; |
243
|
|
|
|
244
|
|
|
foreach ($models as $model) { |
245
|
|
|
$key = $this->getModelKey($model, $linkKeys); |
|
|
|
|
246
|
|
|
$buckets[$key][] = $model; |
247
|
|
|
} |
248
|
|
|
|
249
|
|
|
if ($checkMultiple && !$this->multiple) { |
250
|
|
|
foreach ($buckets as $i => $bucket) { |
251
|
|
|
$buckets[$i] = reset($bucket); |
252
|
|
|
} |
253
|
|
|
} |
254
|
|
|
|
255
|
|
|
return $buckets; |
256
|
|
|
} |
257
|
|
|
|
258
|
|
|
/** |
259
|
|
|
* Получить значение атрибутов в виде строки |
260
|
|
|
* @param BaseBitrixModel $model |
261
|
|
|
* @param array $attributes |
262
|
|
|
* @return string |
263
|
|
|
*/ |
264
|
|
|
private function getModelKey($model, $attributes) |
265
|
|
|
{ |
266
|
|
|
$key = []; |
267
|
|
|
foreach ((array)$attributes as $attribute) { |
268
|
|
|
$key[] = $this->normalizeModelKey($model[$attribute]); |
269
|
|
|
} |
270
|
|
|
if (count($key) > 1) { |
271
|
|
|
return serialize($key); |
272
|
|
|
} |
273
|
|
|
$key = reset($key); |
274
|
|
|
return is_scalar($key) ? $key : serialize($key); |
275
|
|
|
} |
276
|
|
|
|
277
|
|
|
/** |
278
|
|
|
* @param mixed $value raw key value. |
279
|
|
|
* @return string normalized key value. |
280
|
|
|
*/ |
281
|
|
|
private function normalizeModelKey($value) |
282
|
|
|
{ |
283
|
|
|
if (is_object($value) && method_exists($value, '__toString')) { |
284
|
|
|
// ensure matching to special objects, which are convertable to string, for cross-DBMS relations, for example: `|MongoId` |
285
|
|
|
$value = $value->__toString(); |
286
|
|
|
} |
287
|
|
|
|
288
|
|
|
return $value; |
289
|
|
|
} |
290
|
|
|
|
291
|
|
|
/** |
292
|
|
|
* Добавляет основную модель запроса в релейшен |
293
|
|
|
* @param Collection|BaseBitrixModel[] $result |
294
|
|
|
*/ |
295
|
|
|
private function addInverseRelations(&$result) |
296
|
|
|
{ |
297
|
|
|
if ($this->inverseOf === null) { |
298
|
|
|
return; |
299
|
|
|
} |
300
|
|
|
|
301
|
|
|
foreach ($result as $i => $relatedModel) { |
302
|
|
|
if (!isset($inverseRelation)) { |
303
|
|
|
$inverseRelation = $relatedModel->getRelation($this->inverseOf); |
304
|
|
|
} |
305
|
|
|
$relatedModel->populateRelation($this->inverseOf, $inverseRelation->multiple ? new Collection([$this->primaryModel]) : $this->primaryModel); |
306
|
|
|
} |
307
|
|
|
} |
308
|
|
|
/** |
309
|
|
|
* @param Collection|BaseBitrixModel[] $primaryModels primary models |
310
|
|
|
* @param Collection|BaseBitrixModel[] $models models |
311
|
|
|
* @param string $primaryName the primary relation name |
312
|
|
|
* @param string $name the relation name |
313
|
|
|
*/ |
314
|
|
|
private function populateInverseRelation(&$primaryModels, $models, $primaryName, $name) |
315
|
|
|
{ |
316
|
|
|
if (empty($models) || empty($primaryModels)) { |
317
|
|
|
return; |
318
|
|
|
} |
319
|
|
|
|
320
|
|
|
/** @var BaseBitrixModel $model */ |
321
|
|
|
$model = $models->first(); |
|
|
|
|
322
|
|
|
$relation = $model->getRelation($name); |
323
|
|
|
|
324
|
|
|
if ($relation->multiple) { |
325
|
|
|
$buckets = $this->buildBuckets($primaryModels, $relation->foreignKey , false); |
|
|
|
|
326
|
|
|
foreach ($models as $model) { |
327
|
|
|
$key = $this->getModelKey($model, $relation->foreignKey); |
|
|
|
|
328
|
|
|
$model->populateRelation($name, new Collection(isset($buckets[$key]) ? $buckets[$key] : [])); |
329
|
|
|
} |
330
|
|
|
} else { |
331
|
|
|
foreach ($primaryModels as $i => $primaryModel) { |
332
|
|
|
if ($this->multiple) { |
333
|
|
|
foreach ($primaryModel->related[$primaryName] as $j => $m) { |
334
|
|
|
/** @var BaseBitrixModel $m */ |
335
|
|
|
$m->populateRelation($name, $primaryModel); |
336
|
|
|
} |
337
|
|
|
} else { |
338
|
|
|
/** @var BaseBitrixModel $m */ |
339
|
|
|
$m = $primaryModel->related[$primaryName]; |
340
|
|
|
$m->populateRelation($name, $primaryModel); |
341
|
|
|
} |
342
|
|
|
} |
343
|
|
|
} |
344
|
|
|
} |
345
|
|
|
} |
This check looks for methods that are used by a trait but not required by it.
To illustrate, let’s look at the following code example
The trait
Idable
provides a methodequalsId
that in turn relies on the methodgetId()
. If this method does not exist on a class mixing in this trait, the method will fail.Adding the
getId()
as an abstract method to the trait will make sure it is available.