Completed
Pull Request — master (#2901)
by
unknown
03:42 queued 01:24
created

HasMany::__construct()   A

Complexity

Conditions 3
Paths 4

Size

Total Lines 15

Duplication

Lines 15
Ratio 100 %

Importance

Changes 0
Metric Value
cc 3
nc 4
nop 2
dl 15
loc 15
rs 9.7666
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
use Illuminate\Support\Str;
13
14
/**
15
 * Class HasMany.
16
 */
17
class HasMany extends Field
18
{
19
    /**
20
     * Relation name.
21
     *
22
     * @var string
23
     */
24
    protected $relationName = '';
25
26
    /**
27
     * Form builder.
28
     *
29
     * @var \Closure
30
     */
31
    protected $builder = null;
32
33
    /**
34
     * Form data.
35
     *
36
     * @var array
37
     */
38
    protected $value = [];
39
40
    /**
41
     * View Mode.
42
     *
43
     * Supports `default` and `tab` currently.
44
     *
45
     * @var string
46
     */
47
    protected $viewMode = 'default';
48
49
    /**
50
     * Available views for HasMany field.
51
     *
52
     * @var array
53
     */
54
    protected $views = [
55
        'default'  => 'admin::form.hasmany',
56
        'tab'      => 'admin::form.hasmanytab',
57
    ];
58
59
    /**
60
     * Options for template.
61
     *
62
     * @var array
63
     */
64
    protected $options = [
65
        'allowCreate' => true,
66
        'allowDelete' => true,
67
    ];
68
69
    /**
70
     * Create a new HasMany field instance.
71
     *
72
     * @param $relationName
73
     * @param array $arguments
74
     */
75 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...
76
    {
77
        $this->relationName = $relationName;
78
79
        $this->column = $relationName;
80
81
        if (count($arguments) == 1) {
82
            $this->label = $this->formatLabel();
83
            $this->builder = $arguments[0];
84
        }
85
86
        if (count($arguments) == 2) {
87
            list($this->label, $this->builder) = $arguments;
88
        }
89
    }
90
91
    /**
92
     * Get validator for this field.
93
     *
94
     * @param array $input
95
     *
96
     * @return bool|Validator
97
     */
98
    public function getValidator(array $input)
99
    {
100
        if (!array_key_exists($this->column, $input)) {
101
            return false;
102
        }
103
104 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...
105
            return call_user_func_array(
106
                'array_merge',
107
                array_map(function ($u, $v) use ($b, $c) {
108
                    return ["{$b}{$c}{$u}" => $v];
109
                }, array_keys($a), array_values($a))
110
            );
111
        };
112
113 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...
114
            $a = count($a) ? call_user_func_array('array_merge', array_map(function ($k, $v) {
115
                return [str_replace(':', '', $k) => $v];
116
            }, array_keys($a), array_values($a))) : $a;
117
118
            return $a;
119
        };
120
121 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...
122
            $keys = preg_grep('/[\.\:]/', array_keys($a));
123
            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...
124
                foreach ($keys as $key) {
125
                    array_set($a, str_replace(':', '', $key), $a[$key]);
126
                    unset($a[$key]);
127
                }
128
            }
129
130
            return $a;
131
        };
132
133
        $input = array_only($input, $this->column);
134
        $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...
135
        $rel = $this->relationName;
136
        $rules = $attributes = [];
137
        $messages = [];
138
        // remove all inputs & keys marked as removed
139
        $availInput = array_filter(array_map(function ($v) {
140
            return $v[NestedForm::REMOVE_FLAG_NAME] ? null : $v;
141
        }, $input[$rel]));
142
        $keys = array_keys($availInput);
143
        /* @var Field $field */
