Select - Code Metrics - Inspection of "Improvements in form selection, corrected error th..." - z-song/laravel-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2317)

unknown

created 2018-08-15 16:57 UTC

Select A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	365
Duplicated Lines	4.93 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
dl	18
loc	365
rs	10
c	0
b	0
f	0
wmc	28
lcom	1
cbo	4

9 Methods

Rating	Name	Duplication	Size	Complexity
B	options()	0	24	6
A	groups()	0	6	1
A	load()	0	30	2
A	loads()	0	41	1
B	selected()	0	36	11
A	loadRemoteOptions()	18	18	1
A	ajax()	0	50	1
A	config()	0	6	1
A	render()	0	30	4

How to fix Duplicated Code

<?php

namespace Encore\Admin\Form\Field;

use Encore\Admin\Facades\Admin;
use Encore\Admin\Form\Field;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Support\Str;

class Select extends Field
{
    /**
     * @var array
     */
    protected static $css = [
        '/vendor/laravel-admin/AdminLTE/plugins/select2/select2.min.css',
    ];

    /**
     * @var array
     */
    protected static $js = [
        '/vendor/laravel-admin/AdminLTE/plugins/select2/select2.full.min.js',
    ];

    /**
     * @var array
     */
    protected $groups = [];

    /**
     * @var array
     */
    protected $config = [];

