EloquentDatatable::addOptions() - Code Metrics - Inspection of "Column sorting enhancement" - Distilleries/DatatableBuilder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5)

unknown

created 2016-07-20 09:31 UTC

EloquentDatatable::addOptions() C

↳ Parent: EloquentDatatable

Complexity

Conditions	10
Paths	3

Size

Total Lines	24
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	24
rs	5.2164
cc	10
eloc	14
nc	3
nop	0

How to fix Complexity

<?php namespace Distilleries\DatatableBuilder;

use \Datatable;
use Illuminate\Database\Eloquent\Model;
use \ReflectionClass;
use \FormBuilder;
use \Request;

abstract class EloquentDatatable {

    protected $model;
    protected $colomns;
    protected $form = null;
    protected $colomnsDisplay = [];
    protected $datatableOptions = [];

    // 0 can be an integer to represents the column's number or it can be a string that references the column's name
    protected $defaultOrder = [[0, 'desc']];

    // ------------------------------------------------------------------------------------------------

    public function __construct(Model $model = null)
    {
        $this->model = $model;
    }

    /**
     * @param Eloquent $model
     */
    public function setModel(Model $model)
    {
        $this->model = $model;
    }


    // ------------------------------------------------------------------------------------------------

    /**
     * @param string $name
     * @param \Closure $closure
     */
    public function add($name, $closure = null, $translation = '')
    {
        if (!empty($closure))
        {
            $this->colomns[] = [
                $name,
                $closure
            ];
        } else
        {
            $this->colomns[] = $name;
        }

        $this->addTranslation($name, $translation);

        return $this;

    }

    /**
     * @param string $translation
     * @param string $name
     */
    public function addTranslation($name, $translation)
    {
        $this->colomnsDisplay[] = (!empty($translation)) ? $translation : ucfirst($name);
    }

    // ------------------------------------------------------------------------------------------------

    public function applyFilters()
    {
        $allInput = Request::all();
        $columns  = \Schema::getColumnListing($this->model->getTable());

        foreach ($allInput as $name => $input)
        {
            if (in_array($name, $columns) && $input != '')
            {

                $this->model = $this->model->where($name, '=', $input);
            }
        }
    }

    // ------------------------------------------------------------------------------------------------

    public function generateColomns()
    {
        $this->applyFilters();

        $datatable        = Datatable::query($this->model);
        $colSearchAndSort = array();
        $sortOnly = array();

        if (!empty($this->colomns))
        {
            foreach ($this->colomns as $key => $value)
            {

                if (is_string($value))
                {
                    $datatable->showColumns($value);
                    $colSearchAndSort[] = $value;

                } else if (is_array($value) && count($value) == 2)
                {
                    $datatable->addColumn($value[0], $value[1]);
                    $sortOnly[] = $value[0];
                }

            }
        }

        $datatable = $this->setClassRow($datatable);
        $datatable->orderColumns(array_merge($colSearchAndSort, $sortOnly));
        $datatable->searchColumns($colSearchAndSort);

        return $datatable->make();
    }

    public function setClassRow($datatable)
    {
        //DT_RowClass
        $datatable->setRowClass(function($row)
        {
            return (isset($row->status) && empty($row->status)) ? 'danger' : '';
        });

        return $datatable;
    }

    // ------------------------------------------------------------------------------------------------
    public function generateHtmlRender($template = 'datatable-builder::part.datatable', $route = '')
    {
        return view($template, [
            'colomns_display' => $this->colomnsDisplay,
            'datatable_options' => $this->addOptions(),
            'route'           => !empty($route) ? $route : $this->getControllerNameForAction().'@getDatatable',
            'filters'         => $this->addFilter(),
        ]);
    }

