Editor::formOptions() - Code Metrics - Inspection of "Bump v4.19.0 :rocket:" - yajra/laravel-datatables-html - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 665657...f9a7bb )

by Arjay

created 2019-09-25 06:59 UTC

Editor::formOptions() A

↳ Parent: Editor

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace Yajra\DataTables\Html\Editor;

use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use Illuminate\Support\Fluent;
use Yajra\DataTables\Utilities\Helper;
use Yajra\DataTables\Html\Editor\Fields\Field;

class Editor extends Fluent
{
    use HasEvents;
    const DISPLAY_LIGHTBOX   = 'lightbox';
    const DISPLAY_ENVELOPE   = 'envelope';
    const DISPLAY_BOOTSTRAP  = 'bootstrap';
    const DISPLAY_FOUNDATION = 'foundation';
    const DISPLAY_JQUERYUI   = 'jqueryui';

    /**
     * Editor constructor.
     *
     * @param string $instance
     */
    public function __construct($instance = 'editor')
    {
        $attributes['instance'] = $instance;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        parent::__construct($attributes);
    }

    /**
     * Make new Editor instance.
     *
     * @param string $instance
     * @return Editor
     */
    public static function make($instance = 'editor')
    {
        return new static($instance);
    }

    /**
     * Append raw scripts.
     *
     * @param string $scripts
     * @return Editor
     */
    public function scripts($scripts)
    {
        $this->attributes['scripts'] = $scripts;

        return $this;
    }

    /**
     * Set Editor's variable name / instance.
     *
     * @param $instance
     * @return $this
     */
    public function instance($instance)
    {
        $this->attributes['instance'] = $instance;

        return $this;
    }

    /**
     * Set Editor's ajax parameter.
     *
     * @param string|array $ajax
     * @return $this
     * @see https://editor.datatables.net/reference/option/ajax
     */
    public function ajax($ajax)
    {
        $this->attributes['ajax'] = $ajax;

        return $this;
    }

    /**
     * Set Editor's table source.
     *
     * @param string $table
     * @return $this
     * @see https://editor.datatables.net/reference/option/table
     */
    public function table($table)
    {
        $this->attributes['table'] = $table;

        return $this;
    }

    /**
     * Set Editor's idSrc option.
     *
     * @param string $idSrc
     * @return $this
     * @see https://editor.datatables.net/reference/option/idSrc
     */
    public function idSrc($idSrc = 'DT_RowId')
    {
        $this->attributes['idSrc'] = $idSrc;

        return $this;
    }

    /**
     * Set Editor's display option.
     *
     * @param string $display
     * @return $this
     * @see https://editor.datatables.net/reference/option/display
     */
    public function display($display)
    {
        $this->attributes['display'] = $display;

        return $this;
    }

    /**
     * Set Editor's fields.
     *
     * @param array $fields
     * @return $this
     * @see https://editor.datatables.net/reference/option/fields
     */
    public function fields(array $fields)
    {
        $this->attributes['fields'] = $fields;

        return $this;
    }

    /**
     * Set Editor's formOptions.
     *
     * @param mixed $formOptions
     * @return $this
     * @see https://editor.datatables.net/reference/option/formOptions
     * @see https://editor.datatables.net/reference/type/form-options
     */
    public function formOptions(array $formOptions)
    {
        $this->attributes['formOptions'] = $formOptions;

        return $this;
    }

    /**
     * Set Editor's bubble formOptions.
     *
     * @param mixed $formOptions
     * @return $this
     * @see https://editor.datatables.net/reference/option/formOptions.bubble
     */
    public function formOptionsBubble(array $formOptions)
    {
        $this->attributes['formOptions']['bubble'] = Helper::castToArray($formOptions);;

        return $this;
    }

    /**
     * Set Editor's inline formOptions.
     *
     * @param mixed $formOptions
     * @return $this
     * @see https://editor.datatables.net/reference/option/formOptions.inline
     */
    public function formOptionsInline($formOptions)
    {
        $this->attributes['formOptions']['inline'] = Helper::castToArray($formOptions);

        return $this;
    }

