Completed
Pull Request — master (#2905)
by
unknown
02:43
created

HasMany::render()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 17

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 0
dl 0
loc 17
rs 9.7
c 0
b 0
f 0
1
<?php
2
3
namespace Encore\Admin\Form\Field;
4
5
use Encore\Admin\Admin;
6
use Encore\Admin\Form;
7
use Encore\Admin\Form\Field;
8
use Encore\Admin\Form\NestedForm;
9
use Illuminate\Database\Eloquent\Relations\HasMany as Relation;
10
use Illuminate\Database\Eloquent\Relations\MorphMany;
11
use Illuminate\Support\Facades\Validator;
12
13
/**
14
 * Class HasMany.
15
 */
16
class HasMany extends Field
17
{
18
    /**
19
     * Relation name.
20
     *
21
     * @var string
22
     */
23
    protected $relationName = '';
24
25
    /**
26
     * Form builder.
27
     *
28
     * @var \Closure
29
     */
30
    protected $builder = null;
31
32
    /**
33
     * Form data.
34
     *
35
     * @var array
36
     */
37
    protected $value = [];
38
39
    /**
40
     * View Mode.
41
     *
42
     * Supports `default` and `tab` currently.
43
     *
44
     * @var string
45
     */
46
    protected $viewMode = 'default';
47
48
    /**
49
     * Available views for HasMany field.
50
     *
51
     * @var array
52
     */
53
    protected $views = [
54
        'default' => 'admin::form.hasmany',
55
        'tab' => 'admin::form.hasmanytab',
56
    ];
57
58
    /**
59
     * Options for template.
60
     *
61
     * @var array
62
     */
63
    protected $options = [
64
        'allowCreate' => true,
65
        'allowDelete' => true,
66
    ];
67
68
    /**
69
     * Create a new HasMany field instance.
70
     *
71
     * @param $relationName
72
     * @param array $arguments
73
     */
74 View Code Duplication
    public function __construct($relationName, $arguments = [])
0 ignored issues
show
Duplication introduced by
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...
75
    {
76
        $this->relationName = $relationName;
77
78
        $this->column = $relationName;
79
80
        if (count($arguments) == 1) {
81
            $this->label = $this->formatLabel();
82
            $this->builder = $arguments[0];
83
        }
84
85
        if (count($arguments) == 2) {
86
            list($this->label, $this->builder) = $arguments;
87
        }
88
    }
89
90
    /**
91
     * Get validator for this field.
92
     *
93
     * @param array $input
94
     *
95
     * @return bool|Validator
96
     */
97
    public function getValidator(array $input)
98
    {
99
        if (!array_key_exists($this->column, $input)) {
100
            return false;
101
        }
102
103 View Code Duplication
        $array_key_attach_str = function (array $a, string $b, string $c = '.') {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
104
            return call_user_func_array(
105
                'array_merge',
106
                array_map(function ($u, $v) use ($b, $c) {
107
                    return ["{$b}{$c}{$u}" => $v];
108
                }, array_keys($a), array_values($a))
109
            );
110
        };
111
112 View Code Duplication
        $array_key_clean = function (array $a) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
113
            $a = count($a) ? call_user_func_array('array_merge', array_map(function ($k, $v) {
114
                return [str_replace(':', '', $k) => $v];
115
            }, array_keys($a), array_values($a))) : $a;
116
117
            return $a;
118
        };
119
120
        $array_clean_merge = function (array $a, $b) {
121
            return array_merge($a, call_user_func_array('array_merge', $b));
122
        };
123
124 View Code Duplication
        $array_key_clean_undot = function (array $a) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
125
            $keys = preg_grep('/[\.\:]/', array_keys($a));
126
            if ($keys) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $keys of type string[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
127
                foreach ($keys as $key) {
128
                    array_set($a, str_replace(':', '', $key), $a[$key]);
129
                    unset($a[$key]);
130
                }
131
            }
132
133
            return $a;
134
        };
135
        $old = $input;
0 ignored issues
show
Unused Code introduced by
$old is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
136
        $input = array_only($input, $this->column);
137
        $form = $this->buildNestedForm($this->column, $this->builder);
0 ignored issues
show
Bug introduced by
It seems like $this->column can also be of type array; however, Encore\Admin\Form\Field\HasMany::buildNestedForm() does only seem to accept string, 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...
138
        $rel = $this->relationName;
139
        $rules = $attributes = $messages = $newInputs = [];
140
        // remove all inputs & keys marked as removed
141
        $availInput = array_filter(array_map(function ($v) {
142
            return $v[NestedForm::REMOVE_FLAG_NAME] ? null : $v;
143
        }, $input[$rel]));
144
        $keys = array_keys($availInput);
145
        /* @var Field $field */
146
        foreach ($form->fields() as $field) {
147
            if ($field instanceof Field\HasMany) {
148
                throw new \Exception('hasMany field CAN NOT build within a HasMany field.');
149
            }
150
            if (!($field instanceof Field\Embeds) && !($fieldRules = $field->getRules())) {
151
                continue;
152
            }
153
            $column = $field->column();
154
            $columns = is_array($column) ? $column : [$column];
155 View Code Duplication
            if ($field instanceof Field\MultipleSelect || $field instanceof Field\Listbox) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
156
                foreach ($keys as $key) {
157
                    $availInput[$key][$column] = array_filter($availInput[$key][$column], 'strlen') ? : null;
158
                }
159
            }
160
161
            $newColumn = call_user_func_array('array_merge', array_map(function ($u) use ($columns, $rel) {
162
                return array_map(function ($k, $v) use ($u, $rel) {
163
                    //Fix ResetInput Function! A Headache Implementation!
164
                    return $k ? "{$rel}.{$u}.{$v}:{$k}" : "{$rel}.{$u}.{$v}";
165
                }, array_keys($columns), array_values($columns));
166
            }, $keys));
167
168
            if ($field instanceof Field\Embeds) {
169
                // dd($field->column(), $input, $old, $availInput);
170 View Code Duplication
                $newRules = array_map(function ($v) use ($availInput, $field, $array_key_attach_str) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
171
                    list($r, $k, $c) = explode('.', $v);
172
                    $v = "{$r}.{$k}";
173
                    $embed = $field->getValidationRules([$field->column() => $availInput[$k][$c]]);
174
                    // $embed = $embed ? call_user_func_array(
175
                    //     'array_merge',
176
                    //     array_map(function ($x, $y) {
177
                    //         return [str_replace('.', ':', $x) => $y];
178
                    //     }, array_keys($embed), $embed)
179
                    // ) : $embed;
180
                    return $embed ? $array_key_attach_str($embed, $v) : null;
181
                }, $newColumn);
182
                $rules = $array_clean_merge($rules, array_filter($newRules));
183
184 View Code Duplication
                $newAttributes = array_map(function ($v) use ($availInput, $field, $array_key_attach_str) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
185
                    list($r, $k, $c) = explode('.', $v);
186
                    $v = "{$r}.{$k}";
187
                    $embed = $field->getValidationAttributes([$field->column() => $availInput[$k][$c]]);
188
                    // $embed = $embed ? call_user_func_array(
189
                    //     'array_merge',
190
                    //     array_map(function ($x, $y) {
191
                    //         return [str_replace('.', ':', $x) => $y];
192
                    //     }, array_keys($embed), $embed)
193
                    // ) : $embed;
194
                    return $embed ? $array_key_attach_str($embed, $v) : null;
195
                }, $newColumn);