144
        foreach ($form->fields() as $field) {
145
            if (!$fieldRules = $field->getRules()) {
146
                continue;
147
            }
148
            $column = $field->column();
149
            $columns = is_array($column) ? $column : [$column];
150
            if ($field instanceof Field\MultipleSelect) {
151
                foreach ($keys as $key) {
152
                    $availInput[$key][$column] = array_filter($availInput[$key][$column], 'strlen');
153
                    $availInput[$key][$column] = $availInput[$key][$column] ?: null;
154
                }
155
            }
156
            // if($field instanceof Field\File)
157
            // {
158
            //     dd(request());
159
            // }
160
            $newColumn = call_user_func_array('array_merge', array_map(function ($u) use ($columns, $rel) {
161
                return array_map(function ($k, $v) use ($u, $rel) {
162
                    //Fix ResetInput Function! A Headache Implementation!
163
                    return !$k ? "{$rel}.{$u}.{$v}" : "{$rel}.{$u}.{$v}:{$k}";
164
                }, array_keys($columns), array_values($columns));
165
            }, $keys));
166
167
            $fieldRules = is_array($fieldRules) ? implode('|', $fieldRules) : $fieldRules;
168
            $rules = array_merge($rules, call_user_func_array(
169
                'array_merge',
170
                array_map(function ($v) use ($fieldRules) {
171
                    return [$v => $fieldRules];
172
                }, $newColumn)
173
            ));
174
            $attributes = array_merge($attributes, call_user_func_array(
175
                'array_merge',
176 View Code Duplication
                array_map(function ($v) use ($field) {
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...
177
                    //Fix ResetInput Function! A Headache Implementation!
178
                    $u = $field->label();
179
                    $u .= is_array($field->column()) ? '['.explode(':', explode('.', $v)[1])[0].']' : '';
180
181
                    return [$v => "{$u}"];
182
                }, $newColumn)
183
            ));
184 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...
185
                $newMessages = array_map(function ($v) use ($field, $availInput, $array_key_attach_str) {
186
                    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...
187
                    //Fix ResetInput Function! A Headache Implementation!
188
                    $col1 = explode(':', $c)[0];
189
                    if (!array_key_exists($col1, $availInput[$k])) {
190
                        return [null => null];
191
                    }
192
                    $rows = $availInput[$k][$col1];
193
                    if (!is_array($rows)) {
194
                        return $array_key_attach_str($field->validationMessages, $v);
195
                    }
196
                    $r = [];
197
                    foreach (array_keys($rows) as $k) {
198
                        $k = "{$v}{$k}";
199
                        $r = array_merge($r, $array_key_attach_str($field->validationMessages, $k));
200
                    }
201
202
                    return $r;
203
                }, $newColumn);
204
                $newMessages = call_user_func_array('array_merge', $newMessages);
205
                $messages = array_merge($messages, $newMessages);
206
            }
207
        }
208
209
        if (empty($rules)) {
210
            return false;
211
        }
212
213
        $newInput = call_user_func_array('array_merge', array_map(function ($u) use ($availInput) {
214
            list($rel, $key, $col) = explode('.', $u);
215
            $idx = "{$rel}.{$key}.{$col}";
216
            //Fix ResetInput Function! A Headache Implementation!
217
            $col1 = explode(':', $col)[0];
218
            if (!array_key_exists($col1, $availInput[$key])) {
219
                return [null => null];
220
            }
221
            if (is_array($availInput[$key][$col1])) {
222
                return call_user_func_array('array_merge', array_map(function ($x, $y) use ($idx) {
223
                    return ["{$idx}{$x}" => $y];
224
                }, array_keys($availInput[$key][$col1]), $availInput[$key][$col1]));
225
            }
226
227
            return ["{$idx}" => $availInput[$key][$col1]];
228
        }, array_keys($rules)));
229
        $newInput = $array_key_clean_undot($newInput);
230
231
        $newRules = array_map(function ($u) use ($availInput, $rules) {
232
            list($rel, $key, $col) = explode('.', $u);
233
            $idx = "{$rel}.{$key}.{$col}";
234
            //Fix ResetInput Function! A Headache Implementation!
235
            $col1 = explode(':', $col)[0];
236
            if (!array_key_exists($col1, $availInput[$key])) {
237
                return [null => null];
238
            }
239
            if (is_array($availInput[$key][$col1])) {
240
                return call_user_func_array('array_merge', array_map(function ($x) use ($idx, $rules) {
241
                    return ["{$idx}{$x}" => $rules[$idx]];
242
                }, array_keys($availInput[$key][$col1])));
243
            }
244
245
            return ["{$idx}" => $rules[$idx]];
246
        }, array_keys($rules));
