Spatie\QueryBuilder\Search

Complexity

Total Complexity

23

Size/Duplication

Total Lines	132
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	1

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	search()	0	12	2
A	begins()	0	4	1
A	ends()	0	4	1
A	exact()	0	4	1
A	partial()	0	4	1
A	split()	0	4	1
A	splitBegins()	0	4	1
A	splitEnds()	0	4	1
A	resolver()	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	getColumnName()	0	4	1
A	resolveSearchClass()	0	8	2
A	resolveValueForSearching()	0	10	4

<?php

namespace Spatie\QueryBuilder;

use Illuminate\Support\Collection;
use Illuminate\Database\Eloquent\Builder;

use Spatie\QueryBuilder\Searches\Search as CustomSearch;
use Spatie\QueryBuilder\Searches\SearchesBegins;
use Spatie\QueryBuilder\Searches\SearchesEnds;
use Spatie\QueryBuilder\Searches\SearchesExact;
use Spatie\QueryBuilder\Searches\SearchesPartial;
use Spatie\QueryBuilder\Searches\SearchesModifierResolver;
use Spatie\QueryBuilder\Searches\SearchesSplit;
use Spatie\QueryBuilder\Searches\SearchesSplitBegins;
use Spatie\QueryBuilder\Searches\SearchesSplitEnds;

class Search
{
    /** @var string|\Spatie\QueryBuilder\Searches\Search */
    protected $searchClass;

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

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

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

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

        $this->searchClass = $searchClass;

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

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

    public function search(Builder $builder, $value, $modifier = null)
    {
        $valueToSearch = $this->resolveValueForSearching($value);

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

        $searchClass = $this->resolveSearchClass();

        ($searchClass)($builder, $valueToSearch, $this->columnName, $modifier);
    }

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

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

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

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

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

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

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

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

    public static function custom(string $property, $searchClass, $columnName = null): self
    {
        return new static($property, $searchClass, $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 getColumnName(): string
    {
        return $this->columnName;
    }

    private function resolveSearchClass(): CustomSearch
    {
        if ($this->searchClass instanceof CustomSearch) {
            return $this->searchClass;
        }

        return new $this->searchClass;
    }

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

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

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