196
                $attributes = $array_clean_merge($attributes, array_filter($newAttributes));
197
198 View Code Duplication
                $newInput = array_map(function ($v) use ($availInput, $field, $array_key_attach_str) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
199
                    list($r, $k, $c) = explode('.', $v);
200
                    $v = "{$r}.{$k}";
201
                    $embed = $field->getValidationInput([$field->column() => $availInput[$k][$c]]);
202
                    // $embed = $embed ? call_user_func_array(
203
                    //     'array_merge',
204
                    //     array_map(function ($x, $y) {
205
                    //         return [str_replace('.', ':', $x) => $y];
206
                    //     }, array_keys($embed), $embed)
207
                    // ) : $embed;
208
                    return $embed ? $array_key_attach_str($embed, $v) : [null => 'null'];
209
                }, $newColumn);
210
                $newInputs = $array_clean_merge($newInputs, array_filter($newInput, 'strlen', ARRAY_FILTER_USE_KEY));
211
212 View Code Duplication
                $newMessages = array_map(function ($v) use ($availInput, $field, $array_key_attach_str) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
213
                    list($r, $k, $c) = explode('.', $v);
214
                    $v = "{$r}.{$k}";
215
                    $embed = $field->getValidationMessages([$field->column() => $availInput[$k][$c]]);
216
                    // $embed = $embed ? call_user_func_array(
217
                    //     'array_merge',
218
                    //     array_map(function ($x, $y) {
219
                    //         $x = explode('.', $x);
220
                    //         $x = implode('', array_slice($x, 0, -1)) . '.' . end($x);
221
                    //         return [$x => $y];
222
                    //     }, array_keys($embed), $embed)
223
                    // ) : $embed;
224
                    return $embed ? $array_key_attach_str($embed, $v) : null;
225
                }, $newColumn);
