Completed
Pull Request — master (#2901)
by
unknown
02:24
created

Embeds::prepare()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 1
dl 0
loc 6
rs 10
c 0
b 0
f 0
1
<?php
2
3
namespace Encore\Admin\Form\Field;
4
5
use Encore\Admin\Form\EmbeddedForm;
6
use Encore\Admin\Form\Field;
7
use Illuminate\Support\Facades\Validator;
8
use Illuminate\Support\Str;
9
10
class Embeds extends Field
11
{
12
    /**
13
     * @var \Closure
14
     */
15
    protected $builder = null;
16
    protected $view = 'admin::form.embeds';
17
18
    /**
19
     * Create a new HasMany field instance.
20
     *
21
     * @param string $column
22
     * @param array  $arguments
23
     */
24 View Code Duplication
    public function __construct($column, $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...
25
    {
26
        $this->column = $column;
27
28
        if (count($arguments) == 1) {
29
            $this->label = $this->formatLabel();
30
            $this->builder = $arguments[0];
31
        }
32
33
        if (count($arguments) == 2) {
34
            list($this->label, $this->builder) = $arguments;
35
        }
36
    }
37
38
    /**
39
     * Prepare input data for insert or update.
40
     *
41
     * @param array $input
42
     *
43
     * @return array
44
     */
45
    public function prepare($input)
46
    {
47
        $form = $this->buildEmbeddedForm();
48
49
        return $form->setOriginal($this->original)->prepare($input);
50
    }
51
52
    /**
53
     * {@inheritdoc}
54
     */
55
    public function getValidator(array $input)
56
    {
57
        if (!array_key_exists($this->column, $input)) {
58
            return false;
59
        }
60
61
        $input = array_only($input, $this->column);
62
63
        $rules = $attributes = $messages = [];
64
        $rel = $this->column;
65
66
        $availInput = $input;
67 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...
68
            return call_user_func_array(
69
                'array_merge',
70
                array_map(function ($u, $v) use ($b, $c) {
71
                    return ["{$b}{$c}{$u}" => $v];
72
                }, array_keys($a), array_values($a))
73
            );
74
        };
75
76 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...
77
            $a = count($a) ? call_user_func_array('array_merge', array_map(function ($k, $v) {
78
                return [str_replace(':', '', $k) => $v];
79
            }, array_keys($a), array_values($a))) : $a;
80
81
            return $a;
82
        };
83
84 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...
85
            if (count($a)) {
86
                foreach ($a as $key => $val) {
87
                    array_set($a, str_replace(':', '', $key), $val);
88
                    if (preg_match('/[\.\:]/', $key)) {
89
                        unset($a[$key]);
90
                    }
91
                }
92
            }
93
94
            return $a;
95
        };
96
97
        /** @var Field $field */
98
        foreach ($this->buildEmbeddedForm()->fields() as $field) {
99
            if (!$fieldRules = $field->getRules()) {
100
                continue;
101
            }
102
103
            $column = $field->column();
104
            $columns = is_array($column) ? $column : [$column];
105
            if ($field instanceof Field\MultipleSelect) {
106
                $availInput[$column] = array_filter($availInput[$column], 'strlen');
107
                $availInput[$column] = $availInput[$column] ?: null;
108
            }
109
            /*
110
             *
111
             * For single column field format rules to:
112
             * [
113
             *     'extra.name' => 'required'
114
             *     'extra.email' => 'required'
115
             * ]
116
             *
117
             * For multiple column field with rules like 'required':
118
             * 'extra' => [
119
             *     'start' => 'start_at'
120
             *     'end'   => 'end_at',
121
             * ]
122
             *
123
             * format rules to:
124
             * [
125
             *     'extra.start_atstart' => 'required'
126
             *     'extra.end_atend' => 'required'
127
             * ]
128
             */
129
            $newColumn = array_map(function ($k, $v) use ($rel) {
130
                //Fix ResetInput Function! A Headache Implementation!
131
                return !$k ? "{$rel}.{$v}" : "{$rel}.{$v}:{$k}";
132
            }, array_keys($columns), array_values($columns));
133
134
            $fieldRules = is_array($fieldRules) ? implode('|', $fieldRules) : $fieldRules;
135
            $rules = array_merge($rules, call_user_func_array(
136
                'array_merge',
137
                array_map(function ($v) use ($fieldRules) {
138
                    return [$v => $fieldRules];
139
                }, $newColumn)
140
            ));
141
            $attributes = array_merge($attributes, call_user_func_array(
142
                'array_merge',
143 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...
144
                    //Fix ResetInput Function! A Headache Implementation!
145
                    $u = $field->label();
146
                    $u .= is_array($field->column()) ? '['.explode(':', explode('.', $v)[1])[0].']' : '';
147
148
                    return [$v => "{$u}"];
149
                }, $newColumn)
150
            ));
