Cerbero\QueryFilters\QueryFilters

Complexity

Total Complexity

8

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

80%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	hydrate()	0	6	1
A	applyToQuery()	0	14	3
A	filterCanBeApplied()	0	7	3

<?php

namespace Cerbero\QueryFilters;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Illuminate\Support\Str;

/**
 * Abstract implementation of a query filters applier.
 *
 */
abstract class QueryFilters
{
    /**
     * The current HTTP request.
     *
     * @var Illuminate\Http\Request
     */
    protected $request;

    /**
     * Eloquent query builder.
     *
     * @var     Illuminate\Database\Eloquent\Builder
     */
    protected $query;

    /**
     * List of filters not requiring a value.
     *
     * @var array
     */
    protected $implicitFilters = [];

    /**
     * Set the dependencies.
     *
     * @param    Request    $request
     * @return    void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct(Request $request)

You have injected the Request via parameter $request. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via getCurrentRequest().

    {
        $this->request = $request;

It seems like $request of type object<Illuminate\Http\Request> is incompatible with the declared type object<Cerbero\QueryFilters\Illuminate\Http\Request> of property $request.

    }

    /**
     * Hydrate the filters from plain array.
     *
     * @param    array    $queries
     * @return    static
     */
    public static function hydrate(array $queries)
    {
        $request = new Request($queries);

        return new static($request);
    }

    /**
     * Apply all the filters to the given query.
     *
     * @param    Illuminate\Database\Eloquent\Builder    $query
     * @return    Illuminate\Database\Eloquent\Builder
     */
    public function applyToQuery(Builder $query)
    {
        $this->query = $query;

It seems like $query of type object<Illuminate\Database\Eloquent\Builder> is incompatible with the declared type object<Cerbero\QueryFilters\Illuminate\Database\Eloquent\Builder> of property $query.

        foreach ($this->request->all() as $filter => $value) {
            $method = Str::camel($filter);

            if ($this->filterCanBeApplied($method, $value)) {
                call_user_func([$this, $method], $value);
            }
        }

        return $query;
    }

    /**
     * Determine whether the given filter can be applied with the provided value.
     *
     * @param string $filter
     * @param mixed $value
     * @return boolean
     */
    protected function filterCanBeApplied($filter, $value)
    {
        $filterExists = method_exists($this, $filter);
        $valueIsLegit = $value !== '' || in_array($filter, $this->implicitFilters);

        return $filterExists && $valueIsLegit;
    }
}