    /**
     * Set Editor's main formOptions.
     *
     * @param mixed $formOptions
     * @return $this
     * @see https://editor.datatables.net/reference/option/formOptions.main
     */
    public function formOptionsMain($formOptions)
    {
        $this->attributes['formOptions']['main'] = Helper::castToArray($formOptions);

        return $this;
    }

    /**
     * Set Editor's language.
     *
     * @param array $language
     * @return $this
     * @see https://editor.datatables.net/reference/option/i18n
     */
    public function language(array $language)
    {
        $this->attributes['i18n'] = $language;

        return $this;
    }

    /**
     * Set Editor's template.
     *
     * @param string $template
     * @return $this
     * @see https://editor.datatables.net/reference/option/template
     */
    public function template($template)
    {
        $this->attributes['template'] = $template;

        return $this;
    }

    /**
     * Convert the fluent instance to an array.
     *
     * @return array
     */
    public function toArray()
    {
        $array = parent::toArray();

        unset($array['events']);

        foreach (Arr::get($array, 'fields', []) as $key => &$field) {
foreach ($array as &$itemValue) { }
            if ($field instanceof Field) {
                Arr::set($array['fields'], $key, $field->toArray());
            }
        }

        return $array;
    }

    /**
     * Convert the fluent instance to JSON.
     *
     * @param int $options
     * @return string
     */
    public function toJson($options = 0)
    {
        $parameters = $this->jsonSerialize();

        unset($parameters['events']);

        $values       = [];
        $replacements = [];

        foreach (Arr::dot($parameters) as $key => $value) {
            if ($key === 'table') {
                Arr::set($parameters, $key, '#' . $value);
            }

            if ($this->isCallbackFunction($value, $key)) {

                $values[] = trim($value);
                Arr::set($parameters, $key, '%' . $key . '%');
                $replacements[] = '"%' . $key . '%"';
            }
        }

        $new = [];
        foreach ($parameters as $key => $value) {
            Arr::set($new, $key, $value);
        }

        $json = json_encode($new, $options);

        $json = str_replace($replacements, $values, $json);

        return $json;
    }

    /**
     * Check if given key & value is a valid callback js function.
     *
     * @param string $value
     * @param string $key
     * @return bool
     */
    protected function isCallbackFunction($value, $key)
    {
        if (empty($value) || is_object($value) || is_array($value)) {
            return false;
        }

        $callbacks = config('datatables-html.callback', ['$', '$.', 'function']);

        return Str::startsWith(trim($value), $callbacks) || Str::contains($key, ['editor', 'minDate', 'maxDate']);
    }
}


Push — master ( 665657...f9a7bb )

Editor::formOptions() A

Complexity

Size

Duplication

Importance

Available Fixes

1. Do not assign by reference

2. Assign to a local variable first

3. Return a reference