226
                $messages = $array_clean_merge($messages, array_filter($newMessages));
227
               // dd($rules, $attributes, $messages, $newInputs);
228
            } else {
229
                $fieldRules = is_array($fieldRules) ? implode('|', $fieldRules) : $fieldRules;
0 ignored issues
show
Bug introduced by
The variable $fieldRules does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
230 View Code Duplication
                $newRules = array_map(function ($v) use ($fieldRules, $availInput, $array_key_attach_str) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
231
                    list($r, $k, $c) = explode('.', $v);
0 ignored issues
show
Unused Code introduced by
The assignment to $r is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
232
                    //Fix ResetInput Function! A Headache Implementation!
233
                    $col = explode(':', $c)[0];
234
                    if (array_key_exists($col, $availInput[$k]) && is_array($availInput[$k][$col])) {
235
                        return $array_key_attach_str(preg_replace('/.+/', $fieldRules, $availInput[$k][$col]), $v, ':');
236
                    }
237
    
238
                    //May Have Problem in Dealing with File Upload in Edit Mode
239
                    return [$v => $fieldRules];
240
                }, $newColumn);
241
                $rules = $array_clean_merge($rules, $newRules);
242
243 View Code Duplication
                $newInput = array_map(function ($v) use ($availInput, $array_key_attach_str) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
244
                    list($r, $k, $c) = explode('.', $v);
0 ignored issues
show
Unused Code introduced by
The assignment to $r is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
245
                    //Fix ResetInput Function! A Headache Implementation!
246
                    $col = explode(':', $c)[0];
247
                    if (!array_key_exists($col, $availInput[$k])) {
248
                        //May Have Problem in Dealing with File Upload in Edit Mode
249
                        return [$v => null];
250
                    }
251
252
                    if (is_array($availInput[$k][$col])) {
253
                        return $array_key_attach_str($availInput[$k][$col], $v, ':');
254
                    }
255
256
                    return [$v => $availInput[$k][$col]];
257
                }, $newColumn);
258
                $newInputs = $array_clean_merge($newInputs, $newInput);
259
260 View Code Duplication
                $newAttributes = array_map(function ($v) use ($field, $availInput) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
261
                    list($r, $k, $c) = explode('.', $v);
0 ignored issues
show
Unused Code introduced by
The assignment to $r is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
262
                    //Fix ResetInput Function! A Headache Implementation!
263
                    $col = explode(':', $c)[0];
264
                    if (array_key_exists($col, $availInput[$k]) && is_array($availInput[$k][$col])) {
265
                        return call_user_func_array('array_merge', array_map(function ($u) use ($v, $field) {
266
                            $w = $field->label();
267
                            //Fix ResetInput Function! A Headache Implementation!
268
                            $w .= is_array($field->column()) ? '[' . explode(':', explode('.', $v)[2])[0] . ']' : '';
269
270
                            return ["{$v}:{$u}" => $w];
271
                        }, array_keys($availInput[$k][$col])));
272
                    }
273
    
274
                    //May Have Problem in Dealing with File Upload in Edit Mode
275
                    $w = $field->label();
276
                    //Fix ResetInput Function! A Headache Implementation!
277
                    $w .= is_array($field->column()) ? '[' . explode(':', explode('.', $v)[2])[0] . ']' : '';
278
279
                    return [$v => $w];
280
                }, $newColumn);
