QueryBuilder::chunk() - Code Metrics - Inspection of "Adds chunk method to query builder to parse sorts" - spatie/laravel-query-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#299)

unknown

created 2019-06-25 17:45 UTC

QueryBuilder::chunk() A

↳ Parent: QueryBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Spatie\QueryBuilder;

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

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

    /**
     * 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()
    {
        $this->parseSorts();

        if (! $this->allowedFields instanceof Collection) {
            $this->addAllRequestedFields();
        }

        return parent::getQuery();
    }

    /**
     * {@inheritdoc}
     */
    public function get($columns = ['*'])
    {
        $this->parseSorts();

        if (! $this->allowedFields instanceof Collection) {
            $this->addAllRequestedFields();
        }

        $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)
    {
        $this->parseSorts();

        if (! $this->allowedFields instanceof Collection) {
            $this->addAllRequestedFields();
        }

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

    public function simplePaginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)
    {
        $this->parseSorts();

        if (! $this->allowedFields instanceof Collection) {
            $this->addAllRequestedFields();
        }

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

    public function chunk($count, callable $callback)
    {
        $this->parseSorts();

        return parent::chunk($count, $callback);
    }

    /**
     * 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\SortsQuery;
9			use Spatie\QueryBuilder\Concerns\FiltersQuery;
10			use Spatie\QueryBuilder\Concerns\AddsFieldsToQuery;
11			use Spatie\QueryBuilder\Concerns\AddsIncludesToQuery;
12			use Spatie\QueryBuilder\Concerns\AppendsAttributesToResults;
13
14			class QueryBuilder extends Builder
15			{
16			use FiltersQuery,
17			SortsQuery,
18			AddsIncludesToQuery,
19			AddsFieldsToQuery,
20			AppendsAttributesToResults;
21
22			/** @var \Spatie\QueryBuilder\QueryBuilderRequest */
23			protected $request;
24
25			public function __construct(Builder $builder, ? Request $request = null)
26			{
27			parent::__construct(clone $builder->getQuery());
28
29			$this->initializeFromBuilder($builder);
30
31			$this->request = QueryBuilderRequest::fromRequest($request ?? request());
32			}
33
34			/**
35			* Create a new QueryBuilder for a request and model.
36			*
37			* @param string\|\Illuminate\Database\Query\Builder $baseQuery Model class or base query builder
38			* @param \Illuminate\Http\Request $request
39			*
40			* @return \Spatie\QueryBuilder\QueryBuilder
41			*/
42			public static function for($baseQuery, ?Request $request = null): self
43			{
44			if (is_string($baseQuery)) {
45			$baseQuery = ($baseQuery)::query();
46			}
47
48			return new static($baseQuery, $request ?? request());
49			}
50
51			public function getQuery()
52			{
53			$this->parseSorts();
54
55			if (! $this->allowedFields instanceof Collection) {
56			$this->addAllRequestedFields();
57			}
58
59			return parent::getQuery();
60			}
61
62			/**
63			* {@inheritdoc}
64			*/
65			public function get($columns = ['*'])
66			{
67			$this->parseSorts();
68
69			if (! $this->allowedFields instanceof Collection) {
70			$this->addAllRequestedFields();
71			}
72
73			$results = parent::get($columns);
74
75			if ($this->request->appends()->isNotEmpty()) {
76			$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...
77			}
78
79			return $results;
80			}
81
82			public function paginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)
83			{
84			$this->parseSorts();
85
86			if (! $this->allowedFields instanceof Collection) {
87			$this->addAllRequestedFields();
88			}
89
90			return parent::paginate($perPage, $columns, $pageName, $page);
91			}
92
93			public function simplePaginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)
94			{
95			$this->parseSorts();
96
97			if (! $this->allowedFields instanceof Collection) {
98			$this->addAllRequestedFields();
99			}
100
101			return parent::simplePaginate($perPage, $columns, $pageName, $page);
102			}
103
104			public function chunk($count, callable $callback)
105			{
106			$this->parseSorts();
107
108			return parent::chunk($count, $callback);
109			}
110
111			/**
112			* Add the model, scopes, eager loaded relationships, local macro's and onDelete callback
113			* from the $builder to this query builder.
114			*
115			* @param \Illuminate\Database\Eloquent\Builder $builder
116			*/
117			protected function initializeFromBuilder(Builder $builder)
118			{
119			$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...
120			->setEagerLoads($builder->getEagerLoads());
121
122			$builder->macro('getProtected', function (Builder $builder, string $property) {
123			return $builder->{$property};
124			});
125
126			$this->scopes = $builder->getProtected('scopes');
127
128			$this->localMacros = $builder->getProtected('localMacros');
129
130			$this->onDelete = $builder->getProtected('onDelete');
131			}
132			}
133

spatie / laravel-query-builder

Pull Request — master (#299)

QueryBuilder::chunk() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like