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

Completed

Push — master ( 4ae264...7b56b4 )

by Arjay

created 2018-11-20 05:54 UTC

HasData::ajaxWithForm() A

↳ Parent: HasData

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.9
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php

namespace Yajra\DataTables\Html\Options;

/**
 * DataTables - Data option builder.
 *
 * @see https://datatables.net/reference/option/
 */
trait HasData
{
    /**
     * @var string|array
     */
    protected $ajax = '';

    /**
     * Setup ajax parameter.
     *
     * @param  string|array $attributes
     * @return $this
     */
    public function ajax($attributes = '')
    {
        $this->ajax = $attributes;

        return $this;
    }

    /**
     * Setup "ajax" parameter with POST method.
     *
     * @param  string|array $attributes
     * @return $this
     */
    public function postAjax($attributes = '')
    {
        if (! is_array($attributes)) {
            $attributes = ['url' => (string) $attributes];
        }

        unset($attributes['method']);
        array_set($attributes, 'type', 'POST');
        array_set($attributes, 'headers.X-HTTP-Method-Override', 'GET');

        return $this->ajax($attributes);
    }

    /**
     * Setup ajax parameter for datatables pipeline plugin.
     *
     * @param  string $url
     * @param  string $pages
     * @return $this
     */
    public function pipeline($url, $pages)
    {
        $this->ajax = "$.fn.dataTable.pipeline({ url: '{$url}', pages: {$pages} })";

        return $this;
    }

    /**
     * Minify ajax url generated when using get request
     * by deleting unnecessary url params.
     *
     * @param string $url
     * @param string $script
     * @param array $data
     * @param array $ajaxParameters
     * @return $this
     */
    public function minifiedAjax($url = '', $script = null, $data = [], $ajaxParameters = [])
    {
        $this->ajax = [];
        $appendData = $this->makeDataScript($data);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $this->ajax['url'] = $url;
        $this->ajax['type'] = 'GET';
        if (isset($this->attributes['serverSide']) ? $this->attributes['serverSide'] : true) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->ajax['data'] = 'function(data) {
            for (var i = 0, len = data.columns.length; i < len; i++) {
                if (!data.columns[i].search.value) delete data.columns[i].search;
                if (data.columns[i].searchable === true) delete data.columns[i].searchable;
                if (data.columns[i].orderable === true) delete data.columns[i].orderable;
                if (data.columns[i].data === data.columns[i].name) delete data.columns[i].name;
            }
            delete data.search.regex;';
        } else {
            $this->ajax['data'] = 'function(data){';
        }

        if ($appendData) {
            $this->ajax['data'] .= $appendData;
        }

        if ($script) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->ajax['data'] .= $script;
        }

        $this->ajax['data'] .= '}';

        $this->ajax = array_merge($this->ajax, $ajaxParameters);

        return $this;
    }

    /**
     * Get ajax url.
     *
     * @return array|mixed|string
     */
    public function getAjaxUrl()
    {
        if (is_array($this->ajax)) {
            return $this->ajax['url'] ?: url()->current();
        }

        return $this->ajax ?: url()->current();
    }

    /**
     * Set ajax url with data added from form.
     *
     * @param string $url
     * @param string $formSelector
     * @return $this
     */
    public function ajaxWithForm($url, $formSelector)
    {
        $script = <<<CDATA
var formData = $("{$formSelector}").find("input, select").serializeArray();
$.each(formData, function(i, obj){
    data[obj.name] = obj.value;
});
CDATA;

        return $this->minifiedAjax($url, $script);
    }
}