281
                $attributes = $array_clean_merge($attributes, $newAttributes);
282
            }
283
284
285 View Code Duplication
            if ($field->validationMessages) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
286
                $newMessages = array_map(function ($v) use ($field, $availInput, $array_key_attach_str) {
287
                    list($r, $k, $c) = explode('.', $v);
0 ignored issues
show
Unused Code introduced by
The assignment to $r is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
288
                    //Fix ResetInput Function! A Headache Implementation!
289
                    $col = explode(':', $c)[0];
290
                    if (array_key_exists($col, $availInput[$k]) && is_array($availInput[$k][$col])) {
291
                        return call_user_func_array('array_merge', array_map(function ($u) use ($v, $field, $array_key_attach_str) {
292
                            return $array_key_attach_str($field->validationMessages, "{$v}:{$u}");
293
                        }, array_keys($availInput[$k][$col])));
294
                    }
295
296
                    //May Have Problem in Dealing with File Upload in Edit Mode
297
                    return $array_key_attach_str($field->validationMessages, $v);
298
                }, $newColumn);
299
                $messages = $array_clean_merge($messages, $newMessages);
300
            }
301
        }
302
303
        $rules = array_filter($rules, 'strlen');
304
        if (empty($rules)) {
305
            return false;
306
        }
307
308
        $input = $array_key_clean_undot(array_filter($newInputs, 'strlen', ARRAY_FILTER_USE_KEY));
309
        $rules = $array_key_clean($rules);
310
        $attributes = $array_key_clean($attributes);
311
        $messages = $array_key_clean($messages);
312
313
        if (empty($input)) {
314
            $input = [$rel => $availInput];
315
        }
316
317
        // if ($rel == 'files') {
318
        //     dd(request()->all(), $input, $rules, $messages, $attributes, Validator::make($input, $rules, $messages, $attributes)->messages());
319
        // }
320
        return Validator::make($input, $rules, $messages, $attributes);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return \Illuminate\Suppo...messages, $attributes); (Illuminate\Contracts\Validation\Validator) is incompatible with the return type of the parent method Encore\Admin\Form\Field::getValidator of type boolean|Illuminate\Support\Facades\Validator.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
321
    }
322
323
    /**
324
     * Prepare input data for insert or update.
325
     *
326
     * @param array $input
327
     *
328
     * @return array
329
     */
330
    public function prepare($input)
331
    {
332
        $form = $this->buildNestedForm($this->column, $this->builder);
0 ignored issues
show
Bug introduced by
It seems like $this->column can also be of type array; however, Encore\Admin\Form\Field\HasMany::buildNestedForm() does only seem to accept string, 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...
333
334
        return $form->setOriginal($this->original, $this->getKeyName())->prepare($input);
335
    }
336
337
    /**
338
     * Build a Nested form.
339
     *
340
     * @param string   $column
341
     * @param \Closure $builder
342
     * @param null     $key
343
     *
344
     * @return NestedForm
345
     */
346
    protected function buildNestedForm($column, \Closure $builder, $key = null)
347
    {
348
        $form = new Form\NestedForm($column, $key);
349
350
        $form->setForm($this->form);
351
352
        call_user_func($builder, $form);
353
354
        $form->hidden($this->getKeyName());
355
356
        $form->hidden(NestedForm::REMOVE_FLAG_NAME)->default(0)->addElementClass(NestedForm::REMOVE_FLAG_CLASS);
357
358
        return $form;
359
    }
360
361
    /**
362
     * Get the HasMany relation key name.
363
     *
364
     * @return string
365
     */
366
    protected function getKeyName()
367
    {
368
        if (is_null($this->form)) {
369
            return;
370
        }
371
372
        return $this->form->model()->{$this->relationName}()->getRelated()->getKeyName();
373
    }
374
375
    /**
376
     * Set view mode.
377
     *
378
     * @param string $mode currently support `tab` mode.
379
     *
380
     * @return $this
381
     *
382
     * @author Edwin Hui
383
     */
384
    public function mode($mode)
