Encore\Admin\Form\Field\HasMany

Complexity

Total Complexity

64

Size/Duplication

Total Lines	650
Duplicated Lines	31.54 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	15	15	3
F	getValidator()	57	180	29
B	formatValidationAttribute()	26	26	8
A	resetInputKey()	26	54	4
A	prepare()	0	6	1
A	buildNestedForm()	0	14	1
A	getKeyName()	0	8	2
A	mode()	0	6	1
A	useTab()	0	4	1
B	buildRelatedForms()	0	43	8
A	setupScript()	0	6	1
A	setupScriptForDefaultView()	34	34	1
A	setupScriptForTabView()	47	47	1
A	disableCreate()	0	6	1
A	disableDelete()	0	6	1
A	render()	0	17	1

<?php

namespace Encore\Admin\Form\Field;

use Encore\Admin\Admin;
use Encore\Admin\Form;
use Encore\Admin\Form\Field;
use Encore\Admin\Form\NestedForm;
use Illuminate\Database\Eloquent\Relations\HasMany as Relation;
use Illuminate\Database\Eloquent\Relations\MorphMany;
use Illuminate\Support\Facades\Validator;
use Illuminate\Support\Str;

/**
 * Class HasMany.
 */
class HasMany extends Field
{
    /**
     * Relation name.
     *
     * @var string
     */
    protected $relationName = '';

    /**
     * Form builder.
     *
     * @var \Closure
     */
    protected $builder = null;

    /**
     * Form data.
     *
     * @var array
     */
    protected $value = [];

    /**
     * View Mode.
     *
     * Supports `default` and `tab` currently.
     *
     * @var string
     */
    protected $viewMode = 'default';

    /**
     * Available views for HasMany field.
     *
     * @var array
     */
    protected $views = [
        'default' => 'admin::form.hasmany',
        'tab' => 'admin::form.hasmanytab',
    ];

    /**
     * Options for template.
     *
     * @var array
     */
    protected $options = [
        'allowCreate' => true,
        'allowDelete' => true,
    ];

    /**
     * Create a new HasMany field instance.
     *
     * @param $relationName
     * @param array $arguments
     */
    public function __construct($relationName, $arguments = [])

This method seems to be duplicated in your project.

    {
        $this->relationName = $relationName;

        $this->column = $relationName;

        if (count($arguments) == 1) {
            $this->label = $this->formatLabel();
            $this->builder = $arguments[0];
        }

        if (count($arguments) == 2) {
            list($this->label, $this->builder) = $arguments;
        }
    }

