AddsFieldsToQuery::addFieldsToQuery() - Code Metrics - Inspection of "wip security fix" - spatie/laravel-query-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 75298d...3aa483 )

unknown

created 2019-04-09 13:43 UTC

AddsFieldsToQuery::addFieldsToQuery() A

↳ Parent: AddsFieldsToQuery

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0
cc	2
nc	2
nop	1

<?php

namespace Spatie\QueryBuilder\Concerns;

use Illuminate\Support\Str;
use Illuminate\Support\Collection;
use Spatie\QueryBuilder\ColumnNameSanitizer;
use Spatie\QueryBuilder\Exceptions\InvalidFieldQuery;

trait AddsFieldsToQuery
{
    /** @var \Illuminate\Support\Collection */
    protected $allowedFields;

    public function allowedFields($fields): self
    {
        $fields = is_array($fields) ? $fields : func_get_args();

        $this->allowedFields = collect($fields)
            ->map(function (string $fieldName) {
                if (! Str::contains($fieldName, '.')) {
                    $modelTableName = $this->getModel()->getTable();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

                    return "{$modelTableName}.{$fieldName}";
                }

                return $fieldName;
            });

        if (! $this->allowedFields->contains('*')) {
            $this->guardAgainstUnknownFields();
        }

        return $this;
    }

    public function parseFields()
    {
        $this->addFieldsToQuery($this->getRequestedFields());
    }

    protected function addFieldsToQuery(Collection $fields)
    {
        $modelTableName = $this->getModel()->getTable();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        if ($modelFields = $fields->get($modelTableName)) {
            $sanitizedFields = ColumnNameSanitizer::sanitizeArray($modelFields);

            $prependedFields = $this->prependFieldsWithTableName($sanitizedFields, $modelTableName);

            $this->select($prependedFields);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    protected function prependFieldsWithTableName(array $fields, string $tableName): array
    {
        return array_map(function ($field) use ($tableName) {
            return "{$tableName}.{$field}";
        }, $fields);
    }

    protected function getFieldsForIncludedTable(string $relation): array
    {
        return $this->getRequestedFields()->get($relation, []);
    }

    protected function guardAgainstUnknownFields()
    {
        $fields = $this->getRequestedFields()
            ->map(function ($fields, $model) {
                $tableName = Str::snake(preg_replace('/-/', '_', $model));

                $fields = array_map([Str::class, 'snake'], $fields);

                return $this->prependFieldsWithTableName($fields, $tableName);
            })
            ->flatten()
            ->unique();

        $diff = $fields->diff($this->allowedFields);

        if ($diff->count()) {
            throw InvalidFieldQuery::fieldsNotAllowed($diff, $this->allowedFields);
        }
    }

    protected function getRequestedFields(): Collection
    {
        return $this->request->fields();
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }
}


1			<?php
2
3			namespace Spatie\QueryBuilder\Concerns;
4
5			use Illuminate\Support\Str;
6			use Illuminate\Support\Collection;
7			use Spatie\QueryBuilder\ColumnNameSanitizer;
8			use Spatie\QueryBuilder\Exceptions\InvalidFieldQuery;
9
10			trait AddsFieldsToQuery
11			{
12			/** @var \Illuminate\Support\Collection */
13			protected $allowedFields;
14
15			public function allowedFields($fields): self
16			{
17			$fields = is_array($fields) ? $fields : func_get_args();
18
19			$this->allowedFields = collect($fields)
20			->map(function (string $fieldName) {
21			if (! Str::contains($fieldName, '.')) {
22			$modelTableName = $this->getModel()->getTable();
			0 ignored issues – show Bug introduced 2019-03-11 09:17 UTC by Report Bug Copy Issue Report It seems like `getModel()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
23
24			return "{$modelTableName}.{$fieldName}";
25			}
26
27			return $fieldName;
28			});
29
30			if (! $this->allowedFields->contains('*')) {
31			$this->guardAgainstUnknownFields();
32			}
33
34			return $this;
35			}
36
37			public function parseFields()
38			{
39			$this->addFieldsToQuery($this->getRequestedFields());
40			}
41
42			protected function addFieldsToQuery(Collection $fields)
43			{
44			$modelTableName = $this->getModel()->getTable();
			0 ignored issues – show Bug introduced 2019-03-11 09:17 UTC by Report Bug Copy Issue Report It seems like `getModel()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
45
46			if ($modelFields = $fields->get($modelTableName)) {
47			$sanitizedFields = ColumnNameSanitizer::sanitizeArray($modelFields);
48
49			$prependedFields = $this->prependFieldsWithTableName($sanitizedFields, $modelTableName);
50
51			$this->select($prependedFields);
			0 ignored issues – show Bug introduced 2019-04-09 13:45 UTC by Report Bug Copy Issue Report It seems like `select()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
52			}
53			}
54
55			protected function prependFieldsWithTableName(array $fields, string $tableName): array
56			{
57			return array_map(function ($field) use ($tableName) {
58			return "{$tableName}.{$field}";
59			}, $fields);
60			}
61
62			protected function getFieldsForIncludedTable(string $relation): array
63			{
64			return $this->getRequestedFields()->get($relation, []);
65			}
66
67			protected function guardAgainstUnknownFields()
68			{
69			$fields = $this->getRequestedFields()
70			->map(function ($fields, $model) {
71			$tableName = Str::snake(preg_replace('/-/', '_', $model));
72
73			$fields = array_map([Str::class, 'snake'], $fields);
74
75			return $this->prependFieldsWithTableName($fields, $tableName);
76			})
77			->flatten()
78			->unique();
79
80			$diff = $fields->diff($this->allowedFields);
81
82			if ($diff->count()) {
83			throw InvalidFieldQuery::fieldsNotAllowed($diff, $this->allowedFields);
84			}
85			}
86
87			protected function getRequestedFields(): Collection
88			{
89			return $this->request->fields();
			0 ignored issues – show Bug introduced 2019-04-09 13:45 UTC by Report Bug Copy Issue Report The property `request` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
90			}
91			}
92

spatie / laravel-query-builder

Push — master ( 75298d...3aa483 )

AddsFieldsToQuery::addFieldsToQuery() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like