Encore\Admin\Form\Field\HasMany

Complexity

Total Complexity

66

Size/Duplication

Total Lines	654
Duplicated Lines	35.02 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	setupScript()	0	6	1
A	setupScriptForDefaultView()	34	34	1
A	setupScriptForTabView()	47	47	1
A	__construct()	15	15	3
F	getValidator()	99	167	36
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
A	useTable()	0	4	1
B	buildRelatedForms()	0	43	8
A	setupScriptForTableView()	34	34	1
A	disableCreate()	0	6	1
A	disableDelete()	0	6	1
A	render()	0	21	2
A	renderTable()	0	50	4

<?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;

if (!function_exists('Encore\Admin\Form\Field\array_key_attach_str')) {

This code seems to be duplicated across your project.

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

The function Encore\Admin\Form\Field\array_key_attach_str() has been defined more than once; this definition is ignored, only the first definition in src/Form/Field/Embeds.php (L10-18) is considered.

    {
        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))
        );
    };
}

if (!function_exists('Encore\Admin\Form\Field\array_clean_merge')) {
    function array_clean_merge(array $a, $b)

The function Encore\Admin\Form\Field\array_clean_merge() has been defined more than once; this definition is ignored, only the first definition in src/Form/Field/Embeds.php (L22-25) is considered.

    {
        return $b ? array_merge($a, call_user_func_array('array_merge', $b)) : $a;
    };
}

if (!function_exists('Encore\Admin\Form\Field\array_key_clean_undot')) {

This code seems to be duplicated across your project.

    function array_key_clean_undot(array $a)

The function Encore\Admin\Form\Field\array_key_clean_undot() has been defined more than once; this definition is ignored, only the first definition in src/Form/Field/Embeds.php (L29-40) is considered.

    {
        $keys = preg_grep('/[\.\:]/', array_keys($a));
        if ($keys) {

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.

            foreach ($keys as $key) {
                array_set($a, str_replace(':', '', $key), $a[$key]);
                unset($a[$key]);
            }
        }

        return $a;
    };
}

if (!function_exists('Encore\Admin\Form\Field\array_key_clean')) {

This code seems to be duplicated across your project.

    function array_key_clean(array $a)

The function Encore\Admin\Form\Field\array_key_clean() has been defined more than once; this definition is ignored, only the first definition in src/Form/Field/Embeds.php (L44-51) is considered.

    {
        $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;
    };
}