1			<?php
2
3			namespace Yajra\DataTables\Html\Options;
4
5			/**
6			* DataTables - Data option builder.
7			*
8			* @see https://datatables.net/reference/option/
9			*/
10			trait HasData
11			{
12			/**
13			* @var string\|array
14			*/
15			protected $ajax = '';
16
17			/**
18			* Setup ajax parameter.
19			*
20			* @param string\|array $attributes
21			* @return $this
22			*/
23			public function ajax($attributes = '')
24			{
25			$this->ajax = $attributes;
26
27			return $this;
28			}
29
30			/**
31			* Setup "ajax" parameter with POST method.
32			*
33			* @param string\|array $attributes
34			* @return $this
35			*/
36			public function postAjax($attributes = '')
37			{
38			if (! is_array($attributes)) {
39			$attributes = ['url' => (string) $attributes];
40			}
41
42			unset($attributes['method']);
43			array_set($attributes, 'type', 'POST');
44			array_set($attributes, 'headers.X-HTTP-Method-Override', 'GET');
45
46			return $this->ajax($attributes);
47			}
48
49			/**
50			* Setup ajax parameter for datatables pipeline plugin.
51			*
52			* @param string $url
53			* @param string $pages
54			* @return $this
55			*/
56			public function pipeline($url, $pages)
57			{
58			$this->ajax = "$.fn.dataTable.pipeline({ url: '{$url}', pages: {$pages} })";
59
60			return $this;
61			}
62
63			/**
64			* Minify ajax url generated when using get request
65			* by deleting unnecessary url params.
66			*
67			* @param string $url
68			* @param string $script
69			* @param array $data
70			* @param array $ajaxParameters
71			* @return $this
72			*/
73			public function minifiedAjax($url = '', $script = null, $data = [], $ajaxParameters = [])
74			{
75			$this->ajax = [];
76			$appendData = $this->makeDataScript($data);
			0 ignored issues – show Bug introduced 2018-11-14 08:10 UTC by Report Bug Copy Issue Report It seems like `makeDataScript()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
77
78			$this->ajax['url'] = $url;
79			$this->ajax['type'] = 'GET';
80			if (isset($this->attributes['serverSide']) ? $this->attributes['serverSide'] : true) {
			0 ignored issues – show Bug introduced 2018-11-14 08:10 UTC by Report Bug Copy Issue Report The property `attributes` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
81			$this->ajax['data'] = 'function(data) {
82			for (var i = 0, len = data.columns.length; i < len; i++) {
83			if (!data.columns[i].search.value) delete data.columns[i].search;
84			if (data.columns[i].searchable === true) delete data.columns[i].searchable;
85			if (data.columns[i].orderable === true) delete data.columns[i].orderable;
86			if (data.columns[i].data === data.columns[i].name) delete data.columns[i].name;
87			}
88			delete data.search.regex;';
89			} else {
90			$this->ajax['data'] = 'function(data){';
91			}
92
93			if ($appendData) {
94			$this->ajax['data'] .= $appendData;
95			}
96
97			if ($script) {
			0 ignored issues – show Bug Best Practice introduced 2017-07-05 04:30 UTC by Report Bug Copy Issue Report The expression `$script` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
98			$this->ajax['data'] .= $script;
99			}
100
101			$this->ajax['data'] .= '}';
102
103			$this->ajax = array_merge($this->ajax, $ajaxParameters);
104
105			return $this;
106			}
107
108			/**
109			* Get ajax url.
110			*
111			* @return array\|mixed\|string
112			*/
113			public function getAjaxUrl()
114			{
115			if (is_array($this->ajax)) {
116			return $this->ajax['url'] ?: url()->current();
117			}
118
119			return $this->ajax ?: url()->current();
120			}
121
122			/**
123			* Set ajax url with data added from form.
124			*
125			* @param string $url
126			* @param string $formSelector
127			* @return $this
128			*/
129			public function ajaxWithForm($url, $formSelector)
130			{
131			$script = <<<CDATA
132			var formData = $("{$formSelector}").find("input, select").serializeArray();
133			$.each(formData, function(i, obj){
134			data[obj.name] = obj.value;
135			});
136			CDATA;
137
138			return $this->minifiedAjax($url, $script);
139			}
140			}
141

yajra / laravel-datatables-html

Push — master ( 4ae264...7b56b4 )

HasData::ajaxWithForm() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like