AddsFieldsToQuery::prependFieldsWithTableName() - Code Metrics - Inspection of "Allow disabling exceptions for invalid queries" - spatie/laravel-query-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fc49af...187043 )

unknown

created 2020-01-22 13:40 UTC

AddsFieldsToQuery::prependFieldsWithTableName() A

↳ Parent: AddsFieldsToQuery

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\Concerns;

use Illuminate\Support\Collection;
use Illuminate\Support\Str;
use Spatie\QueryBuilder\Exceptions\AllowedFieldsMustBeCalledBeforeAllowedIncludes;
use Spatie\QueryBuilder\Exceptions\InvalidFieldQuery;
use Spatie\QueryBuilder\Exceptions\UnknownIncludedFieldsQuery;

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

    public function allowedFields($fields): self
    {
        if ($this->allowedIncludes instanceof Collection) {
class MyClass { }

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

        $fields = is_array($fields) ? $fields : func_get_args();

        $this->allowedFields = collect($fields)
            ->map(function (string $fieldName) {
                return $this->prependField($fieldName);
            });

        $this->ensureAllFieldsExist();

        $this->addRequestedModelFieldsToQuery();

        return $this;
    }

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

        $modelFields = $this->request->fields()->get($modelTableName);
class MyClass { }

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

        if (empty($modelFields)) {
            return;
        }

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

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

    public function getRequestedFieldsForRelatedTable(string $relation): array
    {
        $fields = $this->request->fields()->mapWithKeys(function ($fields, $relation) {
            return [Str::camel($relation) => $fields];
        })->get($relation);

        if (! $fields) {
            return [];
        }

        if (! $this->allowedFields instanceof Collection) {
            // We have requested fields but no allowed fields (yet?)

            throw new UnknownIncludedFieldsQuery($fields);
        }

        return $fields;
    }

    protected function ensureAllFieldsExist()
    {
        if (! $this->throwInvalidQueryExceptions) {
class MyClass { }

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

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

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

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

        $unknownFields = $requestedFields->diff($this->allowedFields);

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

    protected function prependFieldsWithTableName(array $fields, string $tableName): array
    {
        return array_map(function ($field) use ($tableName) {
            return $this->prependField($field, $tableName);
        }, $fields);
    }

    protected function prependField(string $field, ?string $table = null): string
    {
        if (! $table) {
            $table = $this->getModel()->getTable();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        if (Str::contains($field, '.')) {
            // Already prepended

            return $field;
        }

        return "{$table}.{$field}";
    }
}


1			<?php
2
3			namespace Spatie\QueryBuilder\Concerns;
4
5			use Illuminate\Support\Collection;
6			use Illuminate\Support\Str;
7			use Spatie\QueryBuilder\Exceptions\AllowedFieldsMustBeCalledBeforeAllowedIncludes;
8			use Spatie\QueryBuilder\Exceptions\InvalidFieldQuery;
9			use Spatie\QueryBuilder\Exceptions\UnknownIncludedFieldsQuery;
10
11			trait AddsFieldsToQuery
12			{
13			/** @var \Illuminate\Support\Collection */
14			protected $allowedFields;
15
16			public function allowedFields($fields): self
17			{
18			if ($this->allowedIncludes instanceof Collection) {
			0 ignored issues – show Bug introduced 2019-08-05 15:01 UTC by Report Bug Copy Issue Report The property `allowedIncludes` 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...
19			throw new AllowedFieldsMustBeCalledBeforeAllowedIncludes();
20			}
21
22			$fields = is_array($fields) ? $fields : func_get_args();
23
24			$this->allowedFields = collect($fields)
25			->map(function (string $fieldName) {
26			return $this->prependField($fieldName);
27			});
28
29			$this->ensureAllFieldsExist();
30
31			$this->addRequestedModelFieldsToQuery();
32
33			return $this;
34			}
35
36			protected function addRequestedModelFieldsToQuery()
37			{
38			$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...
39
40			$modelFields = $this->request->fields()->get($modelTableName);
			0 ignored issues – show Bug introduced 2019-08-05 15:01 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...
41
42			if (empty($modelFields)) {
43			return;
44			}
45
46			$prependedFields = $this->prependFieldsWithTableName($modelFields, $modelTableName);
47
48			$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...
49			}
50
51			public function getRequestedFieldsForRelatedTable(string $relation): array
52			{
53			$fields = $this->request->fields()->mapWithKeys(function ($fields, $relation) {
54			return [Str::camel($relation) => $fields];
55			})->get($relation);
56
57			if (! $fields) {
58			return [];
59			}
60
61			if (! $this->allowedFields instanceof Collection) {
62			// We have requested fields but no allowed fields (yet?)
63
64			throw new UnknownIncludedFieldsQuery($fields);
65			}
66
67			return $fields;
68			}
69
70			protected function ensureAllFieldsExist()
71			{
72			if (! $this->throwInvalidQueryExceptions) {
			0 ignored issues – show Bug introduced 2020-01-22 13:42 UTC by Report Bug Copy Issue Report The property `throwInvalidQueryExceptions` 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...
73			return;
74			}
75
76			$requestedFields = $this->request->fields()
77			->map(function ($fields, $model) {
78			$tableName = Str::snake(preg_replace('/-/', '_', $model));
79
80			$fields = array_map([Str::class, 'snake'], $fields);
81
82			return $this->prependFieldsWithTableName($fields, $tableName);
83			})
84			->flatten()
85			->unique();
86
87			$unknownFields = $requestedFields->diff($this->allowedFields);
88
89			if ($unknownFields->isNotEmpty()) {
90			throw InvalidFieldQuery::fieldsNotAllowed($unknownFields, $this->allowedFields);
91			}
92			}
93
94			protected function prependFieldsWithTableName(array $fields, string $tableName): array
95			{
96			return array_map(function ($field) use ($tableName) {
97			return $this->prependField($field, $tableName);
98			}, $fields);
99			}
100
101			protected function prependField(string $field, ?string $table = null): string
102			{
103			if (! $table) {
104			$table = $this->getModel()->getTable();
			0 ignored issues – show Bug introduced 2019-08-05 15:01 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...
105			}
106
107			if (Str::contains($field, '.')) {
108			// Already prepended
109
110			return $field;
111			}
112
113			return "{$table}.{$field}";
114			}
115			}
116

spatie / laravel-query-builder

Push — master ( fc49af...187043 )

AddsFieldsToQuery::prependFieldsWithTableName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like