SearchesBase::isRelationProperty() - Code Metrics - Inspection of "Add search capabilities" - spatie/laravel-query-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#223)

by Axel

created 2019-03-20 16:56 UTC

SearchesBase::isRelationProperty() A

↳ Parent: SearchesBase

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0
cc	4
nc	4
nop	2

<?php

namespace Spatie\QueryBuilder\Searches;

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

abstract class SearchesBase implements Search
{
    protected $relationConstraints = [];

    abstract public function __invoke(Builder $query, $value, string $property, ?string $modifier = null) : Builder;

    protected function isRelationProperty(Builder $query, string $property) : bool
    {
        if (! Str::contains($property, '.')) {
            return false;
        }

        if (in_array($property, $this->relationConstraints)) {
            return false;
        }

        if (Str::startsWith($property, $query->getModel()->getTable().'.')) {
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.
}
            return false;
        }

        return true;
    }

    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([Str::class, 'camel'])->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);
        });
    }

    protected function encloseValue($value)
    {
        return "{$value}";
    }
}


1			<?php
2
3			namespace Spatie\QueryBuilder\Searches;
4
5			use Illuminate\Support\Str;
6			use Illuminate\Support\Collection;
7			use Illuminate\Database\Eloquent\Builder;
8
9			abstract class SearchesBase implements Search
10			{
11			protected $relationConstraints = [];
12
13			abstract public function __invoke(Builder $query, $value, string $property, ?string $modifier = null) : Builder;
14
15			protected function isRelationProperty(Builder $query, string $property) : bool
16			{
17			if (! Str::contains($property, '.')) {
18			return false;
19			}
20
21			if (in_array($property, $this->relationConstraints)) {
22			return false;
23			}
24
25			if (Str::startsWith($property, $query->getModel()->getTable().'.')) {
			0 ignored issues – show Bug introduced 2019-03-20 17:00 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...
26			return false;
27			}
28
29			return true;
30			}
31
32			protected function withRelationConstraint(Builder $query, $value, string $property) : Builder
33			{
34			[$relation, $property] = collect(explode('.', $property))
			0 ignored issues – show Bug introduced 2019-03-20 17:00 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...
35			->pipe(function (Collection $parts) {
36			return [
37			$parts->except(count($parts) - 1)->map([Str::class, 'camel'])->implode('.'),
38			$parts->last(),
39			];
40			});
41
42			return $query->whereHas($relation, function (Builder $query) use ($value, $relation, $property) {
43			$this->relationConstraints[] = $property = $query->getModel()->getTable().'.'.$property;
			0 ignored issues – show Bug introduced 2019-03-20 17:00 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 2019-03-20 17:00 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...
44
45			$this->__invoke($query, $value, $property);
46			});
47			}
48
49			protected function encloseValue($value)
50			{
51			return "{$value}";
52			}
53			}
54

spatie / laravel-query-builder

Pull Request — master (#223)

SearchesBase::isRelationProperty() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Change not visible in outer-scope

Change visible in outer-scope

Duplication Side-by-Side

Filter issues like