These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | |||
3 | namespace Spatie\QueryBuilder\Concerns; |
||
4 | |||
5 | use Illuminate\Support\Collection; |
||
6 | use Illuminate\Support\Str; |
||
7 | use Spatie\QueryBuilder\AllowedInclude; |
||
8 | use Spatie\QueryBuilder\Exceptions\InvalidIncludeQuery; |
||
9 | use Spatie\QueryBuilder\Includes\IncludeInterface; |
||
10 | |||
11 | trait AddsIncludesToQuery |
||
12 | { |
||
13 | /** @var \Illuminate\Support\Collection */ |
||
14 | protected $allowedIncludes; |
||
15 | |||
16 | public function allowedIncludes($includes): self |
||
17 | { |
||
18 | $includes = is_array($includes) ? $includes : func_get_args(); |
||
19 | |||
20 | $this->allowedIncludes = collect($includes) |
||
21 | ->reject(function ($include) { |
||
22 | return empty($include); |
||
23 | }) |
||
24 | ->flatMap(function ($include): Collection { |
||
25 | if ($include instanceof IncludeInterface) { |
||
26 | return collect([$include]); |
||
27 | } |
||
28 | |||
29 | if (Str::endsWith($include, config('query-builder.count_suffix'))) { |
||
30 | return AllowedInclude::count($include); |
||
31 | } |
||
32 | |||
33 | return AllowedInclude::relationship($include); |
||
34 | }) |
||
35 | ->unique(function (AllowedInclude $allowedInclude) { |
||
36 | return $allowedInclude->getName(); |
||
37 | }); |
||
38 | |||
39 | $this->ensureAllIncludesExist(); |
||
40 | |||
41 | $this->addIncludesToQuery($this->request->includes()); |
||
42 | |||
43 | return $this; |
||
44 | } |
||
45 | |||
46 | protected function addIncludesToQuery(Collection $includes) |
||
47 | { |
||
48 | $includes->each(function ($include) { |
||
49 | $include = $this->findInclude($include); |
||
50 | |||
51 | $include->include($this); |
||
52 | }); |
||
53 | } |
||
54 | |||
55 | protected function findInclude(string $include): ?AllowedInclude |
||
56 | { |
||
57 | return $this->allowedIncludes |
||
58 | ->first(function (AllowedInclude $included) use ($include) { |
||
59 | return $included->isForInclude($include); |
||
60 | }); |
||
61 | } |
||
62 | |||
63 | protected function ensureAllIncludesExist() |
||
64 | { |
||
65 | if (! $this->throwInvalidQueryExceptions) { |
||
0 ignored issues
–
show
|
|||
66 | return; |
||
67 | } |
||
68 | |||
69 | $includes = $this->request->includes(); |
||
70 | |||
71 | $allowedIncludeNames = $this->allowedIncludes->map(function (AllowedInclude $allowedInclude) { |
||
72 | return $allowedInclude->getName(); |
||
73 | }); |
||
74 | |||
75 | $diff = $includes->diff($allowedIncludeNames); |
||
76 | |||
77 | if ($diff->count()) { |
||
78 | throw InvalidIncludeQuery::includesNotAllowed($diff, $allowedIncludeNames); |
||
79 | } |
||
80 | |||
81 | // TODO: Check for non-existing relationships? |
||
82 | } |
||
83 | } |
||
84 |
In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:
Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: