DevMakerLab\LaravelFilters\AbstractFilterableRepository

Complexity

Total Complexity

11

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	addFilter()	0	13	3
A	applyFilters()	0	19	4
A	limit()	0	5	1
A	resetLimit()	0	5	1
A	resetFilters()	0	5	1
A	extractNeededArgs()	0	3	1

<?php

declare(strict_types=1);

namespace DevMakerLab\LaravelFilters;

use Illuminate\Database\Query\Builder;

abstract class AbstractFilterableRepository
{
    protected array $filters = [];

    protected ?int $limit = null;

    /**
     * @throws FilterClassNotFound
     * @throws IncorrectFilterException
     */
    public function addFilter(string $filter): self
    {
        if (! class_exists($filter)) {
            throw new FilterClassNotFound();
        }

        if (! is_subclass_of($filter, AbstractFilter::class)) {
            throw new IncorrectFilterException($filter);
        }

        $this->filters[] = $filter;

        return $this;
    }

    public function resetFilters(): self
    {
        $this->filters = [];

        return $this;
    }

    public function limit(int $limit): self
    {
        $this->limit = $limit;

        return $this;
    }

    public function resetLimit(): self
    {
        $this->limit = null;

        return $this;
    }

    public function applyFilters(Builder &$builder, array $args): self
    {
        foreach ($this->filters as $filter) {
            $neededArgs = $this->extractNeededArgs($filter, $args);

            if ($filter::isApplicable($neededArgs)) {
                $filterInstance = new $filter($neededArgs);
                $filterInstance->apply($builder);
            }
        }

        if ($this->limit) {

The expression $this->limit of type integer|null is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== null instead.

            $builder->limit($this->limit);
        }

        $this->resetFilters();
        $this->resetLimit();

        return $this;
    }

    private function extractNeededArgs(string $class, array $args): array
    {
        return array_intersect_key($args, array_flip(array_keys(get_class_vars($class))));
    }
}