Spatie\QueryBuilder\Filter

Complexity

Total Complexity

23

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	1

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	filter()	0	16	4
A	exact()	0	4	1
A	partial()	0	4	1
A	scope()	0	4	1
A	custom()	0	4	1
A	getProperty()	0	4	1
A	isForProperty()	0	4	1
A	ignore()	0	8	1
A	getIgnored()	0	4	1
A	default()	0	6	1
A	getDefault()	0	4	1
A	defaultSet()	0	4	1
A	getColumnName()	0	4	1
A	resolveFilterClass()	0	8	2
A	resolveValueForFiltering()	0	10	4

<?php

namespace Spatie\QueryBuilder;

use Illuminate\Support\Collection;
use Illuminate\Database\Eloquent\Builder;
use Spatie\QueryBuilder\Filters\FiltersExact;
use Spatie\QueryBuilder\Filters\FiltersScope;
use Spatie\QueryBuilder\Filters\FiltersPartial;
use Spatie\QueryBuilder\Filters\Filter as CustomFilter;

class Filter
{
    /** @var string|\Spatie\QueryBuilder\Filters\Filter */
    protected $filterClass;

    /** @var string */
    protected $property;

    /** @var string */
    protected $columnName;

    /** @var Collection */
    protected $ignored;

    /** @var */
    protected $default;

    public function __construct(string $property, $filterClass, ?string $columnName = null)
    {
        $this->property = $property;

        $this->filterClass = $filterClass;

        $this->ignored = Collection::make();

        $this->columnName = $columnName ?? $property;
    }

    public function filter(Builder $builder, $value)
    {
        $valueToFilter = $this->resolveValueForFiltering($value);

        if (isset($this->default) && is_null($valueToFilter)) {
            return $this->default;
        }

        if (is_null($valueToFilter)) {
            return;
        }

        $filterClass = $this->resolveFilterClass();

        ($filterClass)($builder, $valueToFilter, $this->columnName);
    }

    public static function exact(string $property, ?string $columnName = null) : self
    {
        return new static($property, FiltersExact::class, $columnName);
    }

    public static function partial(string $property, $columnName = null) : self
    {
        return new static($property, FiltersPartial::class, $columnName);
    }

    public static function scope(string $property, $columnName = null) : self
    {
        return new static($property, FiltersScope::class, $columnName);
    }

    public static function custom(string $property, $filterClass, $columnName = null) : self
    {
        return new static($property, $filterClass, $columnName);
    }

    public function getProperty(): string
    {
        return $this->property;
    }

    public function isForProperty(string $property): bool
    {
        return $this->property === $property;
    }

    public function ignore(...$values): self
    {
        $this->ignored = $this->ignored
            ->merge($values)
            ->flatten();

        return $this;
    }

    public function getIgnored(): array
    {
        return $this->ignored->toArray();
    }

    public function default($value): self
    {
        $this->default = $value;

        return $this;
    }

    public function getDefault()
    {
        return $this->default;
    }

    public function defaultSet(): bool
    {
        return isset($this->default);
    }

    public function getColumnName(): string
    {
        return $this->columnName;
    }

    private function resolveFilterClass(): CustomFilter
    {
        if ($this->filterClass instanceof CustomFilter) {
            return $this->filterClass;
        }

        return new $this->filterClass;
    }

    private function resolveValueForFiltering($property)
    {
        if (is_array($property)) {
            $remainingProperties = array_diff($property, $this->ignored->toArray());

            return ! empty($remainingProperties) ? $remainingProperties : null;
        }

        return ! $this->ignored->contains($property) ? $property : null;
    }
}