    // ------------------------------------------------------------------------------------------------
    public function addDefaultAction($template = 'datatable-builder::form.components.datatable.actions', $route = '')
    {

        $reflection = new ReflectionClass(get_class($this));

        $this->add('actions', function($model) use ($template, $reflection, $route)
        {
            return view($template, array(
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.
}
                'data'  => $model->toArray(),
                'route' => !empty($route) ? $route.'@' : $this->getControllerNameForAction().'@'
            ))->render();
        });
    }

    // ------------------------------------------------------------------------------------------------
    // ------------------------------------------------------------------------------------------------
    // ------------------------------------------------------------------------------------------------


    protected function addFilter($template = 'datatable-builder::form.components.datatable.filter')
    {
        $this->form = FormBuilder::plain();
        $this->filters();

        $filter_content = view($template, [
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.
}
            'form' => $this->form
        ])->render();


        return $filter_content;

    }

    // ------------------------------------------------------------------------------------------------
    // ------------------------------------------------------------------------------------------------
    // ------------------------------------------------------------------------------------------------


    protected function addOptions()
    {
        if (!array_key_exists('order', $this->datatableOptions) && !empty($this->defaultOrder)) {
            if (is_array($this->defaultOrder)) {
                foreach ($this->defaultOrder as $keyOrder => $order) {
                    if (is_string($order[0])) {
                        foreach ($this->colomns as $key => $colomn) {
                            if (is_array($colomn)) {
                                $colomn = $colomn[0];
                            }
                            if ($colomn == $order[0]) {
                                $this->defaultOrder[$keyOrder][0] = $key;
                            }
                        }
                        if (is_string($this->defaultOrder[$keyOrder][0])) {
                            $this->defaultOrder[$keyOrder][0] = 0;
                        }
                    }
                }
                $this->datatableOptions['order'] = $this->defaultOrder;
            }
        }
        return $this->datatableOptions;
    }

    // ------------------------------------------------------------------------------------------------

    protected function getControllerNameForAction() {

        $action = explode('@', \Route::currentRouteAction());
        return '\\'.$action[0];
    }

    // ------------------------------------------------------------------------------------------------

    public function filters()
    {

        //Add the fileds of the filter form here

    }

    // ------------------------------------------------------------------------------------------------
    // ------------------------------------------------------------------------------------------------
    // ------------------------------------------------------------------------------------------------

    abstract public function build();
}

