QueryBuilder::allowedFilters() - Code Metrics - Inspection of "Keep scopes and other builder properties from base..." - spatie/laravel-query-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bad99b...8c8868 )

unknown

created 2018-02-07 22:09 UTC

QueryBuilder::allowedFilters() A

↳ Parent: QueryBuilder

Complexity

Conditions	3
Paths	2

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	17
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	9
nc	2
nop	1

<?php

namespace Spatie\QueryBuilder;

use Illuminate\Http\Request;
use Illuminate\Support\Collection;
use Illuminate\Database\Eloquent\Builder;
use Spatie\QueryBuilder\Exceptions\InvalidSortQuery;
use Spatie\QueryBuilder\Exceptions\InvalidFilterQuery;
use Spatie\QueryBuilder\Exceptions\InvalidIncludeQuery;

class QueryBuilder extends Builder
{
    /** @var \Illuminate\Support\Collection */
    protected $allowedFilters;

    /** @var string|null */
    protected $defaultSort;

    /** @var \Illuminate\Support\Collection */
    protected $allowedSorts;

    /** @var \Illuminate\Support\Collection */
    protected $allowedIncludes;

    /** @var \Illuminate\Http\Request */
    protected $request;

    public function __construct(Builder $builder, ?Request $request = null)
    {
        parent::__construct(clone $builder->getQuery());

        $this->initializeFromBuilder($builder);

        $this->request = $request ?? request();

        if ($this->request->sorts()) {
            $this->allowedSorts('*');
        }
    }

    /**
     * Add the model, scopes, eager loaded relationships, local macro's and onDelete callback
     * from the $builder to this query builder.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     */
    protected function initializeFromBuilder(Builder $builder)
    {
        $this->setModel($builder->getModel())
            ->setEagerLoads($builder->getEagerLoads());

        $builder->macro('getProtected', function (Builder $builder, string $property) {
            return $builder->{$property};
        });

        $this->scopes = $builder->getProtected('scopes');

        $this->localMacros = $builder->getProtected('localMacros');

        $this->onDelete = $builder->getProtected('onDelete');
    }

    /**
     * Create a new QueryBuilder for a request and model.
     *
     * @param string|\Illuminate\Database\Query\Builder $baseQuery Model class or base query builder
     * @param Request $request
     *
     * @return \Spatie\QueryBuilder\QueryBuilder
     */
    public static function for($baseQuery, ?Request $request = null): self

    {
        if (is_string($baseQuery)) {
            $baseQuery = ($baseQuery)::query();
        }

        return new static($baseQuery, $request ?? request());
class A {
    var $property;
}
    }

    public function allowedFilters($filters): self
    {
        $filters = is_array($filters) ? $filters : func_get_args();
        $this->allowedFilters = collect($filters)->map(function ($filter) {
            if ($filter instanceof Filter) {
                return $filter;
            }

            return Filter::partial($filter);
        });

        $this->guardAgainstUnknownFilters();

        $this->addFiltersToQuery($this->request->filters());

        return $this;
    }

    public function defaultSort($sort): self
    {
        $this->defaultSort = $sort;

        $this->addSortsToQuery($this->request->sorts($this->defaultSort));

        return $this;
    }

    public function allowedSorts($sorts): self
    {
        $sorts = is_array($sorts) ? $sorts : func_get_args();
        if (! $this->request->sorts()) {
            return $this;
        }

        $this->allowedSorts = collect($sorts);

        if (! $this->allowedSorts->contains('*')) {
            $this->guardAgainstUnknownSorts();
        }

        $this->addSortsToQuery($this->request->sorts($this->defaultSort));

        return $this;
    }

    public function allowedIncludes($includes): self
    {
        $includes = is_array($includes) ? $includes : func_get_args();
        $this->allowedIncludes = collect($includes);

        $this->guardAgainstUnknownIncludes();

        $this->addIncludesToQuery($this->request->includes());

        return $this;
    }

    protected function addFiltersToQuery(Collection $filters)
    {
        $filters->each(function ($value, $property) {
            $filter = $this->findFilter($property);

            $filter->filter($this, $value);
        });
    }

    protected function findFilter(string $property) : ?Filter
    {
        return $this->allowedFilters
            ->first(function (Filter $filter) use ($property) {
                return $filter->isForProperty($property);
            });
    }