247
        $newRules = array_filter(call_user_func_array('array_merge', $newRules), 'strlen', ARRAY_FILTER_USE_KEY);
248
        $newRules = $array_key_clean($newRules);
249
250
        $newAttributes = array_map(function ($u) use ($availInput, $attributes) {
251
            list($rel, $key, $col) = explode('.', $u);
252
            $idx = "{$rel}.{$key}.{$col}";
253
            //Fix ResetInput Function! A Headache Implementation!
254
            $col1 = explode(':', $col)[0];
255
            if (!array_key_exists($col1, $availInput[$key])) {
256
                return [null => null];
257
            }
258 View Code Duplication
            if (is_array($availInput[$key][$col1])) {
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...
259
                if (array_keys($availInput[$key][$col1])) {
260
                    return call_user_func_array('array_merge', array_map(function ($x) use ($idx, $attributes) {
261
                        return ["{$idx}.{$x}" => $attributes[$idx]];
262
                    }, array_keys($availInput[$key][$col1])));
263
                }
264
265
                return [null => null];
266
            }
267
268
            return ["{$idx}" => $attributes[$idx]];
269
        }, array_keys($attributes));
270
        $newAttributes = array_filter(call_user_func_array('array_merge', $newAttributes), 'strlen');
271
        $newAttributes = $array_key_clean($newAttributes);
272
273
        $messages = $array_key_clean($messages);
274
275
        if (empty($newInput)) {
276
            $newInput = [$rel => $availInput];
277
        }
278
279
        return Validator::make($newInput, $newRules, $messages, $newAttributes);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return \Illuminate\Suppo...sages, $newAttributes); (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...
280
    }
281
282
    /**
283
     * Format validation attributes.
284
     *
285
     * @param array  $input
286
     * @param string $label
287
     * @param string $column
288
     *
289
     * @return array
290
     */
291 View Code Duplication
    protected function formatValidationAttribute($input, $label, $column)
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...
292
    {
293
        $new = $attributes = [];
294
295
        if (is_array($column)) {
296
            foreach ($column as $index => $col) {
297
                $new[$col.$index] = $col;
298
            }
299
        }
300
301
        foreach (array_keys(array_dot($input)) as $key) {
302
            if (is_string($column)) {
303
                if (Str::endsWith($key, ".$column")) {
304
                    $attributes[$key] = $label;
305
                }
306
            } else {
307
                foreach ($new as $k => $val) {
308
                    if (Str::endsWith($key, ".$k")) {
309
                        $attributes[$key] = $label."[$val]";
310
                    }
311
                }
312
            }
313
        }
314
315
        return $attributes;
316
    }
317
318
    /**
319
     * Reset input key for validation.
320
     *
321
     * @param array $input
322
     * @param array $column $column is the column name array set
323
     *
324
     * @return void.
0 ignored issues
show
Documentation introduced by
The doc-type void. could not be parsed: Unknown type name "void." at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
325
     */
326
    protected function resetInputKey(array &$input, array $column)
327
    {
328
        /**
329
         * flip the column name array set.
330
         *
331
         * for example, for the DateRange, the column like as below
332
         *
333
         * ["start" => "created_at", "end" => "updated_at"]
334
         *
335
         * to:
336
         *
337
         * [ "created_at" => "start", "updated_at" => "end" ]
338
         */
339
        $column = array_flip($column);
340
341
        /**
342
         * $this->column is the inputs array's node name, default is the relation name.
343
         *
344
         * So... $input[$this->column] is the data of this column's inputs data
345
         *
346
         * in the HasMany relation, has many data/field set, $set is field set in the below
347
         */
348
        foreach ($input[$this->column] as $index => $set) {
349
            /*
350
             * foreach the field set to find the corresponding $column
351
             */
352 View Code Duplication
            foreach ($set as $name => $value) {
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...
353
                /*
354
                 * if doesn't have column name, continue to the next loop
355
                 */
356
                if (!array_key_exists($name, $column)) {
357
                    continue;
358
                }
359
360
                /**
361
                 * example:  $newKey = created_atstart.
362
                 *
363
                 * Σ( ° △ °|||)︴
364
                 *
365
                 * I don't know why a form need range input? Only can imagine is for range search....
366
                 */
367
                $newKey = $name.$column[$name];
368
369
                /*
370
                 * set new key
371
                 */
372
                array_set($input, "{$this->column}.$index.$newKey", $value);
373
                /*
374
                 * forget the old key and value
375
                 */
376
                array_forget($input, "{$this->column}.$index.$name");
377
            }
378
        }
379
    }
