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

Completed

Push — master ( 6b1bac...f0abe2 )

by Arjay

created 2020-02-21 06:54 UTC

HasData::getAjaxUrl() A

↳ Parent: HasData

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	10
c	0
b	0
f	0
cc	4
nc	4
nop	0

<?php

namespace Yajra\DataTables\Html\Options;

use Illuminate\Support\Arr;

/**
 * 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']);
        Arr::set($attributes, 'type', 'POST');
        Arr::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'] = empty($url) ? url()->full() : $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			use Illuminate\Support\Arr;
6
7			/**
8			* DataTables - Data option builder.
9			*
10			* @see https://datatables.net/reference/option/
11			*/
12			trait HasData
13			{
14			/**
15			* @var string\|array
16			*/
17			protected $ajax = '';
18
19			/**
20			* Setup ajax parameter.
21			*
22			* @param string\|array $attributes
23			* @return $this
24			*/
25			public function ajax($attributes = '')
26			{
27			$this->ajax = $attributes;
28
29			return $this;
30			}
31
32			/**
33			* Setup "ajax" parameter with POST method.
34			*
35			* @param string\|array $attributes
36			* @return $this
37			*/
38			public function postAjax($attributes = '')
39			{
40			if (! is_array($attributes)) {
41			$attributes = ['url' => (string) $attributes];
42			}
43
44			unset($attributes['method']);
45			Arr::set($attributes, 'type', 'POST');
46			Arr::set($attributes, 'headers.X-HTTP-Method-Override', 'GET');
47
48			return $this->ajax($attributes);
49			}
50
51			/**
52			* Setup ajax parameter for datatables pipeline plugin.
53			*
54			* @param string $url
55			* @param string $pages
56			* @return $this
57			*/
58			public function pipeline($url, $pages)
59			{
60			$this->ajax = "$.fn.dataTable.pipeline({ url: '{$url}', pages: {$pages} })";
61
62			return $this;
63			}
64
65			/**
66			* Minify ajax url generated when using get request
67			* by deleting unnecessary url params.
68			*
69			* @param string $url
70			* @param string $script
71			* @param array $data
72			* @param array $ajaxParameters
73			* @return $this
74			*/
75			public function minifiedAjax($url = '', $script = null, $data = [], $ajaxParameters = [])
76			{
77			$this->ajax = [];
78			$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...
79
80			$this->ajax['url'] = empty($url) ? url()->full() : $url;
81			$this->ajax['type'] = 'GET';
82			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...
83			$this->ajax['data'] = 'function(data) {
84			for (var i = 0, len = data.columns.length; i < len; i++) {
85			if (!data.columns[i].search.value) delete data.columns[i].search;
86			if (data.columns[i].searchable === true) delete data.columns[i].searchable;
87			if (data.columns[i].orderable === true) delete data.columns[i].orderable;
88			if (data.columns[i].data === data.columns[i].name) delete data.columns[i].name;
89			}
90			delete data.search.regex;';
91			} else {
92			$this->ajax['data'] = 'function(data){';
93			}
94
95			if ($appendData) {
96			$this->ajax['data'] .= $appendData;
97			}
98
99			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...
100			$this->ajax['data'] .= $script;
101			}
102
103			$this->ajax['data'] .= '}';
104
105			$this->ajax = array_merge($this->ajax, $ajaxParameters);
106
107			return $this;
108			}
109
110			/**
111			* Get ajax url.
112			*
113			* @return array\|mixed\|string
114			*/
115			public function getAjaxUrl()
116			{
117			if (is_array($this->ajax)) {
118			return $this->ajax['url'] ?: url()->current();
119			}
120
121			return $this->ajax ?: url()->current();
122			}
123
124			/**
125			* Set ajax url with data added from form.
126			*
127			* @param string $url
128			* @param string $formSelector
129			* @return $this
130			*/
131			public function ajaxWithForm($url, $formSelector)
132			{
133			$script = <<<CDATA
134			var formData = $("{$formSelector}").find("input, select").serializeArray();
135			$.each(formData, function(i, obj){
136			data[obj.name] = obj.value;
137			});
138			CDATA;
139
140			return $this->minifiedAjax($url, $script);
141			}
142			}
143

yajra / laravel-datatables-html

Push — master ( 6b1bac...f0abe2 )

HasData::getAjaxUrl() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like