Select::loadOptionsFromRemote() - Code Metrics - Inspection of "some useful future my Commits on Oct 24, 2017" - z-song/laravel-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1350)

unknown

created 2017-10-24 14:59 UTC

Select::loadOptionsFromRemote() A

↳ Parent: Select

Complexity

Conditions	1
Paths	1

Size

Total Lines	22
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	12
nc	1
nop	3
dl	0
loc	22
rs	9.2
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
{

    protected $direction = "ltr";

    protected static $css = [
        '/vendor/laravel-admin/AdminLTE/plugins/select2/select2.min.css',
    ];

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

    public function render()
    {
        if (empty($this->script)) {
            $this->script = <<<EOF
$("{$this->getElementClassSelector()}").select2({
    dir: "$this->direction",
    language : "$this->local",
    allowClear: true,
    placeholder: "{$this->label}"
});
EOF;
        }

        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(['options' => $this->options]);
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.
}
    }

    /**
     * Set options.
     *
     * @param array|callable|string $options
     *
     * @return $this|mixed
     */
    public function options($options = [])
    {
        // remote options
        if (is_string($options)) {
            return call_user_func_array([
                $this,
                'loadOptionsFromRemote'
            ], func_get_args());
        }

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

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

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

        return $this;
    }

    /**
     * Set direction setting of select2.
     *
     */
    public function dir($dir = 'ltr')
    {
        $this->direction = $dir;

        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).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({
            dir: "$this->direction",
            language : "$this->local",
            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 from remote.
     *
     * @param string $url
     * @param array  $parameters
     * @param array  $options
     *
     * @return $this
     */
    protected function loadOptionsFromRemote($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({
      dir: "$this->direction",
      language : "$this->local",
      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({
  dir: "$this->direction",
  language : "$this->local",
  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;
    }
}


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		protected $direction = "ltr";
14
15		protected static $css = [
16		'/vendor/laravel-admin/AdminLTE/plugins/select2/select2.min.css',
17		];
18
19		protected static $js = [
20		'/vendor/laravel-admin/AdminLTE/plugins/select2/select2.full.min.js',
21		];
22
23		public function render()
24		{
25		if (empty($this->script)) {
26		$this->script = <<<EOF
27		$("{$this->getElementClassSelector()}").select2({
28		dir: "$this->direction",
29		language : "$this->local",
30		allowClear: true,
31		placeholder: "{$this->label}"
32		});
33		EOF;
34		}
35
36		if ($this->options instanceof \Closure) {
37		if ($this->form) {
38		$this->options = $this->options->bindTo($this->form->model());
39		}
40
41		$this->options(call_user_func($this->options, $this->value));
42		}
43
44		$this->options = array_filter($this->options);
45
46		return parent::render()->with(['options' => $this->options]);
		0 ignored issues – show Bug introduced 2016-08-05 10:29 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...
47		}
48
49		/**
50		* Set options.
51		*
52		* @param array\|callable\|string $options
53		*
54		* @return $this\|mixed
55		*/
56		public function options($options = [])
57		{
58		// remote options
59		if (is_string($options)) {
60		return call_user_func_array([
61		$this,
62		'loadOptionsFromRemote'
63		], func_get_args());
64		}
65
66		if ($options instanceof Arrayable) {
67		$options = $options->toArray();
68		}
69
70		if (is_callable($options)) {
71		$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...
72		} else {
73		$this->options = (array)$options;
74		}
75
76		return $this;
77		}
78
79		/**
80		* Set direction setting of select2.
81		*
82		*/
83		public function dir($dir = 'ltr')
84		{
85		$this->direction = $dir;
86
87		return $this;
88		}
89
90		/**
91		* Load options for other select on change.
92		*
93		* @param string $field
94		* @param string $sourceUrl
95		* @param string $idField
96		* @param string $textField
97		*
98		* @return $this
99		*/
100		public function load($field, $sourceUrl, $idField = 'id', $textField = 'text')
101		{
102		if (Str::contains($field, '.')) {
103		$field = $this->formatName($field);
104		$class = str_replace([
105		'[',
106		']'
107		], '_', $field);
108		} else {
109		$class = $field;
110		}
111
112		$script = <<<EOT
113
114		$(document).on('change', "{$this->getElementClassSelector()}", function () {
115		var target = $(this).closest('.fields-group').find(".$class");
116		$.get("$sourceUrl?q="+this.value, function (data) {
117		target.find("option").remove();
118		$(target).select2({
119		dir: "$this->direction",
120		language : "$this->local",
121		data: $.map(data, function (d) {
122		d.id = d.$idField;
123		d.text = d.$textField;
124		return d;
125		})
126		}).trigger('change');
127		});
128		});
129		EOT;
130
131		Admin::script($script);
132
133		return $this;
134		}
135
136		/**
137		* Load options from remote.
138		*
139		* @param string $url
140		* @param array $parameters
141		* @param array $options
142		*
143		* @return $this
144		*/
145		protected function loadOptionsFromRemote($url, $parameters = [], $options = [])
146		{
147		$ajaxOptions = [
148		'url' => $url . '?' . http_build_query($parameters),
149		];
150
151		$ajaxOptions = json_encode(array_merge($ajaxOptions, $options));
152
153		$this->script = <<<EOT
154
155		$.ajax($ajaxOptions).done(function(data) {
156		$("{$this->getElementClassSelector()}").select2({
157		dir: "$this->direction",
158		language : "$this->local",
159		data: data
160		});
161		});
162
163		EOT;
164
165		return $this;
166		}
167
168		/**
169		* Load options from ajax results.
170		*
171		* @param string $url
172		* @param $idField
173		* @param $textField
174		*
175		* @return $this
176		*/
177	View Code Duplication	public function ajax($url, $idField = 'id', $textField = 'text')
		0 ignored issues – show Duplication introduced 2017-10-24 15:02 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...
178		{
179		$this->script = <<<EOT
180
181		$("{$this->getElementClassSelector()}").select2({
182		dir: "$this->direction",
183		language : "$this->local",
184		ajax: {
185		url: "$url",
186		dataType: 'json',
187		delay: 250,
188		data: function (params) {
189		return {
190		q: params.term,
191		page: params.page
192		};
193		},
194		processResults: function (data, params) {
195		params.page = params.page \|\| 1;
196
197		return {
198		results: $.map(data.data, function (d) {
199		d.id = d.$idField;
200		d.text = d.$textField;
201		return d;
202		}),
203		pagination: {
204		more: data.next_page_url
205		}
206		};
207		},
208		cache: true
209		},
210		minimumInputLength: 1,
211		escapeMarkup: function (markup) {
212		return markup;
213		}
214		});
215
216		EOT;
217
218		return $this;
219		}
220		}
221

z-song / laravel-admin

Pull Request — master (#1350)

Select::loadOptionsFromRemote() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like