Spatie\QueryBuilder\Concerns\FiltersQuery

Complexity

Total Complexity

10

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	allowedFilters()	0	19	3
A	addFiltersToQuery()	0	8	1
A	addDefaultFiltersToQuery()	0	14	3
A	findFilter()	0	7	1
A	guardAgainstUnknownFilters()	0	12	2

<?php

namespace Spatie\QueryBuilder\Concerns;

use Spatie\QueryBuilder\Filter;
use Illuminate\Support\Collection;
use Spatie\QueryBuilder\Exceptions\InvalidFilterQuery;

trait FiltersQuery
{
    /** @var \Illuminate\Support\Collection */
    protected $allowedFilters;

    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());

The property request does not exist. Did you maybe forget to declare it?

        $this->addDefaultFiltersToQuery($this->allowedFilters);

        return $this;
    }

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

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

    protected function addDefaultFiltersToQuery(Collection $filters)
    {
        $filters->each(function ($value) {
            $filter = $this->findFilter($value->getProperty());

            if (! $filter->defaultSet()) {
                return;
            }

            if (! $this->request->filters()->has($filter->getProperty())) {
                $filter->filter($this, $filter->getDefault());
            }
        });
    }

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

    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);
        }
    }
}