/**
 * 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',
        'table'   => 'admin::form.hasmanytable',
    ];

    /**
     * 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;
        }

        $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 = $newInputs = [];
        // 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 ($field instanceof Field\HasMany) {
                throw new \Exception('nested hasMany field found.');
            }
            if (!($field instanceof Field\Embeds) && !($fieldRules = $field->getRules())) {
                continue;
            }
            $column = $field->column();
            $columns = is_array($column) ? $column : [$column];
            if (

This code seems to be duplicated across your project.

                $field instanceof Field\MultipleSelect
                || $field instanceof Field\Listbox
                || $field instanceof Field\Checkbox
                || $field instanceof Field\Tags
                || $field instanceof Field\MultipleImage
                || $field instanceof Field\MultipleFile
            ) {
                foreach ($keys as $key) {
                    $availInput[$key][$column] = array_filter($availInput[$key][$column], 'strlen') ?: null;
                }
            }

            $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}:{$k}" : "{$rel}.{$u}.{$v}";
                }, array_keys($columns), array_values($columns));
            }, $keys));

            if ($field instanceof Field\Embeds) {
                $newRules = array_map(function ($v) use ($availInput, $field) {

This code seems to be duplicated across your project.

                    list($r, $k, $c) = explode('.', $v);
                    $v = "{$r}.{$k}";
                    $embed = $field->getValidationRules([$field->column() => $availInput[$k][$c]]);

                    return $embed ? array_key_attach_str($embed, $v) : null;
                }, $newColumn);
                $rules = array_clean_merge($rules, array_filter($newRules));

                $newAttributes = array_map(function ($v) use ($availInput, $field) {

This code seems to be duplicated across your project.

                    list($r, $k, $c) = explode('.', $v);
                    $v = "{$r}.{$k}";
                    $embed = $field->getValidationAttributes([$field->column() => $availInput[$k][$c]]);

                    return $embed ? array_key_attach_str($embed, $v) : null;
                }, $newColumn);
                $attributes = array_clean_merge($attributes, array_filter($newAttributes));

                $newInput = array_map(function ($v) use ($availInput, $field) {

This code seems to be duplicated across your project.

                    list($r, $k, $c) = explode('.', $v);
                    $v = "{$r}.{$k}";
                    $embed = $field->getValidationInput([$field->column() => $availInput[$k][$c]]);

                    return $embed ? array_key_attach_str($embed, $v) : [null => 'null'];
                }, $newColumn);
                $newInputs = array_clean_merge($newInputs, array_filter($newInput, 'strlen', ARRAY_FILTER_USE_KEY));

                $newMessages = array_map(function ($v) use ($availInput, $field) {

This code seems to be duplicated across your project.

                    list($r, $k, $c) = explode('.', $v);
                    $v = "{$r}.{$k}";
                    $embed = $field->getValidationMessages([$field->column() => $availInput[$k][$c]]);

                    return $embed ? array_key_attach_str($embed, $v) : null;
                }, $newColumn);
                $messages = array_clean_merge($messages, array_filter($newMessages));
            } else {
                $fieldRules = is_array($fieldRules) ? implode('|', $fieldRules) : $fieldRules;

The variable $fieldRules does not seem to be defined for all execution paths leading up to this point.

                $newRules = array_map(function ($v) use ($fieldRules, $availInput) {

This code seems to be duplicated across your project.

                    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!
                    $col = explode(':', $c)[0];
                    if (array_key_exists($col, $availInput[$k]) && is_array($availInput[$k][$col])) {
                        return array_key_attach_str(preg_replace('/.+/', $fieldRules, $availInput[$k][$col]), $v, ':');
                    }

                    return [$v => $fieldRules];
                }, $newColumn);
                $rules = array_clean_merge($rules, $newRules);

                $newInput = array_map(function ($v) use ($availInput) {

This code seems to be duplicated across your project.

                    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!
                    $col = explode(':', $c)[0];
                    if (!array_key_exists($col, $availInput[$k])) {
                        return [$v => null];
                    }

                    if (is_array($availInput[$k][$col])) {
                        return array_key_attach_str($availInput[$k][$col], $v, ':');
                    }

                    return [$v => $availInput[$k][$col]];
                }, $newColumn);
                $newInputs = array_clean_merge($newInputs, $newInput);

                $newAttributes = array_map(function ($v) use ($field, $availInput) {

This code seems to be duplicated across your project.

                    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!
                    $col = explode(':', $c)[0];
                    if (array_key_exists($col, $availInput[$k]) && is_array($availInput[$k][$col])) {
                        return call_user_func_array('array_merge', array_map(function ($u) use ($v, $field) {
                            $w = $field->label();
                            //Fix ResetInput Function! A Headache Implementation!
                            $w .= is_array($field->column()) ? '[' . explode(':', explode('.', $v)[2])[0] . ']' : '';

                            return ["{$v}:{$u}" => $w];
                        }, array_keys($availInput[$k][$col])));
                    }

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

                    return [$v => $w];
                }, $newColumn);
                $attributes = array_clean_merge($attributes, $newAttributes);
            }

            if ($field->validationMessages) {

This code seems to be duplicated across your project.

                $newMessages = array_map(function ($v) use ($field, $availInput) {
                    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!
                    $col = explode(':', $c)[0];
                    if (array_key_exists($col, $availInput[$k]) && is_array($availInput[$k][$col])) {
                        return call_user_func_array('array_merge', array_map(function ($u) use ($v, $field) {
                            return array_key_attach_str($field->validationMessages, "{$v}:{$u}");
                        }, array_keys($availInput[$k][$col])));
                    }

                    return array_key_attach_str($field->validationMessages, $v);
                }, $newColumn);
                $messages = array_clean_merge($messages, $newMessages);
            }
        }

        $rules = array_filter($rules, 'strlen');
        if (empty($rules)) {
            return false;
        }

        $input = array_key_clean_undot(array_filter($newInputs, 'strlen', ARRAY_FILTER_USE_KEY));
        $rules = array_key_clean($rules);
        $attributes = array_key_clean($attributes);
        $messages = array_key_clean($messages);

        if (empty($input)) {
            $input = [$rel => $availInput];
        }

        return Validator::make($input, $rules, $messages, $attributes);

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

    }


    /**
     * 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');
    }

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

    /**
     * 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);
    }

    /**
     * Setup default template script.
     *
     * @param string $templateScript
     *
     * @return void
     */
    protected function setupScriptForTableView($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);
    }

    /**
     * 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()
    {
        if ($this->viewMode == 'table') {
            return $this->renderTable();
        }

        // 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,
        ]);
    }

    /**
     * Render the `HasMany` field for table style.
     *
     * @throws \Exception
     *
     * @return mixed
     */
    protected function renderTable()
    {
        $headers = [];
        $fields = [];
        $hidden = [];
        $scripts = [];

        /* @var Field $field */
        foreach ($this->buildNestedForm($this->column, $this->builder)->fields() as $field) {

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 (is_a($field, Hidden::class)) {
                $hidden[] = $field->render();
            } else {
                /* Hide label and set field width 100% */
                $field->setLabelClass(['hidden']);
                $field->setWidth(12, 0);
                $fields[] = $field->render();
                $headers[] = $field->label();
            }

            /*
             * Get and remove the last script of Admin::$script stack.
             */
            if ($field->getScript()) {
                $scripts[] = array_pop(Admin::$script);
            }
        }

        /* Build row elements */
        $template = array_reduce($fields, function ($all, $field) {
            $all .= "<td>{$field}</td>";

            return $all;
        }, '');

        /* Build cell with hidden elements */
        $template .= '<td class="hidden">' . implode('', $hidden) . '</td>';

        $this->setupScript(implode("\r\n", $scripts));

        // specify a view to render.
        $this->view = $this->views[$this->viewMode];

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

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

It seems like you call parent on a different method (render() instead of renderTable()). Are you sure this is correct? If so, you might want to change this to $this->render().

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