    /**
     * Get validator for this field.
     *
     * @param array $input
     *
     * @return bool|Validator
     */
    public function getValidator(array $input)
    {
        if (!array_key_exists($this->column, $input)) {
            return false;
        }

        $array_key_attach_str = function (array $a, string $b, string $c = '.') {

This code seems to be duplicated across your project.

            return call_user_func_array(
                'array_merge',
                array_map(function ($u, $v) use ($b, $c) {
                    return ["{$b}{$c}{$u}" => $v];
                }, array_keys($a), array_values($a))
            );
        };

        $array_key_clean = function (array $a) {

This code seems to be duplicated across your project.

            $a = count($a) ? call_user_func_array('array_merge', array_map(function ($k, $v) {
                return [str_replace(':', '', $k) => $v];
            }, array_keys($a), array_values($a))) : $a;

            return $a;
        };

        $array_key_clean_undot = function (array $a) {

This code seems to be duplicated across your project.

            if (count($a)) {
                foreach ($a as $key => $val) {
                    array_set($a, str_replace(':', '', $key), $val);
                    if (preg_match('/[\.\:]/', $key)) {
                        unset($a[$key]);
                    }
                }
            }

            return $a;
        };

        $input = array_only($input, $this->column);
        $form = $this->buildNestedForm($this->column, $this->builder);

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?

        $rel = $this->relationName;
        $rules = $attributes = [];
        $messages = [];
        // remove all inputs & keys marked as removed
        $availInput = array_filter(array_map(function ($v) {
            return $v[NestedForm::REMOVE_FLAG_NAME] ? null : $v;
        }, $input[$rel]));
        $keys = array_keys($availInput);
        /* @var Field $field */
        foreach ($form->fields() as $field) {
            if (!$fieldRules = $field->getRules()) {
                continue;
            }
            $column = $field->column();
            $columns = is_array($column) ? $column : [$column];
            if ($field instanceof Field\MultipleSelect) {
                foreach ($keys as $key) {
                    $availInput[$key][$column] = array_filter($availInput[$key][$column], 'strlen');
                    $availInput[$key][$column] = $availInput[$key][$column] ? : null;
                }
            }
            // if($field instanceof Field\File)
            // {
            //     dd(request());
            // }
            $newColumn = call_user_func_array('array_merge', array_map(function ($u) use ($columns, $rel) {
                return array_map(function ($k, $v) use ($u, $rel) {
                            //Fix ResetInput Function! A Headache Implementation!
                    return !$k ? "{$rel}.{$u}.{$v}" : "{$rel}.{$u}.{$v}:{$k}";
                }, array_keys($columns), array_values($columns));
            }, $keys));

            $fieldRules = is_array($fieldRules) ? implode('|', $fieldRules) : $fieldRules;
            $rules = array_merge($rules, call_user_func_array(
                'array_merge',
                array_map(function ($v) use ($fieldRules) {
                    return [$v => $fieldRules];
                }, $newColumn)
            ));
            $attributes = array_merge($attributes, call_user_func_array(
                'array_merge',
                array_map(function ($v) use ($field) {

This code seems to be duplicated across your project.

                    //Fix ResetInput Function! A Headache Implementation!
                    $u = $field->label();
                    $u .= is_array($field->column()) ? '[' . explode(':', explode('.', $v)[1])[0] . ']' : '';

                    return [$v => "{$u}"];
                }, $newColumn)
            ));
            if ($field->validationMessages) {

This code seems to be duplicated across your project.

                $newMessages = array_map(function ($v) use ($field, $availInput, $array_key_attach_str) {
                    list($r, $k, $c) = explode('.', $v);

The assignment to $r is unused. Consider omitting it like so list($first,,$third).

                    //Fix ResetInput Function! A Headache Implementation!
                    $col1 = explode(':', $c)[0];
                    if (!array_key_exists($col1, $availInput[$k])) {
                        return [null => null];
                    }
                    $rows = $availInput[$k][$col1];
                    if (!is_array($rows)) {
                        return $array_key_attach_str($field->validationMessages, $v);
                    }
                    $r = [];
                    foreach (array_keys($rows) as $k) {
                        $k = "{$v}{$k}";
                        $r = array_merge($r, $array_key_attach_str($field->validationMessages, $k));
                    }
                    return $r;
                }, $newColumn);
                $newMessages = call_user_func_array('array_merge', $newMessages);
                $messages = array_merge($messages, $newMessages);
            }
        }

        if (empty($rules)) {
            return false;
        }

        $newInput = call_user_func_array('array_merge', array_map(function ($u) use ($availInput) {
            list($rel, $key, $col) = explode('.', $u);
            $idx = "{$rel}.{$key}.{$col}";
            //Fix ResetInput Function! A Headache Implementation!
            $col1 = explode(':', $col)[0];
            if (!array_key_exists($col1, $availInput[$key])) {
                return [null => null];
            }
            if (is_array($availInput[$key][$col1])) {
                return call_user_func_array('array_merge', array_map(function ($x, $y) use ($idx) {
                    return ["{$idx}{$x}" => $y];
                }, array_keys($availInput[$key][$col1]), $availInput[$key][$col1]));
            }
            return ["{$idx}" => $availInput[$key][$col1]];
        }, array_keys($rules)));
        $newInput = $array_key_clean_undot($newInput);

        $newRules = array_map(function ($u) use ($availInput, $rules) {
            list($rel, $key, $col) = explode('.', $u);
            $idx = "{$rel}.{$key}.{$col}";
            //Fix ResetInput Function! A Headache Implementation!
            $col1 = explode(':', $col)[0];
            if (!array_key_exists($col1, $availInput[$key])) {
                return [null => null];
            }
            if (is_array($availInput[$key][$col1])) {
                return call_user_func_array('array_merge', array_map(function ($x) use ($idx, $rules) {
                    return ["{$idx}{$x}" => $rules[$idx]];
                }, array_keys($availInput[$key][$col1])));
            }

            return ["{$idx}" => $rules[$idx]];
        }, array_keys($rules));
        $newRules = array_filter(call_user_func_array('array_merge', $newRules), 'strlen', ARRAY_FILTER_USE_KEY);
        $newRules = $array_key_clean($newRules);

        $newAttributes = array_map(function ($u) use ($availInput, $attributes) {
            list($rel, $key, $col) = explode('.', $u);
            $idx = "{$rel}.{$key}.{$col}";
            //Fix ResetInput Function! A Headache Implementation!
            $col1 = explode(':', $col)[0];
            if (!array_key_exists($col1, $availInput[$key])) {
                return [null => null];
            }
            if (is_array($availInput[$key][$col1])) {

This code seems to be duplicated across your project.

                if (array_keys($availInput[$key][$col1])) {
                    return call_user_func_array('array_merge', array_map(function ($x) use ($idx, $attributes) {
                        return ["{$idx}.{$x}" => $attributes[$idx]];
                    }, array_keys($availInput[$key][$col1])));
                }
                return [null => null];
            }

            return ["{$idx}" => $attributes[$idx]];
        }, array_keys($attributes));
        $newAttributes = array_filter(call_user_func_array('array_merge', $newAttributes), 'strlen');
        $newAttributes = $array_key_clean($newAttributes);

        $messages = $array_key_clean($messages);

        if (empty($newInput)) {
            $newInput = [$rel => $availInput];
        }
        return Validator::make($newInput, $newRules, $messages, $newAttributes);

The return type of return \Illuminate\Support\Facades\Validator::make($newInput, $newRules, $messages, $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.

    }

    /**
     * Format validation attributes.
     *
     * @param array  $input
     * @param string $label
     * @param string $column
     *
     * @return array
     */
    protected function formatValidationAttribute($input, $label, $column)

This method seems to be duplicated in your project.

    {
        $new = $attributes = [];

        if (is_array($column)) {
            foreach ($column as $index => $col) {
                $new[$col . $index] = $col;
            }
        }

        foreach (array_keys(array_dot($input)) as $key) {
            if (is_string($column)) {
                if (Str::endsWith($key, ".$column")) {
                    $attributes[$key] = $label;
                }
            } else {
                foreach ($new as $k => $val) {
                    if (Str::endsWith($key, ".$k")) {
                        $attributes[$key] = $label . "[$val]";
                    }
                }
            }
        }

        return $attributes;
    }

    /**
     * Reset input key for validation.
     *
     * @param array $input
     * @param array $column $column is the column name array set
     *
     * @return void.

The doc-type void. could not be parsed: Unknown type name "void." at position 0. (view supported doc-types)

     */
    protected function resetInputKey(array &$input, array $column)
    {
        /**
         * flip the column name array set.
         *
         * for example, for the DateRange, the column like as below
         *
         * ["start" => "created_at", "end" => "updated_at"]
         *
         * to:
         *
         * [ "created_at" => "start", "updated_at" => "end" ]
         */
        $column = array_flip($column);

        /**
         * $this->column is the inputs array's node name, default is the relation name.
         *
         * So... $input[$this->column] is the data of this column's inputs data
         *
         * in the HasMany relation, has many data/field set, $set is field set in the below
         */
        foreach ($input[$this->column] as $index => $set) {
            /*
             * foreach the field set to find the corresponding $column
             */
            foreach ($set as $name => $value) {

This code seems to be duplicated across your project.

                /*
                 * if doesn't have column name, continue to the next loop
                 */
                if (!array_key_exists($name, $column)) {
                    continue;
                }

                /**
                 * example:  $newKey = created_atstart.
                 *
                 * Σ( ° △ °|||)︴
                 *
                 * I don't know why a form need range input? Only can imagine is for range search....
                 */
                $newKey = $name . $column[$name];

                /*
                 * set new key
                 */
                array_set($input, "{$this->column}.$index.$newKey", $value);
                /*
                 * forget the old key and value
                 */
                array_forget($input, "{$this->column}.$index.$name");
            }
        }
    }

    /**
     * Prepare input data for insert or update.
     *
     * @param array $input
     *
     * @return array
     */
    public function prepare($input)
    {
        $form = $this->buildNestedForm($this->column, $this->builder);

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?

        return $form->setOriginal($this->original, $this->getKeyName())->prepare($input);
    }

    /**
     * Build a Nested form.
     *
     * @param string   $column
     * @param \Closure $builder
     * @param null     $key
     *
     * @return NestedForm
     */
    protected function buildNestedForm($column, \Closure $builder, $key = null)
    {
        $form = new Form\NestedForm($column, $key);

        $form->setForm($this->form);

        call_user_func($builder, $form);

        $form->hidden($this->getKeyName());

        $form->hidden(NestedForm::REMOVE_FLAG_NAME)->default(0)->addElementClass(NestedForm::REMOVE_FLAG_CLASS);

        return $form;
    }

    /**
     * Get the HasMany relation key name.
     *
     * @return string
     */
    protected function getKeyName()
    {
        if (is_null($this->form)) {
            return;
        }

        return $this->form->model()->{$this->relationName}()->getRelated()->getKeyName();
    }

    /**
     * Set view mode.
     *
     * @param string $mode currently support `tab` mode.
     *
     * @return $this
     *
     * @author Edwin Hui
     */
    public function mode($mode)
    {
        $this->viewMode = $mode;

        return $this;
    }

    /**
     * Use tab mode to showing hasmany field.
     *
     * @return HasMany
     */
    public function useTab()
    {
        return $this->mode('tab');
    }

    /**
     * Build Nested form for related data.
     *
     * @throws \Exception
     *
     * @return array
     */
    protected function buildRelatedForms()
    {
        if (is_null($this->form)) {
            return [];
        }

        $model = $this->form->model();

        $relation = call_user_func([$model, $this->relationName]);

        if (!$relation instanceof Relation && !$relation instanceof MorphMany) {
            throw new \Exception('hasMany field must be a HasMany or MorphMany relation.');
        }

        $forms = [];

        /*
         * If redirect from `exception` or `validation error` page.
         *
         * Then get form data from session flash.
         *
         * Else get data from database.
         */
        if ($values = old($this->column)) {

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?

            foreach ($values as $key => $data) {
                if ($data[NestedForm::REMOVE_FLAG_NAME] == 1) {
                    continue;
                }

                $forms[$key] = $this->buildNestedForm($this->column, $this->builder, $key)

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?

                    ->fill($data);
            }
        } else {
            foreach ($this->value as $data) {
                $key = array_get($data, $relation->getRelated()->getKeyName());

                $forms[$key] = $this->buildNestedForm($this->column, $this->builder, $key)

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?

                    ->fill($data);
            }
        }

        return $forms;
    }

    /**
     * Setup script for this field in different view mode.
     *
     * @param string $script
     *
     * @return void
     */
    protected function setupScript($script)
    {
        $method = 'setupScriptFor' . ucfirst($this->viewMode) . 'View';

        call_user_func([$this, $method], $script);
    }

    /**
     * Setup default template script.
     *
     * @param string $templateScript
     *
     * @return void
     */
    protected function setupScriptForDefaultView($templateScript)

This method seems to be duplicated in your project.

    {
        $removeClass = NestedForm::REMOVE_FLAG_CLASS;
        $defaultKey = NestedForm::DEFAULT_KEY_NAME;

        /**
         * When add a new sub form, replace all element key in new sub form.
         *
         * @example comments[new___key__][title]  => comments[new_{index}][title]
         *
         * {count} is increment number of current sub form count.
         */
        $script = <<<EOT
var index = 0;
$('#has-many-{$this->column}').on('click', '.add', function () {

    var tpl = $('template.{$this->column}-tpl');

    index++;

    var template = tpl.html().replace(/{$defaultKey}/g, index);
    $('.has-many-{$this->column}-forms').append(template);
    {$templateScript}
});

$('#has-many-{$this->column}').on('click', '.remove', function () {
    $(this).closest('.has-many-{$this->column}-form').hide();
    $(this).closest('.has-many-{$this->column}-form').find('.$removeClass').val(1);
});

EOT;

        Admin::script($script);
    }

    /**
     * Setup tab template script.
     *
     * @param string $templateScript
     *
     * @return void
     */
    protected function setupScriptForTabView($templateScript)

This method seems to be duplicated in your project.

    {
        $removeClass = NestedForm::REMOVE_FLAG_CLASS;
        $defaultKey = NestedForm::DEFAULT_KEY_NAME;

        $script = <<<EOT

$('#has-many-{$this->column} > .nav').off('click', 'i.close-tab').on('click', 'i.close-tab', function(){
    var \$navTab = $(this).siblings('a');
    var \$pane = $(\$navTab.attr('href'));
    if( \$pane.hasClass('new') ){
        \$pane.remove();
    }else{
        \$pane.removeClass('active').find('.$removeClass').val(1);
    }
    if(\$navTab.closest('li').hasClass('active')){
        \$navTab.closest('li').remove();
        $('#has-many-{$this->column} > .nav > li:nth-child(1) > a').tab('show');
    }else{
        \$navTab.closest('li').remove();
    }
});

var index = 0;
$('#has-many-{$this->column} > .header').off('click', '.add').on('click', '.add', function(){
    index++;
    var navTabHtml = $('#has-many-{$this->column} > template.nav-tab-tpl').html().replace(/{$defaultKey}/g, index);
    var paneHtml = $('#has-many-{$this->column} > template.pane-tpl').html().replace(/{$defaultKey}/g, index);
    $('#has-many-{$this->column} > .nav').append(navTabHtml);
    $('#has-many-{$this->column} > .tab-content').append(paneHtml);
    $('#has-many-{$this->column} > .nav > li:last-child a').tab('show');
    {$templateScript}
});

if ($('.has-error').length) {
    $('.has-error').parent('.tab-pane').each(function () {
        var tabId = '#'+$(this).attr('id');
        $('li a[href="'+tabId+'"] i').removeClass('hide');
    });
    
    var first = $('.has-error:first').parent().attr('id');
    $('li a[href="#'+first+'"]').tab('show');
}
EOT;

        Admin::script($script);
    }

    /**
     * Disable create button.
     *
     * @return $this
     */
    public function disableCreate()
    {
        $this->options['allowCreate'] = false;

        return $this;
    }

    /**
     * Disable delete button.
     *
     * @return $this
     */
    public function disableDelete()
    {
        $this->options['allowDelete'] = false;

        return $this;
    }

    /**
     * Render the `HasMany` field.
     *
     * @throws \Exception
     *
     * @return \Illuminate\View\View
     */
    public function render()
    {
        // specify a view to render.
        $this->view = $this->views[$this->viewMode];

        list($template, $script) = $this->buildNestedForm($this->column, $this->builder)

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?

            ->getTemplateHtmlAndScript();

        $this->setupScript($script);

        return parent::render()->with([

The method with does only exist in Illuminate\View\View, but not in Illuminate\Contracts\View\Factory.

            'forms' => $this->buildRelatedForms(),
            'template' => $template,
            'relationName' => $this->relationName,
            'options' => $this->options,
        ]);
    }
}