151 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...
152
                $newMessages = array_map(function ($v) use ($field, $availInput, $array_key_attach_str) {
153
                    list($rel, $col) = explode('.', $v);
154
                    //Fix ResetInput Function! A Headache Implementation!
155
                    $col1 = explode(':', $col)[0];
156
                    if (!array_key_exists($col1, $availInput[$rel])) {
157
                        return [null => null];
158
                    }
159
                    $rows = $availInput[$rel][$col1];
160
                    if (!is_array($rows)) {
161
                        return $array_key_attach_str($field->validationMessages, $v);
162
                    }
163
                    $r = [];
164
                    foreach (array_keys($rows) as $k) {
165
                        $k = "{$v}{$k}";
166
                        $r = array_merge($r, $array_key_attach_str($field->validationMessages, $k));
167
                    }
168
169
                    return $r;
170
                }, $newColumn);
171
                $newMessages = call_user_func_array('array_merge', $newMessages);
172
                $messages = array_merge($messages, $newMessages);
173
            }
174
        }
175
176
        if (empty($rules)) {
177
            return false;
178
        }
179
        $newInput = call_user_func_array('array_merge', array_map(function ($idx) use ($availInput) {
180
            list($rel, $col) = explode('.', $idx);
181
            //Fix ResetInput Function! A Headache Implementation!
182
            $col1 = explode(':', $col)[0];
183
            if (!array_key_exists($col1, $availInput[$rel])) {
184
                return [null => null];
185
            }
186
            if (is_array($availInput[$rel][$col1])) {
187
                return call_user_func_array('array_merge', array_map(function ($x, $y) use ($idx) {
188
                    return ["{$idx}{$x}" => $y];
189
                }, array_keys($availInput[$rel][$col1]), $availInput[$rel][$col1]));
190
            }
191
192
            return ["{$idx}" => $availInput[$rel][$col1]];
193
        }, array_keys($rules)));
194
195
        $newInput = $array_key_clean_undot($newInput);
196
        $newRules = array_map(function ($idx) use ($availInput, $rules) {
197
            list($rel, $col) = explode('.', $idx);
198
            //Fix ResetInput Function! A Headache Implementation!
199
            $col1 = explode(':', $col)[0];
200
            if (!array_key_exists($col1, $availInput[$rel])) {
201
                return [null => null];
202
            }
203
            if (is_array($availInput[$rel][$col1])) {
204
                return call_user_func_array('array_merge', array_map(function ($x) use ($idx, $rules) {
205
                    return ["{$idx}{$x}" => $rules[$idx]];
206
                }, array_keys($availInput[$rel][$col1])));
207
            }
208
209
            return ["{$idx}" => $rules[$idx]];
210
        }, array_keys($rules));
211
        $newRules = array_filter(call_user_func_array('array_merge', $newRules), 'strlen', ARRAY_FILTER_USE_KEY);
212
        $newRules = $array_key_clean($newRules);
