Select::ajax() - Code Metrics - Inspection of "Merge pull request #1689 from zhanyulong/master" - z-song/laravel-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0b3050...83401a )

by Song

created 2018-04-02 01:51 UTC

Select::ajax() B

↳ Parent: Select

Complexity

Conditions	1
Paths	1

Size

Total Lines	41
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	9
nc	1
nop	3
dl	0
loc	41
rs	8.8571
c	0
b	0
f	0

<?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)) {
            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 = join(".", $fields);
        $urlsStr = join("^", $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 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')
    {
        $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
  },
  minimumInputLength: 1,
  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);

        return parent::render()->with([
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.
}
            'options' => $this->options,
            'groups'  => $this->groups,
        ]);
    }
}


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		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...
48		}
49
50		if ($options instanceof Arrayable) {
51		$options = $options->toArray();
52		}
53
54		if (is_callable($options)) {
55		$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...
56		} else {
57		$this->options = (array) $options;
58		}
59
60		return $this;
61		}
62
63		/**
64		* @param array $groups
65		*/
66
67		/**
68		* Set option groups.
69		*
70		* eg: $group = [
71		* [
72		* 'label' => 'xxxx',
73		* 'options' => [
74		* 1 => 'foo',
75		* 2 => 'bar',
76		* ...
77		* ],
78		* ...
79		* ]
80		*
81		* @param array $groups
82		*
83		* @return $this
84		*/
85		public function groups(array $groups)
86		{
87		$this->groups = $groups;
88
89		return $this;
90		}
91
92		/**
93		* Load options for other select on change.
94		*
95		* @param string $field
96		* @param string $sourceUrl
97		* @param string $idField
98		* @param string $textField
99		*
100		* @return $this
101		*/
102		public function load($field, $sourceUrl, $idField = 'id', $textField = 'text')
103		{
104		if (Str::contains($field, '.')) {
105		$field = $this->formatName($field);
106		$class = str_replace(['[', ']'], '_', $field);
107		} else {
108		$class = $field;
109		}
110
111		$script = <<<EOT
112		$(document).off('change', "{$this->getElementClassSelector()}");
113		$(document).on('change', "{$this->getElementClassSelector()}", function () {
114		var target = $(this).closest('.fields-group').find(".$class");
115		$.get("$sourceUrl?q="+this.value, function (data) {
116		target.find("option").remove();
117		$(target).select2({
118		data: $.map(data, function (d) {
119		d.id = d.$idField;
120		d.text = d.$textField;
121		return d;
122		})
123		}).trigger('change');
124		});
125		});
126		EOT;
127
128		Admin::script($script);
129
130		return $this;
131		}
132
133		/**
134		* Load options for other selects on change.
135		*
136		* @param string $fields
137		* @param string $sourceUrls
138		* @param string $idField
139		* @param string $textField
140		*
141		* @return $this
142		*/
143		public function loads($fields = [], $sourceUrls = [] , $idField = 'id', $textField = 'text')
144		{
145		$fieldsStr = join(".", $fields);
146		$urlsStr = join("^", $sourceUrls);
147		$script = <<<EOT
148		var fields = '$fieldsStr'.split('.');
149		var urls = '$urlsStr'.split('^');
150
151		var refreshOptions = function(url, target) {
152		$.get(url).then(function(data) {
153		target.find("option").remove();
154		$(target).select2({
155		data: $.map(data, function (d) {
156		d.id = d.$idField;
157		d.text = d.$textField;
158		return d;
159		})
160		}).trigger('change');
161		});
162		};
163
164		$(document).off('change', "{$this->getElementClassSelector()}");
165		$(document).on('change', "{$this->getElementClassSelector()}", function () {
166		var _this = this;
167		var promises = [];
168
169		fields.forEach(function(field, index){
170		var target = $(_this).closest('.fields-group').find('.' + fields[index]);
171		promises.push(refreshOptions(urls[index] + "?q="+ _this.value, target));
172		});
173
174		$.when(promises).then(function() {
175		console.log('开始更新其它select的选择options');
176		});
177		});
178		EOT;
179
180		Admin::script($script);
181
182		return $this;
183		}
184
185		/**
186		* Load options from remote.
187		*
188		* @param string $url
189		* @param array $parameters
190		* @param array $options
191		*
192		* @return $this
193		*/
194	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...
195		{
196		$ajaxOptions = [
197		'url' => $url.'?'.http_build_query($parameters),
198		];
199
200		$ajaxOptions = json_encode(array_merge($ajaxOptions, $options));
201
202		$this->script = <<<EOT
203
204		$.ajax($ajaxOptions).done(function(data) {
205		$("{$this->getElementClassSelector()}").select2({data: data});
206		});
207
208		EOT;
209
210		return $this;
211		}
212
213		/**
214		* Load options from ajax results.
215		*
216		* @param string $url
217		* @param $idField
218		* @param $textField
219		*
220		* @return $this
221		*/
222		public function ajax($url, $idField = 'id', $textField = 'text')
223		{
224		$this->script = <<<EOT
225
226		$("{$this->getElementClassSelector()}").select2({
227		ajax: {
228		url: "$url",
229		dataType: 'json',
230		delay: 250,
231		data: function (params) {
232		return {
233		q: params.term,
234		page: params.page
235		};
236		},
237		processResults: function (data, params) {
238		params.page = params.page \|\| 1;
239
240		return {
241		results: $.map(data.data, function (d) {
242		d.id = d.$idField;
243		d.text = d.$textField;
244		return d;
245		}),
246		pagination: {
247		more: data.next_page_url
248		}
249		};
250		},
251		cache: true
252		},
253		minimumInputLength: 1,
254		escapeMarkup: function (markup) {
255		return markup;
256		}
257		});
258
259		EOT;
260
261		return $this;
262		}
263
264		/**
265		* Set config for select2.
266		*
267		* all configurations see https://select2.org/configuration/options-api
268		*
269		* @param string $key
270		* @param mixed $val
271		*
272		* @return $this
273		*/
274		public function config($key, $val)
275		{
276		$this->config[$key] = $val;
277
278		return $this;
279		}
280
281		/**
282		* {@inheritdoc}
283		*/
284		public function render()
285		{
286		$configs = array_merge([
287		'allowClear' => true,
288		'placeholder' => $this->label,
289		], $this->config);
290
291		$configs = json_encode($configs);
292
293		if (empty($this->script)) {
294		$this->script = "$(\"{$this->getElementClassSelector()}\").select2($configs);";
295		}
296
297		if ($this->options instanceof \Closure) {
298		if ($this->form) {
299		$this->options = $this->options->bindTo($this->form->model());
300		}
301
302		$this->options(call_user_func($this->options, $this->value));
303		}
304
305		$this->options = array_filter($this->options);
306
307		return parent::render()->with([
		0 ignored issues – show Bug introduced 2017-12-12 02:16 UTC by Report Bug Copy Issue Report 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 Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
308		'options' => $this->options,
309		'groups' => $this->groups,
310		]);
311		}
312		}
313

z-song / laravel-admin

Push — master ( 0b3050...83401a )

Select::ajax() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like