    protected function addSortsToQuery(Collection $sorts)
    {
        $sorts
            ->each(function (string $sort) {
                $descending = $sort[0] === '-';

                $key = ltrim($sort, '-');

                $this->orderBy($key, $descending ? 'desc' : 'asc');

            });
    }

    protected function addIncludesToQuery(Collection $includes)
    {
        $includes
            ->map(function (string $include) {
                return camel_case($include);
            })
            ->each(function (string $include) {
                $this->with($include);
            });
    }

    protected function guardAgainstUnknownFilters()
    {
        $filterNames = $this->request->filters()->keys();

        $allowedFilterNames = $this->allowedFilters->map->getProperty();

        $diff = $filterNames->diff($allowedFilterNames);

        if ($diff->count()) {
            throw InvalidFilterQuery::filtersNotAllowed($diff, $allowedFilterNames);
        }
    }

    protected function guardAgainstUnknownSorts()
    {
        $sorts = $this->request->sorts()->map(function ($sort) {
            return ltrim($sort, '-');
        });

        $diff = $sorts->diff($this->allowedSorts);

        if ($diff->count()) {
            throw InvalidSortQuery::sortsNotAllowed($diff, $this->allowedSorts);
        }
    }

    protected function guardAgainstUnknownIncludes()
    {
        $includes = $this->request->includes();

        $diff = $includes->diff($this->allowedIncludes);

        if ($diff->count()) {
            throw InvalidIncludeQuery::includesNotAllowed($diff, $this->allowedIncludes);
        }
    }
}


