Scrutinizer GitHub App not installed

We could not synchronize checks via GitHub's checks API since Scrutinizer's GitHub App is not installed for this repository.

Install GitHub App

Test Setup Failed
Pull Request — master (#3250)
by Cristian
33:00 queued 16:22
created

guessIfFieldHasPivotFromRelationType()   A

Complexity

Conditions 6
Paths 6

Size

Total Lines 11
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 6
eloc 9
nc 6
nop 1
dl 0
loc 11
rs 9.2222
c 0
b 0
f 0
1
<?php
2
3
namespace Backpack\CRUD\app\Library\CrudPanel\Traits;
4
5
use Illuminate\Support\Arr;
6
7
trait Relationships
8
{
9
    /**
10
     * From the field entity we get the relation instance.
11
     *
12
     * @param array $entity
13
     * @return void
14
     */
15
    public function getRelationInstance($field)
16
    {
17
        $entity = $this->getOnlyRelationEntity($field);
0 ignored issues
show
Bug introduced by
It seems like getOnlyRelationEntity() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

17
        /** @scrutinizer ignore-call */ 
18
        $entity = $this->getOnlyRelationEntity($field);
Loading history...
18
        $entity_array = explode('.', $entity);
19
        $relation_model = $this->getRelationModel($entity);
0 ignored issues
show
Bug introduced by
The method getRelationModel() does not exist on Backpack\CRUD\app\Librar...el\Traits\Relationships. Did you maybe mean getRelationInstance()? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

19
        /** @scrutinizer ignore-call */ 
20
        $relation_model = $this->getRelationModel($entity);

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
20
21
        $related_method = Arr::last($entity_array);
22
        if (count(explode('.', $entity)) == count(explode('.', $field['entity']))) {
23
            $relation_model = $this->getRelationModel($entity, -1);
24
        }
25
        $relation_model = new $relation_model();
26
27
        //if counts are diferent means that last element of entity is the field in relation.
28
        if (count(explode('.', $entity)) != count(explode('.', $field['entity']))) {
29
            if (in_array($related_method, $relation_model->getFillable())) {
30
                if (count($entity_array) > 1) {
31
                    $related_method = $entity_array[(count($entity_array) - 2)];
32
                    $relation_model = $this->getRelationModel($entity, -2);
33
                } else {
34
                    $relation_model = $this->model;
35
                }
36
            }
37
        }
38
        if (count($entity_array) == 1) {
39
            if (method_exists($this->model, $related_method)) {
40
                return $this->model->{$related_method}();
41
            }
42
        }
43
44
        return $relation_model->{$related_method}();
45
    }
46
47
    /**
48
     * Get the fields with specific relation types.
49
     *
50
     * @param array|string $relation_types
51
     *
52
     * @return array The fields with corresponding relation types.
53
     */
54
    public function getFieldsWithRelationType($relation_types): array
55
    {
56
        $relation_types = is_array($relation_types) ?: (array) $relation_types;
57
58
        return collect($this->fields())
0 ignored issues
show
Bug introduced by
It seems like fields() must be provided by classes using this trait. How about adding it as abstract method to this trait? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

58
        return collect($this->/** @scrutinizer ignore-call */ fields())
Loading history...
59
            ->where('model')
60
            ->whereIn('relation_type', $relation_types)
61
            ->toArray();
62
    }
63
64
    /**
65
     * Grabs an relation instance and returns the class name of the related model.
66
     *
67
     * @param array $field
68
     * @return string
69
     */
70
    public function inferFieldModelFromRelationship($field)
71
    {
72
        $relation = $this->getRelationInstance($field);
0 ignored issues
show
Bug introduced by
Are you sure the assignment to $relation is correct as $this->getRelationInstance($field) targeting Backpack\CRUD\app\Librar...::getRelationInstance() seems to always return null.

This check looks for function or method calls that always return null and whose return value is assigned to a variable.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

The method getObject() can return nothing but null, so it makes no sense to assign that value to a variable.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
73
74
        return get_class($relation->getRelated());
75
    }
76
77
    /**
78
     * Return the relation type from a given field: BelongsTo, HasOne ... etc.
79
     *
80
     * @param array $field
81
     * @return string
82
     */
83
    public function inferRelationTypeFromRelationship($field)
84
    {
85
        $relation = $this->getRelationInstance($field);
0 ignored issues
show
Bug introduced by
Are you sure the assignment to $relation is correct as $this->getRelationInstance($field) targeting Backpack\CRUD\app\Librar...::getRelationInstance() seems to always return null.

This check looks for function or method calls that always return null and whose return value is assigned to a variable.

class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

The method getObject() can return nothing but null, so it makes no sense to assign that value to a variable.

The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes.

Loading history...
86
87
        return Arr::last(explode('\\', get_class($relation)));
0 ignored issues
show
Bug introduced by
$relation of type void is incompatible with the type object expected by parameter $object of get_class(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

87
        return Arr::last(explode('\\', get_class(/** @scrutinizer ignore-type */ $relation)));
Loading history...
88
    }
89
90
    /**
91
     * Parse the field name back to the related entity after the form is submited.
92
     * Its called in getAllFieldNames().
93
     *
94
     * @param array $fields
95
     * @return array
96
     */
97
    public function parseRelationFieldNamesFromHtml($fields)
98
    {
99
        foreach ($fields as &$field) {
100
            //we only want to parse fields that has a relation type and their name contains [ ] used in html.
101
            if (isset($field['relation_type']) && preg_match('/[\[\]]/', $field['name']) !== 0) {
102
                $chunks = explode('[', $field['name']);
103
104
                foreach ($chunks as &$chunk) {
105
                    if (strpos($chunk, ']')) {
106
                        $chunk = str_replace(']', '', $chunk);
107
                    }
108
                }
109
                $field['name'] = implode('.', $chunks);
110
            }
111
        }
112
113
        return $fields;
114
    }
115
116
    /**
117
     * Based on relation type returns the default field type.
118
     *
119
     * @param string $relation_type
120
     * @return bool
121
     */
122
    public function inferFieldTypeFromFieldRelation($field)
123
    {
124
        switch ($field['relation_type']) {
125
            case 'BelongsToMany':
126
            case 'HasMany':
127
            case 'HasManyThrough':
128
            case 'MorphMany':
129
            case 'MorphToMany':
130
            case 'BelongsTo':
131
                return 'relationship';
0 ignored issues
show
Bug Best Practice introduced by
The expression return 'relationship' returns the type string which is incompatible with the documented return type boolean.
Loading history...
132
133
            default:
134
                return 'text';
0 ignored issues
show
Bug Best Practice introduced by
The expression return 'text' returns the type string which is incompatible with the documented return type boolean.
Loading history...
135
        }
136
    }
137
138
    /**
139
     * Based on relation type returns if relation allows multiple entities.
140
     *
141
     * @param string $relation_type
142
     * @return bool
143
     */
144
    public function guessIfFieldHasMultipleFromRelationType($relation_type)
145
    {
146
        switch ($relation_type) {
147
            case 'BelongsToMany':
148
            case 'HasMany':
149
            case 'HasManyThrough':
150
            case 'HasOneOrMany':
151
            case 'MorphMany':
152
            case 'MorphOneOrMany':
153
            case 'MorphToMany':
154
                return true;
155
156
            default:
157
                return false;
158
        }
159
    }
160
161
    /**
162
     * Based on relation type returns if relation has a pivot table.
163
     *
164
     * @param string $relation_type
165
     * @return bool
166
     */
167
    public function guessIfFieldHasPivotFromRelationType($relation_type)
168
    {
169
        switch ($relation_type) {
170
            case 'BelongsToMany':
171
            case 'HasManyThrough':
172
            case 'MorphMany':
173
            case 'MorphOneOrMany':
174
            case 'MorphToMany':
175
                return true;
176
            default:
177
                return false;
178
        }
179
    }
180
}
181