385
    {
386
        $this->viewMode = $mode;
387
388
        return $this;
389
    }
390
391
    /**
392
     * Use tab mode to showing hasmany field.
393
     *
394
     * @return HasMany
395
     */
396
    public function useTab()
397
    {
398
        return $this->mode('tab');
399
    }
400
401
    /**
402
     * Build Nested form for related data.
403
     *
404
     * @throws \Exception
405
     *
406
     * @return array
407
     */
408
    protected function buildRelatedForms()
409
    {
410
        if (is_null($this->form)) {
411
            return [];
412
        }
413
414
        $model = $this->form->model();
415
416
        $relation = call_user_func([$model, $this->relationName]);
417
418
        if (!$relation instanceof Relation && !$relation instanceof MorphMany) {
419
            throw new \Exception('hasMany field must be a HasMany or MorphMany relation.');
420
        }
421
422
        $forms = [];
423
424
        /*
425
         * If redirect from `exception` or `validation error` page.
426
         *
427
         * Then get form data from session flash.
428
         *
429
         * Else get data from database.
430
         */
431
        if ($values = old($this->column)) {
0 ignored issues
show
Bug introduced by
It seems like $this->column can also be of type array; however, old() does only seem to accept string|null, 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...
432
            foreach ($values as $key => $data) {
433
                if ($data[NestedForm::REMOVE_FLAG_NAME] == 1) {
434
                    continue;
435
                }
436
                // dd($this->value, $values, $key, $data);
437
438
                $forms[$key] = $this->buildNestedForm($this->column, $this->builder, $key)
0 ignored issues
show
Bug introduced by
It seems like $this->column can also be of type array; however, Encore\Admin\Form\Field\HasMany::buildNestedForm() does only seem to accept string, 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...
439
                    ->fill($data);
440
            }
441
        } else {
442
            foreach ($this->value as $data) {
443
                $key = array_get($data, $relation->getRelated()->getKeyName());
444
445
                $forms[$key] = $this->buildNestedForm($this->column, $this->builder, $key)
0 ignored issues
show
Bug introduced by
It seems like $this->column can also be of type array; however, Encore\Admin\Form\Field\HasMany::buildNestedForm() does only seem to accept string, 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...
446
                    ->fill($data);
447
            }
448
        }
449
450
        return $forms;
451
    }
452
453
    /**
454
     * Setup script for this field in different view mode.
455
     *
456
     * @param string $script
457
     *
458
     * @return void
459
     */
460
    protected function setupScript($script)
461
    {
462
        $method = 'setupScriptFor' . ucfirst($this->viewMode) . 'View';
463
464
        call_user_func([$this, $method], $script);
465
    }
466
467
    /**
468
     * Setup default template script.
469
     *
470
     * @param string $templateScript
471
     *
472
     * @return void
473
     */
474 View Code Duplication
    protected function setupScriptForDefaultView($templateScript)
0 ignored issues
show
Duplication introduced by
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...
475
    {
476
        $removeClass = NestedForm::REMOVE_FLAG_CLASS;
477
        $defaultKey = NestedForm::DEFAULT_KEY_NAME;
478
479
        /**
480
         * When add a new sub form, replace all element key in new sub form.
481
         *
482
         * @example comments[new___key__][title]  => comments[new_{index}][title]
483
         *
484
         * {count} is increment number of current sub form count.
485
         */
486
        $script = <<<EOT
487
var index = 0;
488
$('#has-many-{$this->column}').on('click', '.add', function() {
489
490
    var tpl = $('template.{$this->column}-tpl');
491
492
    index++;
493
494
    var template = tpl.html().replace(/{$defaultKey}/g, index);
495
    $('.has-many-{$this->column}-forms').append(template);
496
    {$templateScript}
497
});
498
499
$('#has-many-{$this->column}').on('click', '.remove', function() {
500
    $(this).closest('.has-many-{$this->column}-form').hide();
501
    $(this).closest('.has-many-{$this->column}-form').find('.$removeClass').val(1);
502
});
503
504
EOT;
505
506
        Admin::script($script);
507
    }
508
509
    /**
510
     * Setup tab template script.
511
     *
512
     * @param string $templateScript
513
     *
514
     * @return void
515
     */