213
214
        $newAttributes = array_map(function ($idx) use ($availInput, $attributes) {
215
            list($rel, $col) = explode('.', $idx);
216
            //Fix ResetInput Function! A Headache Implementation!
217
            $col1 = explode(':', $col)[0];
218
            if (!array_key_exists($col1, $availInput[$rel])) {
219
                return [null => null];
220
            }
221 View Code Duplication
            if (is_array($availInput[$rel][$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...
222
                if (array_keys($availInput[$rel][$col1])) {
223
                    return call_user_func_array('array_merge', array_map(function ($x) use ($idx, $attributes) {
224
                        return ["{$idx}.{$x}" => $attributes[$idx]];
225
                    }, array_keys($availInput[$rel][$col1])));
226
                }
227
228
                return [null => null];
229
            }
230
231
            return ["{$idx}" => $attributes[$idx]];
232
        }, array_keys($attributes));
233
        $newAttributes = array_filter(call_user_func_array('array_merge', $newAttributes), 'strlen');
234
        $newAttributes = $array_key_clean($newAttributes);
235
236
        $messages = $array_key_clean($messages);
237
238
        if (empty($newInput)) {
239
            $newInput = $availInput;
240
        }
241
242
        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...
243
    }
244
245
246
247
    /**
248
     * Format validation attributes.
249
     *
250
     * @param array  $input
251
     * @param string $label
252
     * @param string $column
253
     *
254
     * @return array
255
     */
256 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...
257
    {
258
        $new = $attributes = [];
259
260
        if (is_array($column)) {
261
            foreach ($column as $index => $col) {
262
                $new[$col.$index] = $col;
263
            }
264
        }
265
266
        foreach (array_keys(array_dot($input)) as $key) {
267
            if (is_string($column)) {
268
                if (Str::endsWith($key, ".$column")) {
269
                    $attributes[$key] = $label;
270
                }
271
            } else {
272
                foreach ($new as $k => $val) {
273
                    if (Str::endsWith($key, ".$k")) {
274
                        $attributes[$key] = $label."[$val]";
275
                    }
276
                }
277
            }
278
        }
279
280
        return $attributes;
281
    }
282
283
    /**
284
     * Reset input key for validation.
285
     *
286
     * @param array $input
287
     * @param array $column $column is the column name array set
288
     *
289
     * @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...
290
     */
291
    public function resetInputKey(array &$input, array $column)
292
    {
293
        $column = array_flip($column);
294
295 View Code Duplication
        foreach ($input[$this->column] as $key => $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...
296
            if (!array_key_exists($key, $column)) {
297
                continue;
298
            }
299
300
            $newKey = $key.$column[$key];
301
302
            /*
303
             * set new key
304
             */
305
            array_set($input, "{$this->column}.$newKey", $value);
306
            /*
307
             * forget the old key and value
308
             */
309
            array_forget($input, "{$this->column}.$key");
310
        }
311
    }
312
313
    /**
314
     * Get data for Embedded form.
315
     *
316
     * Normally, data is obtained from the database.
317
     *
318
     * When the data validation errors, data is obtained from session flash.
319
     *
320
     * @return array
321
     */
322
    protected function getEmbeddedData()
323
    {
324
        if ($old = 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...
325
            return $old;
326
        }
327
328
        if (empty($this->value)) {
329
            return [];
330
        }
331
332
        if (is_string($this->value)) {
333
            return json_decode($this->value, true);
334
        }
335
336
        return (array)$this->value;
337
    }
338
339
    /**
340
     * Build a Embedded Form and fill data.
341
     *
342
     * @return EmbeddedForm
343
     */
344
    protected function buildEmbeddedForm()
345
    {
346
        $form = new EmbeddedForm($this->column);
0 ignored issues
show
Bug introduced by
It seems like $this->column can also be of type array; however, Encore\Admin\Form\EmbeddedForm::__construct() 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...
347
348
        $form->setParent($this->form);
349
350
        call_user_func($this->builder, $form);
351
352
        $form->fill($this->getEmbeddedData());
353
354
        return $form;
355
    }
356
357
    /**
358
     * Render the form.
359
     *
360
     * @return \Illuminate\View\View
361
     */
362
    public function render()
363
    {
364
        return parent::render()->with(['form' => $this->buildEmbeddedForm()]);
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...
365
    }
366
}
367