FiltersExact::isRelationProperty() - Code Metrics - Inspection of "Allow to filter by related model properties (#136)" - spatie/laravel-query-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 400362...7d9551 )

unknown

created 2018-12-11 10:15 UTC

FiltersExact::isRelationProperty() A

↳ Parent: FiltersExact

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	1

<?php

namespace Spatie\QueryBuilder\Filters;

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

class FiltersExact implements Filter
{
    protected $relationConstraints = [];

    public function __invoke(Builder $query, $value, string $property) : Builder
    {
        if ($this->isRelationProperty($property)) {
            return $this->withRelationConstraint($query, $value, $property);
        }

        if (is_array($value)) {
            return $query->whereIn($property, $value);
        }

        return $query->where($property, '=', $value);
    }

    protected function isRelationProperty(string $property) : bool
    {
        return Str::contains($property, '.') && ! in_array($property, $this->relationConstraints);
    }

    protected function withRelationConstraint(Builder $query, $value, string $property) : Builder
    {
        [$relation, $property] = collect(explode('.', $property))

            ->pipe(function (Collection $parts) {
                return [
                    $parts->except(count($parts) - 1)->map('camel_case')->implode('.'),
                    $parts->last(),
                ];
            });

        return $query->whereHas($relation, function (Builder $query) use ($value, $relation, $property) {
            $this->relationConstraints[] = $property = $query->getModel()->getTable().'.'.$property;
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

            $this->__invoke($query, $value, $property);
        });
    }
}


Push — master ( 400362...7d9551 )

FiltersExact::isRelationProperty() A

Complexity

Size

Duplication

Importance

Available Fixes

Change not visible in outer-scope

Change visible in outer-scope

1			<?php
2
3			namespace Spatie\QueryBuilder\Filters;
4
5			use Illuminate\Support\Str;
6			use Illuminate\Support\Collection;
7			use Illuminate\Database\Eloquent\Builder;
8
9			class FiltersExact implements Filter
10			{
11			protected $relationConstraints = [];
12
13			public function __invoke(Builder $query, $value, string $property) : Builder
14			{
15			if ($this->isRelationProperty($property)) {
16			return $this->withRelationConstraint($query, $value, $property);
17			}
18
19			if (is_array($value)) {
20			return $query->whereIn($property, $value);
21			}
22
23			return $query->where($property, '=', $value);
24			}
25
26			protected function isRelationProperty(string $property) : bool
27			{
28			return Str::contains($property, '.') && ! in_array($property, $this->relationConstraints);
29			}
30
31			protected function withRelationConstraint(Builder $query, $value, string $property) : Builder
32			{
33			[$relation, $property] = collect(explode('.', $property))
			0 ignored issues – show Bug introduced 2018-10-26 21:21 UTC by Report Bug Copy Issue Report The variable `$relation` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
34			->pipe(function (Collection $parts) {
35			return [
36			$parts->except(count($parts) - 1)->map('camel_case')->implode('.'),
37			$parts->last(),
38			];
39			});
40
41			return $query->whereHas($relation, function (Builder $query) use ($value, $relation, $property) {
42			$this->relationConstraints[] = $property = $query->getModel()->getTable().'.'.$property;
			0 ignored issues – show Bug introduced 2018-10-26 21:21 UTC by Report Bug Copy Issue Report The method `getTable` does only exist in `Illuminate\Database\Eloquent\Model`, but not in `Illuminate\Database\Eloquent\Builder`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history... Bug introduced 2018-10-26 21:21 UTC by Report Bug Copy Issue Report Consider using a different name than the imported variable `$property`, or did you forget to import by reference? It seems like you are assigning to a variable which was imported through a `use` statement which was not imported by reference. For clarity, we suggest to use a different name or import by reference depending on whether you would like to have the change visibile in outer-scope. Change not visible in outer-scope $x = 1; $callable = function() use ($x) { $x = 2; // Not visible in outer scope. If you would like this, how // about using a different variable name than $x? }; $callable(); var_dump($x); // integer(1) Change visible in outer-scope $x = 1; $callable = function() use (&$x) { $x = 2; }; $callable(); var_dump($x); // integer(2) Loading history...
43
44			$this->__invoke($query, $value, $property);
45			});
46			}
47			}
48

spatie / laravel-query-builder

Push — master ( 400362...7d9551 )

FiltersExact::isRelationProperty() A

Complexity

Size

Duplication

Importance

Available Fixes

Change not visible in outer-scope

Change visible in outer-scope

Duplication Side-by-Side

Filter issues like