-
-
Notifications
You must be signed in to change notification settings - Fork 6
/
QueryFilter.php
174 lines (149 loc) · 5.33 KB
/
QueryFilter.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
<?php
namespace Orchestra\Support\Traits;
use Orchestra\Support\Str;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Query\Expression;
trait QueryFilter
{
/**
* Setup basic query string filter to eloquent or query builder.
*
* @param \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder $query
* @param array $input
*
* @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder
*/
protected function setupBasicQueryFilter($query, array $input = [])
{
$orderBy = $this->getBasicQueryOrderBy($input);
$direction = $this->getBasicQueryDirection($input);
$columns = isset($input['columns']) ? $input['columns'] : null;
if (is_array($columns) && $this->isColumnExcludedFromFilterable($orderBy, $columns)) {
return $query;
}
! empty($orderBy) && $query->orderBy($orderBy, $direction);
return $query;
}
/**
* Setup wildcard query string filter to eloquent or query builder.
*
* @param \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder $query
* @param mixed $keyword
* @param array $fields
*
* @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder
*/
protected function setupWildcardQueryFilter($query, $keyword, array $fields)
{
if (! empty($keyword) && ! empty($fields)) {
$query->where(function ($query) use ($fields, $keyword) {
$this->buildWildcardQueryFilters($query, $fields, Str::searchable($keyword));
});
}
return $query;
}
/**
* Check if column can be filtered for query.
*
* @param string $on
* @param array $columns
*
* @return bool
*/
protected function isColumnExcludedFromFilterable($on, array $columns = [])
{
$only = isset($columns['only']) ? $columns['only'] : '';
$except = isset($columns['except']) ? $columns['except'] : '';
return ((! empty($only) && ! in_array($on, (array) $only)) ||
(! empty($except) && in_array($on, (array) $except)));
}
/**
* Get basic query direction value (either ASC or DESC).
*
* @param array $input
*
* @return string
*/
protected function getBasicQueryDirection(array $input)
{
$direction = Str::upper(isset($input['direction']) ? $input['direction'] : '');
if (in_array($direction, ['ASC', 'DESC'])) {
return $direction;
}
return 'ASC';
}
/**
* Get basic query order by column.
*
* @param array $input
*
* @return string
*/
protected function getBasicQueryOrderBy(array $input)
{
$orderBy = isset($input['order_by']) ? $input['order_by'] : '';
if (in_array($orderBy, ['created', 'updated', 'deleted'])) {
$orderBy = "{$orderBy}_at";
}
return $orderBy;
}
/**
* Build wildcard query filters.
*
* @param \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder $query
* @param array $fields
* @param array $keyword
* @param string $group
*
* @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder
*/
protected function buildWildcardQueryFilters($query, array $fields, array $keyword = [])
{
foreach ($fields as $field) {
$this->buildWildcardForField($query, $field, $keyword);
}
return $query;
}
/**
*
* Build wildcard query filter for field using where or orWhere.
*
* @param \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder $query
* @param string $field
* @param array $keyword
*
* @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder
*/
protected function buildWildcardForField($query, $field, array $keyword)
{
if ($field instanceof Expression) {
return $this->buildWildcardForFieldUsing($query, $field->getValue(), $keyword, 'orWhere');
} elseif (! (Str::contains($field, '.') && $query instanceof Builder)) {
return $this->buildWildcardForFieldUsing($query, $field, $keyword, 'orWhere');
}
$this->buildWildcardForFieldUsing($query, $field, $keyword, 'orWhere');
list($relation, $field) = explode('.', $field, 2);
return $query->orWhereHas($relation, function ($query) use ($field, $keyword) {
$this->buildWildcardForFieldUsing($query, $field, $keyword, 'where');
});
}
/**
* Build wildcard query filter for field using where or orWhere.
*
* @param \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder $query
* @param string $field
* @param array $keyword
* @param string $group
*
* @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder
*/
protected function buildWildcardForFieldUsing($query, $field, array $keyword = [], $group = 'where')
{
$callback = function ($query) use ($field, $keyword) {
foreach ($keyword as $key) {
$query->orWhere($field, 'LIKE', $key);
}
};
return $query->{$group}($callback);
}
}