Zing\QueryBuilder\Concerns\WithFilters

Complexity

Total Complexity

9

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	enableFilters()	0	6	2
A	applyFilters()	0	13	3
A	formatFilters()	0	9	2
A	isRequestedFilter()	0	3	1
A	getFilterValue()	0	3	1

<?php

declare(strict_types=1);

namespace Zing\QueryBuilder\Concerns;

use Illuminate\Support\Collection;
use Zing\QueryBuilder\Filter;

trait WithFilters
{
    /**
     * @param array<(string|\Zing\QueryBuilder\Filter)>|string|\Zing\QueryBuilder\Filter $filters
     *
     * @return $this
     */
    public function enableFilters($filters)
    {
        $filters = \is_array($filters) ? $filters : \func_get_args();
        $this->applyFilters($this->formatFilters($filters));

        return $this;
    }

    /**
     * @param array<(string|\Zing\QueryBuilder\Filter)> $filters
     */
    protected function formatFilters(array $filters): Collection
    {
        return collect($filters)->map(
            function ($filter): Filter {
                if ($filter instanceof Filter) {
                    return $filter;
                }

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

    protected function applyFilters(Collection $filters): void
    {
        $filters->each(
            function (Filter $filter): void {
                $thisIsRequestedFilter = $this->isRequestedFilter($filter);
                if ($thisIsRequestedFilter) {
                    $filter->filter($this->getBuilder(), $this->getFilterValue($filter));

It seems like getBuilder() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    return;
                }

                if ($filter->hasDefault()) {
                    $filter->filter($this->getBuilder(), $filter->getDefault());
                }
            }
        );
    }

    protected function isRequestedFilter(Filter $filter): bool
    {
        return $this->request->has($filter->getProperty());
    }

    /**
     * @return mixed
     */
    protected function getFilterValue(Filter $filter)
    {
        return $this->request->input($filter->getProperty());
    }
}