QueryBuilder::allowedIncludes() - Code Metrics - Inspection of "Deprecate macros in favor of QueryBuilderRequest" - spatie/laravel-query-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 62a574...40c09d )

unknown

created 2019-03-11 09:15 UTC

QueryBuilder::allowedIncludes() A

↳ Parent: Project

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	9.568
c	0
b	0
f	0
cc	3
nc	2
nop	1

<?php

namespace Spatie\QueryBuilder;

use Illuminate\Http\Request;
use Illuminate\Support\Collection;
use Illuminate\Database\Eloquent\Builder;
use Spatie\QueryBuilder\Concerns\AddsFieldsToQuery;
use Spatie\QueryBuilder\Concerns\AddsIncludesToQuery;
use Spatie\QueryBuilder\Concerns\AppendsAttributesToResults;
use Spatie\QueryBuilder\Concerns\FiltersQuery;
use Spatie\QueryBuilder\Concerns\SortsQuery;

class QueryBuilder extends Builder
{
    use FiltersQuery, SortsQuery, AddsIncludesToQuery, AddsFieldsToQuery, AppendsAttributesToResults;

    /** @var \Spatie\QueryBuilder\QueryBuilderRequest */
    protected $request;

    public function __construct(Builder $builder, ? Request $request = null)
    {
        parent::__construct(clone $builder->getQuery());

        $this->initializeFromBuilder($builder);

        $this->request = QueryBuilderRequest::fromRequest($request ?? request());

        $this->parseFields();
    }

    /**
     * Create a new QueryBuilder for a request and model.
     *
     * @param string|\Illuminate\Database\Query\Builder $baseQuery Model class or base query builder
     * @param \Illuminate\Http\Request                  $request
     *
     * @return \Spatie\QueryBuilder\QueryBuilder
     */
    public static function for($baseQuery, ?Request $request = null): self
    {
        if (is_string($baseQuery)) {
            $baseQuery = ($baseQuery)::query();
        }

        return new static($baseQuery, $request ?? request());
    }

    public function getQuery()
    {
        if ($this->request->sorts() && ! $this->allowedSorts instanceof Collection) {
            $this->addDefaultSorts();
        }

        return parent::getQuery();
    }

    /**
     * {@inheritdoc}
     */
    public function get($columns = ['*'])
    {
        if ($this->request->sorts() && ! $this->allowedSorts instanceof Collection) {
            $this->addDefaultSorts();
        }

        $results = parent::get($columns);

        if ($this->request->appends()->isNotEmpty()) {
            $results = $this->addAppendsToResults($results);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }

        return $results;
    }

    public function paginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)
    {
        if ($this->request->sorts() && ! $this->allowedSorts instanceof Collection) {
            $this->addDefaultSorts();
        }

        return parent::paginate($perPage, $columns, $pageName, $page);
    }

    public function simplePaginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)
    {
        if ($this->request->sorts() && ! $this->allowedSorts instanceof Collection) {
            $this->addDefaultSorts();
        }

        return parent::simplePaginate($perPage, $columns, $pageName, $page);
    }

    /**
     * Add the model, scopes, eager loaded relationships, local macro's and onDelete callback
     * from the $builder to this query builder.
     *
     * @param \Illuminate\Database\Eloquent\Builder $builder
     */
    protected function initializeFromBuilder(Builder $builder)
    {
        $this->setModel($builder->getModel())

            ->setEagerLoads($builder->getEagerLoads());

        $builder->macro('getProtected', function (Builder $builder, string $property) {
            return $builder->{$property};
        });

        $this->scopes = $builder->getProtected('scopes');

        $this->localMacros = $builder->getProtected('localMacros');

        $this->onDelete = $builder->getProtected('onDelete');
    }
}