    /**
     * Set options.
     *
     * @param array|callable|string $options
     *
     * @return $this|mixed
     */
    public function options($options = [])
    {
        // remote options
        if (is_string($options)) {
            // reload selected
            if (class_exists($options) && in_array('Illuminate\Database\Eloquent\Model', class_parents($options))) {
                return $this->selected(...func_get_args());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }

            return $this->loadRemoteOptions(...func_get_args());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        if ($options instanceof Arrayable) {
            $options = $options->toArray();
        }

        if (is_callable($options)) {
            $this->options = $options;

        } else {
            $this->options = (array) $options;
        }

        return $this;
    }

    /**
     * @param array $groups
     */

    /**
     * Set option groups.
     *
     * eg: $group = [
     *        [
     *        'label' => 'xxxx',
     *        'options' => [
     *            1 => 'foo',
     *            2 => 'bar',
     *            ...
     *        ],
     *        ...
     *     ]
     *
     * @param array $groups
     *
     * @return $this
     */
    public function groups(array $groups)
    {
        $this->groups = $groups;

        return $this;
    }

    /**
     * Load options for other select on change.
     *
     * @param string $field
     * @param string $sourceUrl
     * @param string $idField
     * @param string $textField
     *
     * @return $this
     */
    public function load($field, $sourceUrl, $idField = 'id', $textField = 'text')
    {
        if (Str::contains($field, '.')) {
            $field = $this->formatName($field);
            $class = str_replace(['[', ']'], '_', $field);
        } else {
            $class = $field;
        }

        $script = <<<EOT
$(document).off('change', "{$this->getElementClassSelector()}");
$(document).on('change', "{$this->getElementClassSelector()}", function () {
    var target = $(this).closest('.fields-group').find(".$class");
    $.get("$sourceUrl?q="+this.value, function (data) {
        target.find("option").remove();
        $(target).select2({
            data: $.map(data, function (d) {
                d.id = d.$idField;
                d.text = d.$textField;
                return d;
            })
        }).trigger('change');
    });
});
EOT;

        Admin::script($script);

        return $this;
    }

    /**
     * Load options for other selects on change.
     *
     * @param string $fields
     * @param string $sourceUrls
     * @param string $idField
     * @param string $textField
     *
     * @return $this
     */
    public function loads($fields = [], $sourceUrls = [], $idField = 'id', $textField = 'text')
    {
        $fieldsStr = implode('.', $fields);
        $urlsStr = implode('^', $sourceUrls);
        $script = <<<EOT
var fields = '$fieldsStr'.split('.');
var urls = '$urlsStr'.split('^');

var refreshOptions = function(url, target) {
    $.get(url).then(function(data) {
        target.find("option").remove();
        $(target).select2({
            data: $.map(data, function (d) {
                d.id = d.$idField;
                d.text = d.$textField;
                return d;
            })
        }).trigger('change');
    });
};

$(document).off('change', "{$this->getElementClassSelector()}");
$(document).on('change', "{$this->getElementClassSelector()}", function () {
    var _this = this;
    var promises = [];

    fields.forEach(function(field, index){
        var target = $(_this).closest('.fields-group').find('.' + fields[index]);
        promises.push(refreshOptions(urls[index] + "?q="+ _this.value, target));
    });

    $.when(promises).then(function() {
        console.log('开始更新其它select的选择options');
    });
});
EOT;

        Admin::script($script);

        return $this;
    }

    /**
     * Load options from current selected resource(s).
     *
     * @param Illuminate\Database\Eloquent\Model $model
     * @param string                             $textField
     * @param string                             $idField
     *
     * @return $this
     */
    protected function selected($model, $textField = 'name', $idField = 'id')
    {
        $this->options = function ($resource) use ($model, $textField, $idField) {

            if (null == $resource) {
                return [];
            }

            if (is_array($resource) && !empty($resource) && isset($resource[0]['id'])) {
                $resource = array_map(function ($res) {
                    return $res['id'];
                }, $resource);
            } elseif (is_array($resource) && !empty($resource) && isset($resource['id'])) {
                $resource = $resource['id'];
            }

            $model = $model::find($resource);
$x = 1;
$callable = function() use ($x) {
    $x = 2; // Not visible in outer scope. If you would like this, how
            // about using a different variable name than $x?
};

$callable();
var_dump($x); // integer(1)

            if ($model) {
                if ($model instanceof \Illuminate\Support\Collection) {
                    $results = [];

                    foreach ($model as $result) {
                        $results[$result->{$idField}] = $result->{$textField};
                    }

                    return $results;
                }

                return [$model->{$idField} => $model->{$textField}];
            }

            return [];
        };

        return $this;
    }

    /**
     * Load options from remote.
     *
     * @param string $url
     * @param array  $parameters
     * @param array  $options
     *
     * @return $this
     */
    protected function loadRemoteOptions($url, $parameters = [], $options = [])

    {
        $ajaxOptions = [
            'url' => $url.'?'.http_build_query($parameters),
        ];

        $ajaxOptions = json_encode(array_merge($ajaxOptions, $options));

        $this->script = <<<EOT

$.ajax($ajaxOptions).done(function(data) {
  $("{$this->getElementClassSelector()}").select2({data: data});
});

EOT;

        return $this;
    }

    /**
     * Load options from ajax results.
     *
     * @param string $url
     * @param $idField
     * @param $textField
     *
     * @return $this
     */
    public function ajax($url, $idField = 'id', $textField = 'text')
    {
        $configs = array_merge([
            'allowClear'         => true,
            'placeholder'        => $this->label,
            'minimumInputLength' => 1,
        ], $this->config);

        $configs = json_encode($configs);
        $configs = substr($configs, 1, strlen($configs) - 2);

        $this->script = <<<EOT

$("{$this->getElementClassSelector()}").select2({
  ajax: {
    url: "$url",
    dataType: 'json',
    delay: 250,
    data: function (params) {
      return {
        q: params.term,
        page: params.page
      };
    },
    processResults: function (data, params) {
      params.page = params.page || 1;

      return {
        results: $.map(data.data, function (d) {
                   d.id = d.$idField;
                   d.text = d.$textField;
                   return d;
                }),
        pagination: {
          more: data.next_page_url
        }
      };
    },
    cache: true
  },
  $configs,
  escapeMarkup: function (markup) {
      return markup;
  }
});

EOT;

        return $this;
    }

    /**
     * Set config for select2.
     *
     * all configurations see https://select2.org/configuration/options-api
     *
     * @param string $key
     * @param mixed  $val
     *
     * @return $this
     */
    public function config($key, $val)
    {
        $this->config[$key] = $val;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function render()
    {
        $configs = array_merge([
            'allowClear'  => true,
            'placeholder' => $this->label,
        ], $this->config);

        $configs = json_encode($configs);

        if (empty($this->script)) {
            $this->script = "$(\"{$this->getElementClassSelector()}\").select2($configs);";
        }

        if ($this->options instanceof \Closure) {
            if ($this->form) {
                $this->options = $this->options->bindTo($this->form->model());
            }

            $this->options(call_user_func($this->options, $this->value));
        }

        $this->options = array_filter($this->options, 'strlen');

        $this->addVariables([
            'options' => $this->options,
            'groups'  => $this->groups,
        ]);

        return parent::render();

    }
}


Pull Request — master (#2317)

Select A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

How to fix Duplicated Code

Duplicated Code

Change not visible in outer-scope

Change visible in outer-scope

1		<?php
2
3		namespace Encore\Admin\Form\Field;
4
5		use Encore\Admin\Facades\Admin;
6		use Encore\Admin\Form\Field;
7		use Illuminate\Contracts\Support\Arrayable;
8		use Illuminate\Support\Str;
9
10		class Select extends Field
11		{
12		/**
13		* @var array
14		*/
15		protected static $css = [
16		'/vendor/laravel-admin/AdminLTE/plugins/select2/select2.min.css',
17		];
18
19		/**
20		* @var array
21		*/
22		protected static $js = [
23		'/vendor/laravel-admin/AdminLTE/plugins/select2/select2.full.min.js',
24		];
25
26		/**
27		* @var array
28		*/
29		protected $groups = [];
30
31		/**
32		* @var array
33		*/
34		protected $config = [];
35
36		/**
37		* Set options.
38		*
39		* @param array\|callable\|string $options
40		*
41		* @return $this\|mixed
42		*/
43		public function options($options = [])
44		{
45		// remote options
46		if (is_string($options)) {
47		// reload selected
48		if (class_exists($options) && in_array('Illuminate\Database\Eloquent\Model', class_parents($options))) {
49		return $this->selected(...func_get_args());
		0 ignored issues – show Documentation introduced 2018-08-15 16:57 UTC by Report Bug Copy Issue Report `func_get_args()` is of type `array`, but the function expects a `object<Encore\Admin\Form...atabase\Eloquent\Model>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
50		}
51
52		return $this->loadRemoteOptions(...func_get_args());
		0 ignored issues – show Documentation introduced 2017-12-12 02:16 UTC by Report Bug Copy Issue Report `func_get_args()` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
53		}
54
55		if ($options instanceof Arrayable) {
56		$options = $options->toArray();
57		}
58
59		if (is_callable($options)) {
60		$this->options = $options;
		0 ignored issues – show Documentation Bug introduced 2016-10-27 10:11 UTC by Report Bug Copy Issue Report It seems like `$options` of type `callable` is incompatible with the declared type `array` of property `$options`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
61		} else {
62		$this->options = (array) $options;
63		}
64
65		return $this;
66		}
67
68		/**
69		* @param array $groups
70		*/
71
72		/**
73		* Set option groups.
74		*
75		* eg: $group = [
76		* [
77		* 'label' => 'xxxx',
78		* 'options' => [
79		* 1 => 'foo',
80		* 2 => 'bar',
81		* ...
82		* ],
83		* ...
84		* ]
85		*
86		* @param array $groups
87		*
88		* @return $this
89		*/
90		public function groups(array $groups)
91		{
92		$this->groups = $groups;
93
94		return $this;
95		}
96
97		/**
98		* Load options for other select on change.
99		*
100		* @param string $field
101		* @param string $sourceUrl
102		* @param string $idField
103		* @param string $textField
104		*
105		* @return $this
106		*/
107		public function load($field, $sourceUrl, $idField = 'id', $textField = 'text')
108		{
109		if (Str::contains($field, '.')) {
110		$field = $this->formatName($field);
111		$class = str_replace(['[', ']'], '_', $field);
112		} else {
113		$class = $field;
114		}
115
116		$script = <<<EOT
117		$(document).off('change', "{$this->getElementClassSelector()}");
118		$(document).on('change', "{$this->getElementClassSelector()}", function () {
119		var target = $(this).closest('.fields-group').find(".$class");
120		$.get("$sourceUrl?q="+this.value, function (data) {
121		target.find("option").remove();
122		$(target).select2({
123		data: $.map(data, function (d) {
124		d.id = d.$idField;
125		d.text = d.$textField;
126		return d;
127		})
128		}).trigger('change');
129		});
130		});
131		EOT;
132
133		Admin::script($script);
134
135		return $this;
136		}
137
138		/**
139		* Load options for other selects on change.
140		*
141		* @param string $fields
142		* @param string $sourceUrls
143		* @param string $idField
144		* @param string $textField
145		*
146		* @return $this
147		*/
148		public function loads($fields = [], $sourceUrls = [], $idField = 'id', $textField = 'text')
149		{
150		$fieldsStr = implode('.', $fields);
151		$urlsStr = implode('^', $sourceUrls);
152		$script = <<<EOT
153		var fields = '$fieldsStr'.split('.');
154		var urls = '$urlsStr'.split('^');
155
156		var refreshOptions = function(url, target) {
157		$.get(url).then(function(data) {
158		target.find("option").remove();
159		$(target).select2({
160		data: $.map(data, function (d) {
161		d.id = d.$idField;
162		d.text = d.$textField;
163		return d;
164		})
165		}).trigger('change');
166		});
167		};
168
169		$(document).off('change', "{$this->getElementClassSelector()}");
170		$(document).on('change', "{$this->getElementClassSelector()}", function () {
171		var _this = this;
172		var promises = [];
173
174		fields.forEach(function(field, index){
175		var target = $(_this).closest('.fields-group').find('.' + fields[index]);
176		promises.push(refreshOptions(urls[index] + "?q="+ _this.value, target));
177		});
178
179		$.when(promises).then(function() {
180		console.log('开始更新其它select的选择options');
181		});
182		});
183		EOT;
184
185		Admin::script($script);
186
187		return $this;
188		}
189
190		/**
191		* Load options from current selected resource(s).
192		*
193		* @param Illuminate\Database\Eloquent\Model $model
194		* @param string $textField
195		* @param string $idField
196		*
197		* @return $this
198		*/
199		protected function selected($model, $textField = 'name', $idField = 'id')
200		{
201		$this->options = function ($resource) use ($model, $textField, $idField) {
		0 ignored issues – show Documentation Bug introduced 2018-08-15 17:00 UTC by Report Bug Copy Issue Report It seems like `function ($resource) use...} return array(); }` of type `object<Closure>` is incompatible with the declared type `array` of property `$options`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
202		if (null == $resource) {
203		return [];
204		}
205
206		if (is_array($resource) && !empty($resource) && isset($resource[0]['id'])) {
207		$resource = array_map(function ($res) {
208		return $res['id'];
209		}, $resource);
210		} elseif (is_array($resource) && !empty($resource) && isset($resource['id'])) {
211		$resource = $resource['id'];
212		}
213
214		$model = $model::find($resource);
		0 ignored issues – show Bug introduced 2018-08-15 16:57 UTC by Report Bug Copy Issue Report Consider using a different name than the imported variable `$model`, or did you forget to import by reference? It seems like you are assigning to a variable which was imported through a `use` statement which was not imported by reference. For clarity, we suggest to use a different name or import by reference depending on whether you would like to have the change visibile in outer-scope. Change not visible in outer-scope $x = 1; $callable = function() use ($x) { $x = 2; // Not visible in outer scope. If you would like this, how // about using a different variable name than $x? }; $callable(); var_dump($x); // integer(1) Change visible in outer-scope $x = 1; $callable = function() use (&$x) { $x = 2; }; $callable(); var_dump($x); // integer(2) Loading history...
215
216		if ($model) {
217		if ($model instanceof \Illuminate\Support\Collection) {
218		$results = [];
219
220		foreach ($model as $result) {
221		$results[$result->{$idField}] = $result->{$textField};
222		}
223
224		return $results;
225		}
226
227		return [$model->{$idField} => $model->{$textField}];
228		}
229
230		return [];
231		};
232
233		return $this;
234		}
235
236		/**
237		* Load options from remote.
238		*
239		* @param string $url
240		* @param array $parameters
241		* @param array $options
242		*
243		* @return $this
244		*/
245	View Code Duplication	protected function loadRemoteOptions($url, $parameters = [], $options = [])
		0 ignored issues – show Duplication introduced 2017-12-12 02:16 UTC by Report Bug Copy Issue Report 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...
246		{
247		$ajaxOptions = [
248		'url' => $url.'?'.http_build_query($parameters),
249		];
250
251		$ajaxOptions = json_encode(array_merge($ajaxOptions, $options));
252
253		$this->script = <<<EOT
254
255		$.ajax($ajaxOptions).done(function(data) {
256		$("{$this->getElementClassSelector()}").select2({data: data});
257		});
258
259		EOT;
260
261		return $this;
262		}
263
264		/**
265		* Load options from ajax results.
266		*
267		* @param string $url
268		* @param $idField
269		* @param $textField
270		*
271		* @return $this
272		*/
273		public function ajax($url, $idField = 'id', $textField = 'text')
274		{
275		$configs = array_merge([
276		'allowClear' => true,
277		'placeholder' => $this->label,
278		'minimumInputLength' => 1,
279		], $this->config);
280
281		$configs = json_encode($configs);
282		$configs = substr($configs, 1, strlen($configs) - 2);
283
284		$this->script = <<<EOT
285
286		$("{$this->getElementClassSelector()}").select2({
287		ajax: {
288		url: "$url",
289		dataType: 'json',
290		delay: 250,
291		data: function (params) {
292		return {
293		q: params.term,
294		page: params.page
295		};
296		},
297		processResults: function (data, params) {
298		params.page = params.page \|\| 1;
299
300		return {
301		results: $.map(data.data, function (d) {
302		d.id = d.$idField;
303		d.text = d.$textField;
304		return d;
305		}),
306		pagination: {
307		more: data.next_page_url
308		}
309		};
310		},
311		cache: true
312		},
313		$configs,
314		escapeMarkup: function (markup) {
315		return markup;
316		}
317		});
318
319		EOT;
320
321		return $this;
322		}
323
324		/**
325		* Set config for select2.
326		*
327		* all configurations see https://select2.org/configuration/options-api
328		*
329		* @param string $key
330		* @param mixed $val
331		*
332		* @return $this
333		*/
334		public function config($key, $val)
335		{
336		$this->config[$key] = $val;
337
338		return $this;
339		}
340
341		/**
342		* {@inheritdoc}
343		*/
344		public function render()
345		{
346		$configs = array_merge([
347		'allowClear' => true,
348		'placeholder' => $this->label,
349		], $this->config);
350
351		$configs = json_encode($configs);
352
353		if (empty($this->script)) {
354		$this->script = "$(\"{$this->getElementClassSelector()}\").select2($configs);";
355		}
356
357		if ($this->options instanceof \Closure) {
358		if ($this->form) {
359		$this->options = $this->options->bindTo($this->form->model());
360		}
361
362		$this->options(call_user_func($this->options, $this->value));
363		}
364
365		$this->options = array_filter($this->options, 'strlen');
366
367		$this->addVariables([
368		'options' => $this->options,
369		'groups' => $this->groups,
370		]);
371
372		return parent::render();
		0 ignored issues – show Bug Compatibility introduced 2018-06-06 13:22 UTC by Report Bug Copy Issue Report The expression `parent::render();` of type `string\|Illuminate\View\V...\Contracts\View\Factory` adds the type `Illuminate\Contracts\View\Factory` to the return on line 372 which is incompatible with the return type declared by the interface `Illuminate\Contracts\Support\Renderable::render` of type `string`. Loading history...
373		}
374		}
375

z-song / laravel-admin

Pull Request — master (#2317)

Select A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

9 Methods

How to fix Duplicated Code

Duplicated Code

Change not visible in outer-scope

Change visible in outer-scope

Duplication Side-by-Side

Filter issues like