Pull Request — master (#5)

EloquentDatatable::addOptions() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Available Fixes

Available Fixes

1			<?php namespace Distilleries\DatatableBuilder;
2
3			use \Datatable;
4			use Illuminate\Database\Eloquent\Model;
5			use \ReflectionClass;
6			use \FormBuilder;
7			use \Request;
8
9			abstract class EloquentDatatable {
10
11			protected $model;
12			protected $colomns;
13			protected $form = null;
14			protected $colomnsDisplay = [];
15			protected $datatableOptions = [];
16
17			// 0 can be an integer to represents the column's number or it can be a string that references the column's name
18			protected $defaultOrder = [[0, 'desc']];
19
20			// ------------------------------------------------------------------------------------------------
21
22			public function __construct(Model $model = null)
23			{
24			$this->model = $model;
25			}
26
27			/**
28			* @param Eloquent $model
29			*/
30			public function setModel(Model $model)
31			{
32			$this->model = $model;
33			}
34
35
36			// ------------------------------------------------------------------------------------------------
37
38			/**
39			* @param string $name
40			* @param \Closure $closure
41			*/
42			public function add($name, $closure = null, $translation = '')
43			{
44			if (!empty($closure))
45			{
46			$this->colomns[] = [
47			$name,
48			$closure
49			];
50			} else
51			{
52			$this->colomns[] = $name;
53			}
54
55			$this->addTranslation($name, $translation);
56
57			return $this;
58
59			}
60
61			/**
62			* @param string $translation
63			* @param string $name
64			*/
65			public function addTranslation($name, $translation)
66			{
67			$this->colomnsDisplay[] = (!empty($translation)) ? $translation : ucfirst($name);
68			}
69
70			// ------------------------------------------------------------------------------------------------
71
72			public function applyFilters()
73			{
74			$allInput = Request::all();
75			$columns = \Schema::getColumnListing($this->model->getTable());
76
77			foreach ($allInput as $name => $input)
78			{
79			if (in_array($name, $columns) && $input != '')
80			{
81
82			$this->model = $this->model->where($name, '=', $input);
83			}
84			}
85			}
86
87			// ------------------------------------------------------------------------------------------------
88
89			public function generateColomns()
90			{
91			$this->applyFilters();
92
93			$datatable = Datatable::query($this->model);
94			$colSearchAndSort = array();
95			$sortOnly = array();
96
97			if (!empty($this->colomns))
98			{
99			foreach ($this->colomns as $key => $value)
100			{
101
102			if (is_string($value))
103			{
104			$datatable->showColumns($value);
105			$colSearchAndSort[] = $value;
106
107			} else if (is_array($value) && count($value) == 2)
108			{
109			$datatable->addColumn($value[0], $value[1]);
110			$sortOnly[] = $value[0];
111			}
112
113			}
114			}
115
116			$datatable = $this->setClassRow($datatable);
117			$datatable->orderColumns(array_merge($colSearchAndSort, $sortOnly));
118			$datatable->searchColumns($colSearchAndSort);
119
120			return $datatable->make();
121			}
122
123			public function setClassRow($datatable)
124			{
125			//DT_RowClass
126			$datatable->setRowClass(function($row)
127			{
128			return (isset($row->status) && empty($row->status)) ? 'danger' : '';
129			});
130
131			return $datatable;
132			}
133
134			// ------------------------------------------------------------------------------------------------
135			public function generateHtmlRender($template = 'datatable-builder::part.datatable', $route = '')
136			{
137			return view($template, [
138			'colomns_display' => $this->colomnsDisplay,
139			'datatable_options' => $this->addOptions(),
140			'route' => !empty($route) ? $route : $this->getControllerNameForAction().'@getDatatable',
141			'filters' => $this->addFilter(),
142			]);
143			}
144
145			// ------------------------------------------------------------------------------------------------
146			public function addDefaultAction($template = 'datatable-builder::form.components.datatable.actions', $route = '')
147			{
148
149			$reflection = new ReflectionClass(get_class($this));
150
151			$this->add('actions', function($model) use ($template, $reflection, $route)
152			{
153			return view($template, array(
			0 ignored issues – show Bug introduced 2016-01-15 13:55 UTC by Report Bug Copy Issue Report The method `render` 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...
154			'data' => $model->toArray(),
155			'route' => !empty($route) ? $route.'@' : $this->getControllerNameForAction().'@'
156			))->render();
157			});
158			}
159
160			// ------------------------------------------------------------------------------------------------
161			// ------------------------------------------------------------------------------------------------
162			// ------------------------------------------------------------------------------------------------
163
164
165			protected function addFilter($template = 'datatable-builder::form.components.datatable.filter')
166			{
167			$this->form = FormBuilder::plain();
168			$this->filters();
169
170			$filter_content = view($template, [
			0 ignored issues – show Bug introduced 2016-01-15 13:55 UTC by Report Bug Copy Issue Report The method `render` 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...
171			'form' => $this->form
172			])->render();
173
174
175			return $filter_content;
176
177			}
178
179			// ------------------------------------------------------------------------------------------------
180			// ------------------------------------------------------------------------------------------------
181			// ------------------------------------------------------------------------------------------------
182
183
184			protected function addOptions()
185			{
186			if (!array_key_exists('order', $this->datatableOptions) && !empty($this->defaultOrder)) {
187			if (is_array($this->defaultOrder)) {
188			foreach ($this->defaultOrder as $keyOrder => $order) {
189			if (is_string($order[0])) {
190			foreach ($this->colomns as $key => $colomn) {
191			if (is_array($colomn)) {
192			$colomn = $colomn[0];
193			}
194			if ($colomn == $order[0]) {
195			$this->defaultOrder[$keyOrder][0] = $key;
196			}
197			}
198			if (is_string($this->defaultOrder[$keyOrder][0])) {
199			$this->defaultOrder[$keyOrder][0] = 0;
200			}
201			}
202			}
203			$this->datatableOptions['order'] = $this->defaultOrder;
204			}
205			}
206			return $this->datatableOptions;
207			}
208
209			// ------------------------------------------------------------------------------------------------
210
211			protected function getControllerNameForAction() {
212
213			$action = explode('@', \Route::currentRouteAction());
214			return '\\'.$action[0];
215			}
216
217			// ------------------------------------------------------------------------------------------------
218
219			public function filters()
220			{
221
222			//Add the fileds of the filter form here
223
224			}
225
226			// ------------------------------------------------------------------------------------------------
227			// ------------------------------------------------------------------------------------------------
228			// ------------------------------------------------------------------------------------------------
229
230			abstract public function build();
231			}

Distilleries / DatatableBuilder

Pull Request — master (#5)

EloquentDatatable::addOptions() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like