1			<?php
2
3			namespace Spatie\QueryBuilder;
4
5			use Illuminate\Http\Request;
6			use Illuminate\Support\Collection;
7			use Illuminate\Database\Eloquent\Builder;
8			use Spatie\QueryBuilder\Concerns\AddsFieldsToQuery;
9			use Spatie\QueryBuilder\Concerns\AddsIncludesToQuery;
10			use Spatie\QueryBuilder\Concerns\AppendsAttributesToResults;
11			use Spatie\QueryBuilder\Concerns\FiltersQuery;
12			use Spatie\QueryBuilder\Concerns\SortsQuery;
13
14			class QueryBuilder extends Builder
15			{
16			use FiltersQuery, SortsQuery, AddsIncludesToQuery, AddsFieldsToQuery, AppendsAttributesToResults;
17
18			/** @var \Spatie\QueryBuilder\QueryBuilderRequest */
19			protected $request;
20
21			public function __construct(Builder $builder, ? Request $request = null)
22			{
23			parent::__construct(clone $builder->getQuery());
24
25			$this->initializeFromBuilder($builder);
26
27			$this->request = QueryBuilderRequest::fromRequest($request ?? request());
28
29			$this->parseFields();
30			}
31
32			/**
33			* Create a new QueryBuilder for a request and model.
34			*
35			* @param string\|\Illuminate\Database\Query\Builder $baseQuery Model class or base query builder
36			* @param \Illuminate\Http\Request $request
37			*
38			* @return \Spatie\QueryBuilder\QueryBuilder
39			*/
40			public static function for($baseQuery, ?Request $request = null): self
41			{
42			if (is_string($baseQuery)) {
43			$baseQuery = ($baseQuery)::query();
44			}
45
46			return new static($baseQuery, $request ?? request());
47			}
48
49			public function getQuery()
50			{
51			if ($this->request->sorts() && ! $this->allowedSorts instanceof Collection) {
52			$this->addDefaultSorts();
53			}
54
55			return parent::getQuery();
56			}
57
58			/**
59			* {@inheritdoc}
60			*/
61			public function get($columns = ['*'])
62			{
63			if ($this->request->sorts() && ! $this->allowedSorts instanceof Collection) {
64			$this->addDefaultSorts();
65			}
66
67			$results = parent::get($columns);
68
69			if ($this->request->appends()->isNotEmpty()) {
70			$results = $this->addAppendsToResults($results);
			0 ignored issues – show Bug introduced 2019-03-11 09:17 UTC by Report Bug Copy Issue Report It seems like `$results` can also be of type `array<integer,object<Ill...base\Eloquent\Builder>>`; however, `Spatie\QueryBuilder\Conc...::addAppendsToResults()` does only seem to accept `object<Illuminate\Support\Collection>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
71			}
72
73			return $results;
74			}
75
76			public function paginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)
77			{
78			if ($this->request->sorts() && ! $this->allowedSorts instanceof Collection) {
79			$this->addDefaultSorts();
80			}
81
82			return parent::paginate($perPage, $columns, $pageName, $page);
83			}
84
85			public function simplePaginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)
86			{
87			if ($this->request->sorts() && ! $this->allowedSorts instanceof Collection) {
88			$this->addDefaultSorts();
89			}
90
91			return parent::simplePaginate($perPage, $columns, $pageName, $page);
92			}
93
94			/**
95			* Add the model, scopes, eager loaded relationships, local macro's and onDelete callback
96			* from the $builder to this query builder.
97			*
98			* @param \Illuminate\Database\Eloquent\Builder $builder
99			*/
100			protected function initializeFromBuilder(Builder $builder)
101			{
102			$this->setModel($builder->getModel())
			0 ignored issues – show Bug introduced 2018-09-14 20:54 UTC by Report Bug Copy Issue Report It seems like `$builder->getModel()` targeting `Illuminate\Database\Eloquent\Builder::getModel()` can also be of type `object<Illuminate\Database\Eloquent\Builder>`; however, `Illuminate\Database\Eloquent\Builder::setModel()` does only seem to accept `object<Illuminate\Database\Eloquent\Model>`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
103			->setEagerLoads($builder->getEagerLoads());
104
105			$builder->macro('getProtected', function (Builder $builder, string $property) {
106			return $builder->{$property};
107			});
108
109			$this->scopes = $builder->getProtected('scopes');
110
111			$this->localMacros = $builder->getProtected('localMacros');
112
113			$this->onDelete = $builder->getProtected('onDelete');
114			}
115			}
116

spatie / laravel-query-builder

Push — master ( 62a574...40c09d )

QueryBuilder::allowedIncludes() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like