1			<?php
2
3			namespace Spatie\QueryBuilder;
4
5			use Illuminate\Http\Request;
6			use Illuminate\Support\Collection;
7			use Illuminate\Database\Eloquent\Builder;
8			use Spatie\QueryBuilder\Exceptions\InvalidSortQuery;
9			use Spatie\QueryBuilder\Exceptions\InvalidFilterQuery;
10			use Spatie\QueryBuilder\Exceptions\InvalidIncludeQuery;
11
12			class QueryBuilder extends Builder
13			{
14			/** @var \Illuminate\Support\Collection */
15			protected $allowedFilters;
16
17			/** @var string\|null */
18			protected $defaultSort;
19
20			/** @var \Illuminate\Support\Collection */
21			protected $allowedSorts;
22
23			/** @var \Illuminate\Support\Collection */
24			protected $allowedIncludes;
25
26			/** @var \Illuminate\Http\Request */
27			protected $request;
28
29			public function __construct(Builder $builder, ?Request $request = null)
30			{
31			parent::__construct(clone $builder->getQuery());
32
33			$this->initializeFromBuilder($builder);
34
35			$this->request = $request ?? request();
36
37			if ($this->request->sorts()) {
38			$this->allowedSorts('*');
39			}
40			}
41
42			/**
43			* Add the model, scopes, eager loaded relationships, local macro's and onDelete callback
44			* from the $builder to this query builder.
45			*
46			* @param \Illuminate\Database\Eloquent\Builder $builder
47			*/
48			protected function initializeFromBuilder(Builder $builder)
49			{
50			$this->setModel($builder->getModel())
51			->setEagerLoads($builder->getEagerLoads());
52
53			$builder->macro('getProtected', function (Builder $builder, string $property) {
54			return $builder->{$property};
55			});
56
57			$this->scopes = $builder->getProtected('scopes');
58
59			$this->localMacros = $builder->getProtected('localMacros');
60
61			$this->onDelete = $builder->getProtected('onDelete');
62			}
63
64			/**
65			* Create a new QueryBuilder for a request and model.
66			*
67			* @param string\|\Illuminate\Database\Query\Builder $baseQuery Model class or base query builder
68			* @param Request $request
69			*
70			* @return \Spatie\QueryBuilder\QueryBuilder
71			*/
72			public static function for($baseQuery, ?Request $request = null): self
			0 ignored issues – show Coding Style introduced 2018-01-17 09:00 UTC by Report Bug Copy Issue Report Possible parse error: non-abstract method defined as abstract Loading history... Coding Style introduced 2018-01-17 09:00 UTC by Report Bug Copy Issue Report It is generally advisable to only define one property per statement. Only declaring a single property per statement allows you to later on add doc comments more easily. It is also recommended by PSR2, so it is a common style that many people expect. Loading history...
73			{
74			if (is_string($baseQuery)) {
75			$baseQuery = ($baseQuery)::query();
76			}
77
78			return new static($baseQuery, $request ?? request());
			0 ignored issues – show Coding Style introduced 2018-01-17 09:55 UTC by Report Bug Copy Issue Report It is generally advisable to only define one property per statement. Only declaring a single property per statement allows you to later on add doc comments more easily. It is also recommended by PSR2, so it is a common style that many people expect. Loading history... Coding Style introduced 2018-01-17 09:55 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$baseQuery`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
79			}
80
81			public function allowedFilters($filters): self
82			{
83			$filters = is_array($filters) ? $filters : func_get_args();
84			$this->allowedFilters = collect($filters)->map(function ($filter) {
85			if ($filter instanceof Filter) {
86			return $filter;
87			}
88
89			return Filter::partial($filter);
90			});
91
92			$this->guardAgainstUnknownFilters();
93
94			$this->addFiltersToQuery($this->request->filters());
95
96			return $this;
97			}
98
99			public function defaultSort($sort): self
100			{
101			$this->defaultSort = $sort;
102
103			$this->addSortsToQuery($this->request->sorts($this->defaultSort));
104
105			return $this;
106			}
107
108			public function allowedSorts($sorts): self
109			{
110			$sorts = is_array($sorts) ? $sorts : func_get_args();
111			if (! $this->request->sorts()) {
112			return $this;
113			}
114
115			$this->allowedSorts = collect($sorts);
116
117			if (! $this->allowedSorts->contains('*')) {
118			$this->guardAgainstUnknownSorts();
119			}
120
121			$this->addSortsToQuery($this->request->sorts($this->defaultSort));
122
123			return $this;
124			}
125
126			public function allowedIncludes($includes): self
127			{
128			$includes = is_array($includes) ? $includes : func_get_args();
129			$this->allowedIncludes = collect($includes);
130
131			$this->guardAgainstUnknownIncludes();
132
133			$this->addIncludesToQuery($this->request->includes());
134
135			return $this;
136			}
137
138			protected function addFiltersToQuery(Collection $filters)
139			{
140			$filters->each(function ($value, $property) {
141			$filter = $this->findFilter($property);
142
143			$filter->filter($this, $value);
144			});
145			}
146
147			protected function findFilter(string $property) : ?Filter
148			{
149			return $this->allowedFilters
150			->first(function (Filter $filter) use ($property) {
151			return $filter->isForProperty($property);
152			});
153			}
154
155			protected function addSortsToQuery(Collection $sorts)
156			{
157			$sorts
158			->each(function (string $sort) {
159			$descending = $sort[0] === '-';
160
161			$key = ltrim($sort, '-');
162
163			$this->orderBy($key, $descending ? 'desc' : 'asc');
			0 ignored issues – show Bug introduced 2018-01-16 11:23 UTC by Report Bug Copy Issue Report The method `orderBy()` does not exist on `Spatie\QueryBuilder\QueryBuilder`. Did you maybe mean `enforceOrderBy()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
164			});
165			}
166
167			protected function addIncludesToQuery(Collection $includes)
168			{
169			$includes
170			->map(function (string $include) {
171			return camel_case($include);
172			})
173			->each(function (string $include) {
174			$this->with($include);
175			});
176			}
177
178			protected function guardAgainstUnknownFilters()
179			{
180			$filterNames = $this->request->filters()->keys();
181
182			$allowedFilterNames = $this->allowedFilters->map->getProperty();
183
184			$diff = $filterNames->diff($allowedFilterNames);
185
186			if ($diff->count()) {
187			throw InvalidFilterQuery::filtersNotAllowed($diff, $allowedFilterNames);
188			}
189			}
190
191			protected function guardAgainstUnknownSorts()
192			{
193			$sorts = $this->request->sorts()->map(function ($sort) {
194			return ltrim($sort, '-');
195			});
196
197			$diff = $sorts->diff($this->allowedSorts);
198
199			if ($diff->count()) {
200			throw InvalidSortQuery::sortsNotAllowed($diff, $this->allowedSorts);
201			}
202			}
203
204			protected function guardAgainstUnknownIncludes()
205			{
206			$includes = $this->request->includes();
207
208			$diff = $includes->diff($this->allowedIncludes);
209
210			if ($diff->count()) {
211			throw InvalidIncludeQuery::includesNotAllowed($diff, $this->allowedIncludes);
212			}
213			}
214			}
215

spatie / laravel-query-builder

Push — master ( bad99b...8c8868 )

QueryBuilder::allowedFilters() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like