QueryFilters::filterCanBeApplied() - Code Metrics - Inspection of "Merge branch 'release/1.3.0'" - cerbero90/query-filters - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (d27573)

by Andrea Marco

created 2017-08-15 13:21 UTC

QueryFilters::filterCanBeApplied() A

↳ Parent: QueryFilters

Complexity

Conditions	3
Paths	4

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	0
cts	0
cp	0
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	4
nc	4
nop	2
crap	12

<?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

     */
    public function __construct(Request $request)

    {
        $this->request = $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;


        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;
    }
}


1		<?php
2
3		namespace Cerbero\QueryFilters;
4
5		use Illuminate\Database\Eloquent\Builder;
6		use Illuminate\Http\Request;
7		use Illuminate\Support\Str;
8
9		/**
10		* Abstract implementation of a query filters applier.
11		*
12		*/
13		abstract class QueryFilters
14		{
15		/**
16		* The current HTTP request.
17		*
18		* @var Illuminate\Http\Request
19		*/
20		protected $request;
21
22		/**
23		* Eloquent query builder.
24		*
25		* @var Illuminate\Database\Eloquent\Builder
26		*/
27		protected $query;
28
29		/**
30		* List of filters not requiring a value.
31		*
32		* @var array
33		*/
34		protected $implicitFilters = [];
35	6
36		/**
37	6	* Set the dependencies.
38	6	*
39		* @param Request $request
40		* @return void
		0 ignored issues – show Comprehensibility Best Practice introduced 2016-04-25 15:00 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
41		*/
42		public function __construct(Request $request)
		1 ignored issue – show Bug introduced 2017-08-15 13:08 UTC by Report Bug Copy Issue Report 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()`. Loading history...
43		{
44		$this->request = $request;
		0 ignored issues – show Documentation Bug introduced 2016-04-25 15:00 UTC by Report Bug Copy Issue Report It seems like `$request` of type `object<Illuminate\Http\Request>` is incompatible with the declared type `object<Cerbero\QueryFilt...lluminate\Http\Request>` of property `$request`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
45		}
46
47		/**
48		* Hydrate the filters from plain array.
49		*
50		* @param array $queries
51		* @return static
52		*/
53		public static function hydrate(array $queries)
54		{
55		$request = new Request($queries);
56
57		return new static($request);
58		}
59	3
60		/**
61	3	* Apply all the filters to the given query.
62		*
63	3	* @param Illuminate\Database\Eloquent\Builder $query
64	3	* @return Illuminate\Database\Eloquent\Builder
65		*/
66	3	public function applyToQuery(Builder $query)
67	3	{
68	3	$this->query = $query;
		0 ignored issues – show Documentation Bug introduced 2016-04-25 15:00 UTC by Report Bug Copy Issue Report It seems like `$query` of type `object<Illuminate\Database\Eloquent\Builder>` is incompatible with the declared type `object<Cerbero\QueryFilt...abase\Eloquent\Builder>` of property `$query`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
69	3
70		foreach ($this->request->all() as $filter => $value) {
71	3	$method = Str::camel($filter);
72
73		if ($this->filterCanBeApplied($method, $value)) {
74		call_user_func([$this, $method], $value);
75		}
76		}
77
78		return $query;
79		}
80
81		/**
82		* Determine whether the given filter can be applied with the provided value.
83		*
84		* @param string $filter
85		* @param mixed $value
86		* @return boolean
87		*/
88		protected function filterCanBeApplied($filter, $value)
89		{
90		$filterExists = method_exists($this, $filter);
91		$valueIsLegit = $value !== '' \|\| in_array($filter, $this->implicitFilters);
92
93		return $filterExists && $valueIsLegit;
94		}
95		}
96

cerbero90 / query-filters

Branch — master (d27573)

QueryFilters::filterCanBeApplied() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like