-
Notifications
You must be signed in to change notification settings - Fork 11
/
ArrayBuilder.php
392 lines (328 loc) · 11.9 KB
/
ArrayBuilder.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
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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
<?php
namespace Williamoliveira\ArrayQueryBuilder;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Query\Builder as QueryBuilder;
use Illuminate\Database\Query\Grammars\MySqlGrammar;
use Illuminate\Database\Query\Grammars\PostgresGrammar;
class ArrayBuilder
{
protected $aliases = [
'eq' => '=',
'neq' => '<>',
'gt' => '>',
'gte' => '>=',
'lt' => '<',
'lte' => '<=',
'nlike' => 'not like',
'nin' => 'not in',
'notnull' => 'not null',
'nn' => 'not null',
'inq' => 'in'
];
/**
* @param Builder|QueryBuilder $query
* @param array $arrayQuery
* @return Builder|QueryBuilder
* @throws \InvalidArgumentException
*/
public function apply($query, array $arrayQuery)
{
if (isset($arrayQuery['include'])) {
if ($query instanceof QueryBuilder) {
throw new \InvalidArgumentException(
QueryBuilder::class . " does not support relations, you need " . Builder::class . " for that."
);
}
$this->buildIncludes($query, $arrayQuery['include']);
}
if (isset($arrayQuery['where'])) {
$this->buildWheres($query, $arrayQuery['where']);
}
if (isset($arrayQuery['fields'])) {
$this->buildFields($query, $arrayQuery['fields']);
}
if (isset($arrayQuery['order'])) {
$this->buildOrderBy($query, $arrayQuery['order']);
}
if (isset($arrayQuery['limit'])) {
$this->buildLimit($query, $arrayQuery['limit']);
}
if (isset($arrayQuery['offset'])) {
$this->buildOffset($query, $arrayQuery['offset']);
} elseif (isset($arrayQuery['skip'])) {
// "skip" is an alias for "offset"
$this->buildOffset($query, $arrayQuery['skip']);
}
if (isset($arrayQuery['groupBy'])) {
$this->buildGroupBy($query, $arrayQuery['groupBy']);
} elseif (isset($arrayQuery['group_by'])) {
// "group_by" is an alias for "groupBy"
$this->buildGroupBy($query, $arrayQuery['group_by']);
}
if (isset($arrayQuery['having'])) {
$this->buildHavings($query, $arrayQuery['having']);
}
return $query;
}
/**
* @param Builder|QueryBuilder $queryBuilder
* @param array $wheres
* @param string $boolean
*/
protected function buildWheres($queryBuilder, array $wheres, $boolean = 'and')
{
foreach ($wheres as $whereField => $where) {
if (!isset($whereField) || !isset($where)) {
continue;
}
$whereField = strtolower($whereField);
// Nested OR where
// Example: 'or' => ['foo' => 'bar', 'x => 'y']
if ($whereField === 'or') {
$queryBuilder->whereNested(function ($queryBuilder) use ($where) {
$this->buildWheres($queryBuilder, $where, 'or');
}, $boolean);
continue;
}
// Nested AND where
// Example: 'and' => ['foo' => 'bar', 'x => 'y']
if ($whereField === 'and') {
$queryBuilder->whereNested(function ($queryBuilder) use ($where) {
$this->buildWheres($queryBuilder, $where, 'and');
}, $boolean);
continue;
}
// Operator is present on query
// Example: 'foo' => ['like' => '%bar%']
if (is_array($where)) {
foreach ($where as $whereOperator => $whereValue) {
$whereOperator = $this->parseOperator($whereOperator);
$this->buildWhere($queryBuilder, $whereField, $whereOperator, $whereValue, $boolean);
}
continue;
}
// Operator is omitted on query, assumes '='
// Example: 'foo' => 'bar'
$whereOperator = is_array($where) ? array_keys($where)[0] : '=';
$whereValue = is_array($where) ? $where[$whereOperator] : $where;
$whereOperator = $this->parseOperator($whereOperator);
$this->buildWhere($queryBuilder, $whereField, $whereOperator, $whereValue, $boolean);
}
}
/**
* @param Builder|QueryBuilder $queryBuilder
* @param string $field
* @param string|null $operator
* @param array|string $value
* @param string $boolean
*/
protected function buildWhere($queryBuilder, $field, $operator, $value, $boolean = 'and')
{
if (strpos($field, '.') > -1) {
$this->buildWhereHas($queryBuilder, $field, $operator, $value, $boolean);
return;
}
switch ($operator) {
case 'between':
$queryBuilder->whereBetween($field, [$value[0], $value[1]], $boolean);
return;
case 'not null':
$queryBuilder->whereNotNull($field, $boolean);
return;
case 'in':
$queryBuilder->whereIn($field, (!is_array($value) ? [$value] : $value), $boolean);
return;
case 'not in':
$queryBuilder->whereNotIn($field, (!is_array($value) ? [$value] : $value), $boolean);
return;
case 'search':
$this->buildTextSearchWhere($queryBuilder, $field, $value, $boolean);
return;
default:
$queryBuilder->where($field, $operator, $value, $boolean);
}
}
/**
* @param Builder|QueryBuilder $queryBuilder
* @param array $columns
*/
protected function buildFields($queryBuilder, $columns = ['*'])
{
$queryBuilder->select($columns);
}
/**
* @param Builder|QueryBuilder $queryBuilder
* @param array|string $order
*/
protected function buildOrderBy($queryBuilder, $order)
{
if (is_array($order)) {
foreach ($order as $orderItem) {
$this->buildOrderBySingle($queryBuilder, $orderItem);
}
return;
}
$this->buildOrderBySingle($queryBuilder, $order);
}
/**
* @param Builder|QueryBuilder $queryBuilder
* @param string $order
*/
protected function buildOrderBySingle($queryBuilder, $order)
{
$order = strtolower($order);
$orderBy = str_replace([' asc', ' desc'], '', $order);
$orderDirection = $this->ends_with($order, ' desc') ? 'desc' : 'asc';
$queryBuilder->orderBy($orderBy, $orderDirection);
}
protected function ends_with($haystack, $needles)
{
foreach ((array) $needles as $needle) {
if (substr($haystack, -strlen($needle)) === (string) $needle) {
return true;
}
}
return false;
}
/**
* @param Builder|QueryBuilder $queryBuilder
* @param int $limit
*/
protected function buildLimit($queryBuilder, $limit)
{
$queryBuilder->limit($limit);
}
/**
* @param Builder|QueryBuilder $queryBuilder
* @param int $offset
*/
protected function buildOffset($queryBuilder, $offset)
{
$queryBuilder->offset($offset);
}
/**
* @param Builder $queryBuilder
* @param array $includes
*/
protected function buildIncludes($queryBuilder, array $includes)
{
$builtIncludes = [];
foreach ($includes as $includeName => $include) {
// Support for array includes, example: ['user', 'post']
// If it's a single dimension array the key will be numeric
$includeName = is_numeric($includeName) ? $include : $includeName;
if (empty($include['where']) && empty($include['fields']) && empty($include['order'])) {
$builtIncludes[] = $includeName;
continue;
}
$builtIncludes[$includeName] = function ($query) use ($include) {
if (isset($include['where'])) {
$this->buildWheres($query, $include['where']);
}
if (isset($include['fields'])) {
$this->buildFields($query, $include['fields']);
}
if (isset($include['order'])) {
$this->buildOrderBy($query, $include['order']);
}
};
}
$queryBuilder->with($builtIncludes);
}
/**
* @param Builder|QueryBuilder $queryBuilder
* @param $field
* @param $value
* @param string $boolean
*/
protected function buildTextSearchWhere($queryBuilder, $field, $value, $boolean = 'and')
{
$value = preg_replace('/\s\s+/', ' ', trim($value));
$value = '%' . strtolower(str_replace(' ', '%', $value)) . '%';
$theQueryBuilder = $queryBuilder instanceof Builder
? $queryBuilder->getQuery()
: $queryBuilder;
$grammar = $theQueryBuilder->getGrammar();
// Postgres
if ($grammar instanceof PostgresGrammar) {
$queryBuilder->where($field, 'ilike', $value, $boolean);
return;
}
$column = $grammar->wrap($field);
// MySql
if ($grammar instanceof MySqlGrammar) {
$queryBuilder->whereRaw($column . ' COLLATE utf8_general_ci like ?', [$value], $boolean);
return;
}
// Others
$queryBuilder->whereRaw('lower(' . $column . ') like ?', [$value], $boolean);
}
/**
* @param Builder|QueryBuilder $queryBuilder
* @param $hasField
* @param $operator
* @param $value
* @param string $boolean
*/
protected function buildWhereHas($queryBuilder, $hasField, $operator, $value, $boolean = 'and')
{
$reversedParts = explode('.', strrev($hasField), 2);
$hasField = strrev($reversedParts[1]);
$field = strrev($reversedParts[0]);
$queryBuilder->whereHas($hasField, function ($query) use ($queryBuilder, $field, $operator, $value, $boolean) {
$this->buildWhere($query, $field, $operator, $value, $boolean);
});
}
/**
* @param Builder|QueryBuilder $queryBuilder
* @param string|array $groupBy
*/
protected function buildGroupBy($queryBuilder, $groupBy)
{
$queryBuilder->groupBy($groupBy);
}
/**
* @param Builder|QueryBuilder $queryBuilder
* @param array $havings
* @param string $boolean
*/
protected function buildHavings($queryBuilder, array $havings, $boolean = 'and')
{
foreach ($havings as $havingField => $having) {
if (!isset($havingField) || !isset($having)) {
continue;
}
$havingField = strtolower($havingField);
// Operator is omitted on query, assumes '='
// Example: 'foo' => 'bar'
$havingOperator = is_array($having) ? array_keys($having)[0] : '=';
$havingValue = is_array($having) ? $having[$havingOperator] : $having;
$havingOperator = $this->parseOperator($havingOperator);
$this->buildHaving($queryBuilder, $havingField, $havingOperator, $havingValue, $boolean);
}
}
/**
* @param Builder|QueryBuilder $queryBuilder
* @param string $havingField
* @param string $havingOperator
* @param string $havingValue
* @param string $boolean
*
* @internal param array|string $having
*/
protected function buildHaving($queryBuilder, $havingField, $havingOperator, $havingValue, $boolean)
{
$queryBuilder->having($havingField, $havingOperator, $havingValue, $boolean);
}
/**
* @param string $operator
* @return string
*/
protected function parseOperator($operator)
{
$operator = array_key_exists($operator, $this->aliases)
? $this->aliases[$operator]
: $operator;
return strtolower($operator);
}
}