QueryBuilderRequest::getArrayValueDelimiter() - Code Metrics - Inspection of "Merge pull request #369 from dominikb/issue-229-ar..." - spatie/laravel-query-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1ec95f...b2eddc )

by Freek

created 2020-01-04 22:53 UTC

QueryBuilderRequest::getArrayValueDelimiter() A

↳ Parent: QueryBuilderRequest

Complexity

Conditions	1
Paths	1

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	1
nc	1
nop	0

<?php

namespace Spatie\QueryBuilder;

use Illuminate\Http\Request;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;

class QueryBuilderRequest extends Request
{
    private static $arrayValueDelimiter = ',';

    public static function setArrayValueDelimiter(string $delimiter): void
    {
        static::$arrayValueDelimiter = $delimiter;
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
    }

    public static function getArrayValueDelimiter(): string
    {
        return static::$arrayValueDelimiter;
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
    }

    public static function fromRequest(Request $request): self
    {
        return static::createFrom($request, new self());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function includes(): Collection
    {
        $includeParameterName = config('query-builder.parameters.include');

        $includeParts = $this->query($includeParameterName);

        if (! is_array($includeParts)) {
            $includeParts = explode(static::getArrayValueDelimiter(), $this->query($includeParameterName));
        }

        return collect($includeParts)
            ->filter()
            ->map([Str::class, 'camel']);
    }

    public function appends(): Collection
    {
        $appendParameterName = config('query-builder.parameters.append');

        $appendParts = $this->query($appendParameterName);

        if (! is_array($appendParts)) {
            $appendParts = explode(static::getArrayValueDelimiter(), strtolower($appendParts));
        }

        return collect($appendParts)->filter();
    }

    public function filters(): Collection
    {
        $filterParameterName = config('query-builder.parameters.filter');

        $filterParts = $this->query($filterParameterName, []);

        if (is_string($filterParts)) {
            return collect();
        }

        $filters = collect($filterParts);

        return $filters->map(function ($value) {
            return $this->getFilterValue($value);
        });
    }

    public function fields(): Collection

    {
        $fieldsParameterName = config('query-builder.parameters.fields');

        $fieldsPerTable = collect($this->query($fieldsParameterName));

        if ($fieldsPerTable->isEmpty()) {
            return collect();
        }

        return $fieldsPerTable->map(function ($fields) {
            return explode(static::getArrayValueDelimiter(), $fields);
        });
    }

    public function sorts(): Collection

    {
        $sortParameterName = config('query-builder.parameters.sort');

        $sortParts = $this->query($sortParameterName);

        if (is_string($sortParts)) {
            $sortParts = explode(static::getArrayValueDelimiter(), $sortParts);
        }

        return collect($sortParts)->filter();
    }

    /**
     * @param $value
     *
     * @return array|bool
     */
    protected function getFilterValue($value)
    {
        if (is_array($value)) {
            return collect($value)->map(function ($valueValue) {
                return $this->getFilterValue($valueValue);
            })->all();
        }

        if (Str::contains($value, static::getArrayValueDelimiter())) {
            return explode(static::getArrayValueDelimiter(), $value);
        }

        if ($value === 'true') {
            return true;
        }

        if ($value === 'false') {
            return false;
        }

        return $value;
    }
}


1		<?php
2
3		namespace Spatie\QueryBuilder;
4
5		use Illuminate\Http\Request;
6		use Illuminate\Support\Collection;
7		use Illuminate\Support\Str;
8
9		class QueryBuilderRequest extends Request
10		{
11		private static $arrayValueDelimiter = ',';
12
13		public static function setArrayValueDelimiter(string $delimiter): void
14		{
15		static::$arrayValueDelimiter = $delimiter;
		0 ignored issues – show Bug introduced 2019-10-29 09:24 UTC by Report Bug Copy Issue Report Since `$arrayValueDelimiter` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$arrayValueDelimiter` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
16		}
17
18		public static function getArrayValueDelimiter(): string
19		{
20		return static::$arrayValueDelimiter;
		0 ignored issues – show Bug introduced 2019-10-29 09:24 UTC by Report Bug Copy Issue Report Since `$arrayValueDelimiter` is declared private, accessing it with `static` will lead to errors in possible sub-classes; consider using `self`, or increasing the visibility of `$arrayValueDelimiter` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static $someVariable; public static function getSomeVariable() { return static::$someVariable; } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { } YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class SomeClass { private static $someVariable; public static function getSomeVariable() { return self::$someVariable; // self works fine with private. } } Loading history...
21		}
22
23		public static function fromRequest(Request $request): self
24		{
25		return static::createFrom($request, new self());
		0 ignored issues – show Documentation introduced 2019-03-11 09:17 UTC by Report Bug Copy Issue Report `$request` is of type `object<Illuminate\Http\Request>`, but the function expects a `object<self>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
26		}
27
28		public function includes(): Collection
29		{
30		$includeParameterName = config('query-builder.parameters.include');
31
32		$includeParts = $this->query($includeParameterName);
33
34		if (! is_array($includeParts)) {
35		$includeParts = explode(static::getArrayValueDelimiter(), $this->query($includeParameterName));
36		}
37
38		return collect($includeParts)
39		->filter()
40		->map([Str::class, 'camel']);
41		}
42
43		public function appends(): Collection
44		{
45		$appendParameterName = config('query-builder.parameters.append');
46
47		$appendParts = $this->query($appendParameterName);
48
49		if (! is_array($appendParts)) {
50		$appendParts = explode(static::getArrayValueDelimiter(), strtolower($appendParts));
51		}
52
53		return collect($appendParts)->filter();
54		}
55
56		public function filters(): Collection
57		{
58		$filterParameterName = config('query-builder.parameters.filter');
59
60		$filterParts = $this->query($filterParameterName, []);
61
62		if (is_string($filterParts)) {
63		return collect();
64		}
65
66		$filters = collect($filterParts);
67
68		return $filters->map(function ($value) {
69		return $this->getFilterValue($value);
70		});
71		}
72
73	View Code Duplication	public function fields(): Collection
		0 ignored issues – show Duplication introduced 2019-03-11 09:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
74		{
75		$fieldsParameterName = config('query-builder.parameters.fields');
76
77		$fieldsPerTable = collect($this->query($fieldsParameterName));
78
79		if ($fieldsPerTable->isEmpty()) {
80		return collect();
81		}
82
83		return $fieldsPerTable->map(function ($fields) {
84		return explode(static::getArrayValueDelimiter(), $fields);
85		});
86		}
87
88	View Code Duplication	public function sorts(): Collection
		0 ignored issues – show Duplication introduced 2019-04-11 02:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
89		{
90		$sortParameterName = config('query-builder.parameters.sort');
91
92		$sortParts = $this->query($sortParameterName);
93
94		if (is_string($sortParts)) {
95		$sortParts = explode(static::getArrayValueDelimiter(), $sortParts);
96		}
97
98		return collect($sortParts)->filter();
99		}
100
101		/**
102		* @param $value
103		*
104		* @return array\|bool
105		*/
106		protected function getFilterValue($value)
107		{
108		if (is_array($value)) {
109		return collect($value)->map(function ($valueValue) {
110		return $this->getFilterValue($valueValue);
111		})->all();
112		}
113
114		if (Str::contains($value, static::getArrayValueDelimiter())) {
115		return explode(static::getArrayValueDelimiter(), $value);
116		}
117
118		if ($value === 'true') {
119		return true;
120		}
121
122		if ($value === 'false') {
123		return false;
124		}
125
126		return $value;
127		}
128		}
129

spatie / laravel-query-builder

Push — master ( 1ec95f...b2eddc )

QueryBuilderRequest::getArrayValueDelimiter() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like