516 View Code Duplication
    protected function setupScriptForTabView($templateScript)
0 ignored issues
show
Duplication introduced by
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...
517
    {
518
        $removeClass = NestedForm::REMOVE_FLAG_CLASS;
519
        $defaultKey = NestedForm::DEFAULT_KEY_NAME;
520
521
        $script = <<<EOT
522
523
$('#has-many-{$this->column} > .nav').off('click', 'i.close-tab').on('click', 'i.close-tab', function(){
524
    var \$navTab = $(this).siblings('a');
525
    var \$pane = $(\$navTab.attr('href'));
526
    if( \$pane.hasClass('new') ){
527
        \$pane.remove();
528
    }else{
529
        \$pane.removeClass('active').find('.$removeClass').val(1);
530
    }
531
    if(\$navTab.closest('li').hasClass('active')){
532
        \$navTab.closest('li').remove();
533
        $('#has-many-{$this->column} > .nav > li:nth-child(1) > a').tab('show');
534
    }else{
535
        \$navTab.closest('li').remove();
536
    }
537
});
538
539
var index = 0;
540
$('#has-many-{$this->column} > .header').off('click', '.add').on('click', '.add', function(){
541
    index++;
542
    var navTabHtml = $('#has-many-{$this->column} > template.nav-tab-tpl').html().replace(/{$defaultKey}/g, index);
543
    var paneHtml = $('#has-many-{$this->column} > template.pane-tpl').html().replace(/{$defaultKey}/g, index);
544
    $('#has-many-{$this->column} > .nav').append(navTabHtml);
545
    $('#has-many-{$this->column} > .tab-content').append(paneHtml);
546
    $('#has-many-{$this->column} > .nav > li:last-child a').tab('show');
547
    {$templateScript}
548
});
549
550
if ($('.has-error').length) {
551
    $('.has-error').parent('.tab-pane').each(function() {
552
        var tabId = '#'+$(this).attr('id');
553
        $('li a[href="'+tabId+'"] i').removeClass('hide');
554
    });
555
    
556
    var first = $('.has-error:first').parent().attr('id');
557
    $('li a[href="#'+first+'"]').tab('show');
558
}
559
EOT;
560
561
        Admin::script($script);
562
    }
563
564
    /**
565
     * Disable create button.
566
     *
567
     * @return $this
568
     */
569
    public function disableCreate()
570
    {
571
        $this->options['allowCreate'] = false;
572
573
        return $this;
574
    }
575
576
    /**
577
     * Disable delete button.
578
     *
579
     * @return $this
580
     */
581
    public function disableDelete()
582
    {
583
        $this->options['allowDelete'] = false;
584
585
        return $this;
586
    }
587
588
    /**
589
     * Render the `HasMany` field.
590
     *
591
     * @throws \Exception
592
     *
593
     * @return \Illuminate\View\View
594
     */
595
    public function render()
596
    {
597
        // specify a view to render.
598
        $this->view = $this->views[$this->viewMode];
599
600
        list($template, $script) = $this->buildNestedForm($this->column, $this->builder)
0 ignored issues
show
Bug introduced by
It seems like $this->column can also be of type array; however, Encore\Admin\Form\Field\HasMany::buildNestedForm() does only seem to accept string, 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...
601
            ->getTemplateHtmlAndScript();
602
603
        $this->setupScript($script);
604
605
        return parent::render()->with([
0 ignored issues
show
Bug introduced by
The method with does only exist in Illuminate\View\View, but not in Illuminate\Contracts\View\Factory.

It seems like the method you are trying to call exists only in some of the possible types.

Let’s take a look at an example:

class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

Available Fixes

  1. Add an additional type-check:

    /**
     * @param A|B $x
     */
    function someFunction($x)
    {
        $x->foo();
    
        if ($x instanceof B) {
            $x->bar();
        }
    }
    
  2. Only allow a single type to be passed if the variable comes from a parameter:

    function someFunction(B $x) { /** ... */ }
    
Loading history...
606
            'forms' => $this->buildRelatedForms(),
607
            'template' => $template,
608
            'relationName' => $this->relationName,
609
            'options' => $this->options,
610
        ]);
611
    }
612
}
613