380
381
    /**
382
     * Prepare input data for insert or update.
383
     *
384
     * @param array $input
385
     *
386
     * @return array
387
     */
388
    public function prepare($input)
389
    {
390
        $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...
391
392
        return $form->setOriginal($this->original, $this->getKeyName())->prepare($input);
393
    }
394
395
    /**
396
     * Build a Nested form.
397
     *
398
     * @param string   $column
399
     * @param \Closure $builder
400
     * @param null     $key
401
     *
402
     * @return NestedForm
403
     */
404
    protected function buildNestedForm($column, \Closure $builder, $key = null)
405
    {
406
        $form = new Form\NestedForm($column, $key);
407
408
        $form->setForm($this->form);
409
410
        call_user_func($builder, $form);
411
412
        $form->hidden($this->getKeyName());
413
414
        $form->hidden(NestedForm::REMOVE_FLAG_NAME)->default(0)->addElementClass(NestedForm::REMOVE_FLAG_CLASS);
415
416
        return $form;
417
    }
418
419
    /**
420
     * Get the HasMany relation key name.
421
     *
422
     * @return string
423
     */
424
    protected function getKeyName()
425
    {
426
        if (is_null($this->form)) {
427
            return;
428
        }
429
430
        return $this->form->model()->{$this->relationName}()->getRelated()->getKeyName();
431
    }
432
433
    /**
434
     * Set view mode.
435
     *
436
     * @param string $mode currently support `tab` mode.
437
     *
438
     * @return $this
439
     *
440
     * @author Edwin Hui
441
     */
442
    public function mode($mode)
443
    {
444
        $this->viewMode = $mode;
445
446
        return $this;
447
    }
448
449
    /**
450
     * Use tab mode to showing hasmany field.
451
     *
452
     * @return HasMany
453
     */
454
    public function useTab()
455
    {
456
        return $this->mode('tab');
457
    }
458
459
    /**
460
     * Build Nested form for related data.
461
     *
462
     * @throws \Exception
463
     *
464
     * @return array
465
     */
466
    protected function buildRelatedForms()
467
    {
468
        if (is_null($this->form)) {
469
            return [];
470
        }
471
472
        $model = $this->form->model();
473
474
        $relation = call_user_func([$model, $this->relationName]);
475
476
        if (!$relation instanceof Relation && !$relation instanceof MorphMany) {
477
            throw new \Exception('hasMany field must be a HasMany or MorphMany relation.');
478
        }
479
480
        $forms = [];
481
482
        /*
483
         * If redirect from `exception` or `validation error` page.
484
         *
485
         * Then get form data from session flash.
486
         *
487
         * Else get data from database.
488
         */
489
        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...
490
            foreach ($values as $key => $data) {
491
                if ($data[NestedForm::REMOVE_FLAG_NAME] == 1) {
492
                    continue;
493
                }
494
495
                $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...
496
                    ->fill($data);
497
            }
498
        } else {
499
            foreach ($this->value as $data) {
500
                $key = array_get($data, $relation->getRelated()->getKeyName());
501
502
                $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...
503
                    ->fill($data);
504
            }
505
        }
506
507
        return $forms;
508
    }
509
510
    /**
511
     * Setup script for this field in different view mode.
512
     *
513
     * @param string $script
514
     *
515
     * @return void
516
     */
517
    protected function setupScript($script)
518
    {
519
        $method = 'setupScriptFor'.ucfirst($this->viewMode).'View';
520
521
        call_user_func([$this, $method], $script);
522
    }
523
524
    /**
525
     * Setup default template script.
526
     *
527
     * @param string $templateScript
528
     *
529
     * @return void
530
     */