1		<?php
2
3		namespace Yajra\DataTables\Html\Editor;
4
5		use Illuminate\Support\Arr;
6		use Illuminate\Support\Str;
7		use Illuminate\Support\Fluent;
8		use Yajra\DataTables\Utilities\Helper;
9		use Yajra\DataTables\Html\Editor\Fields\Field;
10
11		class Editor extends Fluent
12		{
13		use HasEvents;
14		const DISPLAY_LIGHTBOX = 'lightbox';
15		const DISPLAY_ENVELOPE = 'envelope';
16		const DISPLAY_BOOTSTRAP = 'bootstrap';
17		const DISPLAY_FOUNDATION = 'foundation';
18		const DISPLAY_JQUERYUI = 'jqueryui';
19
20		/**
21		* Editor constructor.
22		*
23		* @param string $instance
24		*/
25		public function __construct($instance = 'editor')
26		{
27		$attributes['instance'] = $instance;
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-11-16 03:50 UTC by Report Bug Copy Issue Report `$attributes` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$attributes = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
28
29		parent::__construct($attributes);
30		}
31
32		/**
33		* Make new Editor instance.
34		*
35		* @param string $instance
36		* @return Editor
37		*/
38		public static function make($instance = 'editor')
39		{
40		return new static($instance);
41		}
42
43		/**
44		* Append raw scripts.
45		*
46		* @param string $scripts
47		* @return Editor
48		*/
49		public function scripts($scripts)
50		{
51		$this->attributes['scripts'] = $scripts;
52
53		return $this;
54		}
55
56		/**
57		* Set Editor's variable name / instance.
58		*
59		* @param $instance
60		* @return $this
61		*/
62		public function instance($instance)
63		{
64		$this->attributes['instance'] = $instance;
65
66		return $this;
67		}
68
69		/**
70		* Set Editor's ajax parameter.
71		*
72		* @param string\|array $ajax
73		* @return $this
74		* @see https://editor.datatables.net/reference/option/ajax
75		*/
76		public function ajax($ajax)
77		{
78		$this->attributes['ajax'] = $ajax;
79
80		return $this;
81		}
82
83		/**
84		* Set Editor's table source.
85		*
86		* @param string $table
87		* @return $this
88		* @see https://editor.datatables.net/reference/option/table
89		*/
90		public function table($table)
91		{
92		$this->attributes['table'] = $table;
93
94		return $this;
95		}
96
97		/**
98		* Set Editor's idSrc option.
99		*
100		* @param string $idSrc
101		* @return $this
102		* @see https://editor.datatables.net/reference/option/idSrc
103		*/
104		public function idSrc($idSrc = 'DT_RowId')
105		{
106		$this->attributes['idSrc'] = $idSrc;
107
108		return $this;
109		}
110
111		/**
112		* Set Editor's display option.
113		*
114		* @param string $display
115		* @return $this
116		* @see https://editor.datatables.net/reference/option/display
117		*/
118		public function display($display)
119		{
120		$this->attributes['display'] = $display;
121
122		return $this;
123		}
124
125		/**
126		* Set Editor's fields.
127		*
128		* @param array $fields
129		* @return $this
130		* @see https://editor.datatables.net/reference/option/fields
131		*/
132		public function fields(array $fields)
133		{
134		$this->attributes['fields'] = $fields;
135
136		return $this;
137		}
138
139		/**
140		* Set Editor's formOptions.
141		*
142		* @param mixed $formOptions
143		* @return $this
144		* @see https://editor.datatables.net/reference/option/formOptions
145		* @see https://editor.datatables.net/reference/type/form-options
146		*/
147		public function formOptions(array $formOptions)
148		{
149		$this->attributes['formOptions'] = $formOptions;
150
151		return $this;
152		}
153
154		/**
155		* Set Editor's bubble formOptions.
156		*
157		* @param mixed $formOptions
158		* @return $this
159		* @see https://editor.datatables.net/reference/option/formOptions.bubble
160		*/
161		public function formOptionsBubble(array $formOptions)
162		{
163		$this->attributes['formOptions']['bubble'] = Helper::castToArray($formOptions);;
164
165		return $this;
166		}
167
168		/**
169		* Set Editor's inline formOptions.
170		*
171		* @param mixed $formOptions
172		* @return $this
173		* @see https://editor.datatables.net/reference/option/formOptions.inline
174		*/
175		public function formOptionsInline($formOptions)
176		{
177		$this->attributes['formOptions']['inline'] = Helper::castToArray($formOptions);
178
179		return $this;
180		}
181
182		/**
183		* Set Editor's main formOptions.
184		*
185		* @param mixed $formOptions
186		* @return $this
187		* @see https://editor.datatables.net/reference/option/formOptions.main
188		*/
189		public function formOptionsMain($formOptions)
190		{
191		$this->attributes['formOptions']['main'] = Helper::castToArray($formOptions);
192
193		return $this;
194		}
195
196		/**
197		* Set Editor's language.
198		*
199		* @param array $language
200		* @return $this
201		* @see https://editor.datatables.net/reference/option/i18n
202		*/
203		public function language(array $language)
204		{
205		$this->attributes['i18n'] = $language;
206
207		return $this;
208		}
209
210		/**
211		* Set Editor's template.
212		*
213		* @param string $template
214		* @return $this
215		* @see https://editor.datatables.net/reference/option/template
216		*/
217		public function template($template)
218		{
219		$this->attributes['template'] = $template;
220
221		return $this;
222		}
223
224		/**
225		* Convert the fluent instance to an array.
226		*
227		* @return array
228		*/
229		public function toArray()
230		{
231		$array = parent::toArray();
232
233		unset($array['events']);
234
235		foreach (Arr::get($array, 'fields', []) as $key => &$field) {
		0 ignored issues – show Bug introduced 2019-08-17 06:20 UTC by Report Bug Copy Issue Report The expression `\Illuminate\Support\Arr:...ray, 'fields', array())` cannot be used as a reference. Let?s assume that you have the following `foreach` statement: foreach ($array as &$itemValue) { } `$itemValue` is assigned by reference. This is possible because the expression (in the example `$array`) can be used as a reference target. However, if we were to replace `$array` with something different like the result of a function call as in foreach (getArray() as &$itemValue) { } then assigning by reference is not possible anymore as there is no target that could be modified. Available Fixes 1. Do not assign by reference foreach (getArray() as $itemValue) { } 2. Assign to a local variable first $array = getArray(); foreach ($array as &$itemValue) {} 3. Return a reference function &getArray() { $array = array(); return $array; } foreach (getArray() as &$itemValue) { } Loading history...
236		if ($field instanceof Field) {
237		Arr::set($array['fields'], $key, $field->toArray());
238		}
239		}
240
241		return $array;
242		}
243
244		/**
245		* Convert the fluent instance to JSON.
246		*
247		* @param int $options
248		* @return string
249		*/
250		public function toJson($options = 0)
251		{
252		$parameters = $this->jsonSerialize();
253
254		unset($parameters['events']);
255
256		$values = [];
257		$replacements = [];
258
259		foreach (Arr::dot($parameters) as $key => $value) {
260		if ($key === 'table') {
261		Arr::set($parameters, $key, '#' . $value);
262		}
263
264	View Code Duplication	if ($this->isCallbackFunction($value, $key)) {
		0 ignored issues – show Duplication introduced 2019-06-27 00:10 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
265		$values[] = trim($value);
266		Arr::set($parameters, $key, '%' . $key . '%');
267		$replacements[] = '"%' . $key . '%"';
268		}
269		}
270
271		$new = [];
272		foreach ($parameters as $key => $value) {
273		Arr::set($new, $key, $value);
274		}
275
276		$json = json_encode($new, $options);
277
278		$json = str_replace($replacements, $values, $json);
279
280		return $json;
281		}
282
283		/**
284		* Check if given key & value is a valid callback js function.
285		*
286		* @param string $value
287		* @param string $key
288		* @return bool
289		*/
290		protected function isCallbackFunction($value, $key)
291		{
292		if (empty($value) \|\| is_object($value) \|\| is_array($value)) {
293		return false;
294		}
295
296		$callbacks = config('datatables-html.callback', ['$', '$.', 'function']);
297
298		return Str::startsWith(trim($value), $callbacks) \|\| Str::contains($key, ['editor', 'minDate', 'maxDate']);
299		}
300		}
301

yajra / laravel-datatables-html

Push — master ( 665657...f9a7bb )

Editor::formOptions() A

Complexity

Size

Duplication

Importance

Available Fixes

1. Do not assign by reference

2. Assign to a local variable first

3. Return a reference

Duplication Side-by-Side

Filter issues like