531 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...
532
    {
533
        $removeClass = NestedForm::REMOVE_FLAG_CLASS;
534
        $defaultKey = NestedForm::DEFAULT_KEY_NAME;
535
536
        /**
537
         * When add a new sub form, replace all element key in new sub form.
538
         *
539
         * @example comments[new___key__][title]  => comments[new_{index}][title]
540
         *
541
         * {count} is increment number of current sub form count.
542
         */
543
        $script = <<<EOT
544
var index = 0;
545
$('#has-many-{$this->column}').on('click', '.add', function() {
546
547
    var tpl = $('template.{$this->column}-tpl');
548
549
    index++;
550
551
    var template = tpl.html().replace(/{$defaultKey}/g, index);
552
    $('.has-many-{$this->column}-forms').append(template);
553
    {$templateScript}
554
});
555
556
$('#has-many-{$this->column}').on('click', '.remove', function() {
557
    $(this).closest('.has-many-{$this->column}-form').hide();
558
    $(this).closest('.has-many-{$this->column}-form').find('.$removeClass').val(1);
559
});
560
561
EOT;
562
563
        Admin::script($script);
564
    }
565
566
    /**
567
     * Setup tab template script.
568
     *
569
     * @param string $templateScript
570
     *
571
     * @return void
572
     */
573 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...
574
    {
575
        $removeClass = NestedForm::REMOVE_FLAG_CLASS;
576
        $defaultKey = NestedForm::DEFAULT_KEY_NAME;
577
578
        $script = <<<EOT
579
580
$('#has-many-{$this->column} > .nav').off('click', 'i.close-tab').on('click', 'i.close-tab', function(){
581
    var \$navTab = $(this).siblings('a');
582
    var \$pane = $(\$navTab.attr('href'));
583
    if( \$pane.hasClass('new') ){
584
        \$pane.remove();
585
    }else{
586
        \$pane.removeClass('active').find('.$removeClass').val(1);
587
    }
588
    if(\$navTab.closest('li').hasClass('active')){
589
        \$navTab.closest('li').remove();
590
        $('#has-many-{$this->column} > .nav > li:nth-child(1) > a').tab('show');
591
    }else{
592
        \$navTab.closest('li').remove();
593
    }
594
});
595
596
var index = 0;
597
$('#has-many-{$this->column} > .header').off('click', '.add').on('click', '.add', function(){
598
    index++;
599
    var navTabHtml = $('#has-many-{$this->column} > template.nav-tab-tpl').html().replace(/{$defaultKey}/g, index);
600
    var paneHtml = $('#has-many-{$this->column} > template.pane-tpl').html().replace(/{$defaultKey}/g, index);
601
    $('#has-many-{$this->column} > .nav').append(navTabHtml);
602
    $('#has-many-{$this->column} > .tab-content').append(paneHtml);
603
    $('#has-many-{$this->column} > .nav > li:last-child a').tab('show');
604
    {$templateScript}
605
});
606
607
if ($('.has-error').length) {
608
    $('.has-error').parent('.tab-pane').each(function() {
609
        var tabId = '#'+$(this).attr('id');
610
        $('li a[href="'+tabId+'"] i').removeClass('hide');
611
    });
612
    
613
    var first = $('.has-error:first').parent().attr('id');
614
    $('li a[href="#'+first+'"]').tab('show');
615
}
616
EOT;
617
618
        Admin::script($script);
619
    }
620
621
    /**
622
     * Disable create button.
623
     *
624
     * @return $this
625
     */
626
    public function disableCreate()
627
    {
628
        $this->options['allowCreate'] = false;
629
630
        return $this;
631
    }
632
633
    /**
634
     * Disable delete button.
635
     *
636
     * @return $this
637
     */
638
    public function disableDelete()
639
    {
640
        $this->options['allowDelete'] = false;
641
642
        return $this;
643
    }
644
645
    /**
646
     * Render the `HasMany` field.
647
     *
648
     * @throws \Exception
649
     *
650
     * @return \Illuminate\View\View
651
     */
652
    public function render()
653
    {
654
        // specify a view to render.
655
        $this->view = $this->views[$this->viewMode];
656
657
        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...
658
            ->getTemplateHtmlAndScript();
659
660
        $this->setupScript($script);
661
662
        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...
663
            'forms'         => $this->buildRelatedForms(),
664
            'template'      => $template,
665
            'relationName'  => $this->relationName,
666
            'options'       => $this->options,
667
        ]);
668
    }
669
}
670