AbstractDataTable::getColumns() - Code Metrics - rinvex/cortex-foundation - Measure and Improve Code Quality continuously with Scrutinizer

AbstractDataTable::getColumns()
last analyzed 2019-09-03 21:54 UTC

↳ Parent: AbstractDataTable

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
c	0
b	0
f	0
nc	1

<?php

declare(strict_types=1);

namespace Cortex\Foundation\DataTables;

use Yajra\DataTables\Services\DataTable;

abstract class AbstractDataTable extends DataTable
{
    /**
     * The model class.
     *
     * @var string
     */
    protected $model;

    /**
     * The transformer class.
     *
     * @var string
     */
    protected $transformer;

    /**
     * The datatable dom parameter.
     *
     * @var string
     */
    protected $dom = "<'row'<'col-sm-8'B><'col-sm-4'f>> <'row'r><'row'<'col-sm-12't>> <'row'<'col-sm-5'i><'col-sm-7'p>>";

    /**
     * The datatable select parameter.
     *
     * @var bool
     */
    protected $select = true;

    /**
     * The datatable keys parameter.
     *
     * @var bool
     */
    protected $keys = false;

    /**
     * The datatable mark parameter.
     *
     * @var bool
     */
    protected $mark = true;

    /**
     * The datatable order parameter.
     *
     * @var array
     */
    protected $order = [[0, 'asc']];

    /**
     * The datatable retrieve parameter.
     *
     * @var array
     */
    protected $retrieve = true;

    /**
     * The datatable autoWidth parameter.
     *
     * @var array
     */
    protected $autoWidth = false;

    /**
     * The datatable fixedHeader parameter.
     *
     * @var array
     */
    protected $fixedHeader = true;

    /**
     * The datatable create parameter.
     *
     * @var bool
     */
    protected $createButton = true;

    /**
     * The datatable builder parameters.
     *
     * @var array
     */
    protected $builderParameters = [];

    /**
     * Get columns.
     *
     * @return array
     */
    abstract protected function getColumns();

    /**
     * Get the query object to be processed by dataTables.
     *
     * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder|\Illuminate\Support\Collection

     */
    public function query()
    {
        $query = app($this->model)->query();

        return $this->applyScopes($query);
    }

    /**
     * Display ajax response.
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function ajax()
    {
        return datatables($this->query())
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.
}
            ->setTransformer(app($this->transformer))
            ->orderColumn('name', 'name->"$.'.app()->getLocale().'" $1')
            ->make(true);
    }

    /**
     * Optional method if you want to use html builder.
     *
     * @return \Yajra\DataTables\Html\Builder
     */
    public function html()
    {
        return $this->builder()
                    ->minifiedAjax()
                    ->columns($this->getColumns())
                    ->parameters($this->getBuilderParameters());
    }

    /**
     * Process DataTables needed render output.
     *
     * @param string $view
     * @param array  $data
     * @param array  $mergeData
     *
     * @return \Illuminate\Http\JsonResponse|\Illuminate\View\View
     */
    public function render($view, $data = [], $mergeData = [])
    {
        if ($this->request()->ajax() && $this->request()->wantsJson()) {
            return app()->call([$this, 'ajax']);
        }

        if (($action = $this->request()->get('action')) && in_array($action, $this->actions)) {
            if ($action === 'print') {
                return app()->call([$this, 'printPreview']);
            }

            return app()->call([$this, $action]);
        }

        return view($view, array_merge($this->attributes, $data), $mergeData)->with($this->dataTableVariable, $this->getHtmlBuilder());
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.
}
    }

    /**
     * Get default builder parameters.
     *
     * @return array
     */
    protected function getBuilderParameters(): array
    {
        $createButton = ['extend' => 'create', 'text' => '<i class="fa fa-plus"></i> '.trans('cortex/foundation::common.new')];
        $columnsButton = ['extend' => 'colvis', 'text' => '<i class="fa fa-columns"></i> '.trans('cortex/foundation::common.columns').' <span class="caret"/>'];
        $lengthButton = ['extend' => 'pageLength', 'text' => '<i class="fa fa-list-ol"></i> '.trans('cortex/foundation::common.limit').' <span class="caret"/>'];

        return array_merge([
            'dom' => $this->dom,
            'keys' => $this->keys,
            'mark' => $this->mark,
            'order' => $this->order,
            'select' => $this->select,
            'retrieve' => $this->retrieve,
            'autoWidth' => $this->autoWidth,
            'fixedHeader' => $this->fixedHeader,
            'buttons' => $this->createButton
                ? [$createButton, 'print', 'reset', 'reload', 'import', 'export', $columnsButton, $lengthButton]
                : ['print', 'reset', 'reload', 'export', $columnsButton, $lengthButton],
        ], $this->builderParameters);
    }

    /**
     * Get filename for export.
     *
     * @return string
     */
    protected function filename(): string
    {
        $model = $this->model ?? trim(str_replace('DataTable', '', mb_strrchr(static::class, '\\')), " \t\n\r\0\x0B\\");

        $resource = str_plural(mb_strtolower(array_last(explode(class_exists($model) ? '\\' : '.', $model))));


        return $resource.'-export-'.date('Y-m-d').'-'.time();
    }
}


AbstractDataTable::getColumns()
last analyzed 2019-09-03 21:54 UTC

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2
3			declare(strict_types=1);
4
5			namespace Cortex\Foundation\DataTables;
6
7			use Yajra\DataTables\Services\DataTable;
8
9			abstract class AbstractDataTable extends DataTable
10			{
11			/**
12			* The model class.
13			*
14			* @var string
15			*/
16			protected $model;
17
18			/**
19			* The transformer class.
20			*
21			* @var string
22			*/
23			protected $transformer;
24
25			/**
26			* The datatable dom parameter.
27			*
28			* @var string
29			*/
30			protected $dom = "<'row'<'col-sm-8'B><'col-sm-4'f>> <'row'r><'row'<'col-sm-12't>> <'row'<'col-sm-5'i><'col-sm-7'p>>";
31
32			/**
33			* The datatable select parameter.
34			*
35			* @var bool
36			*/
37			protected $select = true;
38
39			/**
40			* The datatable keys parameter.
41			*
42			* @var bool
43			*/
44			protected $keys = false;
45
46			/**
47			* The datatable mark parameter.
48			*
49			* @var bool
50			*/
51			protected $mark = true;
52
53			/**
54			* The datatable order parameter.
55			*
56			* @var array
57			*/
58			protected $order = [[0, 'asc']];
59
60			/**
61			* The datatable retrieve parameter.
62			*
63			* @var array
64			*/
65			protected $retrieve = true;
66
67			/**
68			* The datatable autoWidth parameter.
69			*
70			* @var array
71			*/
72			protected $autoWidth = false;
73
74			/**
75			* The datatable fixedHeader parameter.
76			*
77			* @var array
78			*/
79			protected $fixedHeader = true;
80
81			/**
82			* The datatable create parameter.
83			*
84			* @var bool
85			*/
86			protected $createButton = true;
87
88			/**
89			* The datatable builder parameters.
90			*
91			* @var array
92			*/
93			protected $builderParameters = [];
94
95			/**
96			* Get columns.
97			*
98			* @return array
99			*/
100			abstract protected function getColumns();
101
102			/**
103			* Get the query object to be processed by dataTables.
104			*
105			* @return \Illuminate\Database\Eloquent\Builder\|\Illuminate\Database\Query\Builder\|\Illuminate\Support\Collection
			0 ignored issues – show Documentation introduced 2017-09-07 11:02 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `\Illuminate\Database\Que...tabase\Eloquent\Builder`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
106			*/
107			public function query()
108			{
109			$query = app($this->model)->query();
110
111			return $this->applyScopes($query);
112			}
113
114			/**
115			* Display ajax response.
116			*
117			* @return \Illuminate\Http\JsonResponse
118			*/
119			public function ajax()
120			{
121			return datatables($this->query())
			0 ignored issues – show Bug introduced 2018-03-30 07:53 UTC by Report Bug Copy Issue Report The method `setTransformer` does only exist in `Yajra\DataTables\DataTableAbstract`, but not in `Yajra\DataTables\DataTables`. 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...
122			->setTransformer(app($this->transformer))
123			->orderColumn('name', 'name->"$.'.app()->getLocale().'" $1')
124			->make(true);
125			}
126
127			/**
128			* Optional method if you want to use html builder.
129			*
130			* @return \Yajra\DataTables\Html\Builder
131			*/
132			public function html()
133			{
134			return $this->builder()
135			->minifiedAjax()
136			->columns($this->getColumns())
137			->parameters($this->getBuilderParameters());
138			}
139
140			/**
141			* Process DataTables needed render output.
142			*
143			* @param string $view
144			* @param array $data
145			* @param array $mergeData
146			*
147			* @return \Illuminate\Http\JsonResponse\|\Illuminate\View\View
148			*/
149			public function render($view, $data = [], $mergeData = [])
150			{
151			if ($this->request()->ajax() && $this->request()->wantsJson()) {
152			return app()->call([$this, 'ajax']);
153			}
154
155			if (($action = $this->request()->get('action')) && in_array($action, $this->actions)) {
156			if ($action === 'print') {
157			return app()->call([$this, 'printPreview']);
158			}
159
160			return app()->call([$this, $action]);
161			}
162
163			return view($view, array_merge($this->attributes, $data), $mergeData)->with($this->dataTableVariable, $this->getHtmlBuilder());
			0 ignored issues – show Bug introduced 2017-09-07 11:02 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...
164			}
165
166			/**
167			* Get default builder parameters.
168			*
169			* @return array
170			*/
171			protected function getBuilderParameters(): array
172			{
173			$createButton = ['extend' => 'create', 'text' => '<i class="fa fa-plus"></i> '.trans('cortex/foundation::common.new')];
174			$columnsButton = ['extend' => 'colvis', 'text' => '<i class="fa fa-columns"></i> '.trans('cortex/foundation::common.columns').' <span class="caret"/>'];
175			$lengthButton = ['extend' => 'pageLength', 'text' => '<i class="fa fa-list-ol"></i> '.trans('cortex/foundation::common.limit').' <span class="caret"/>'];
176
177			return array_merge([
178			'dom' => $this->dom,
179			'keys' => $this->keys,
180			'mark' => $this->mark,
181			'order' => $this->order,
182			'select' => $this->select,
183			'retrieve' => $this->retrieve,
184			'autoWidth' => $this->autoWidth,
185			'fixedHeader' => $this->fixedHeader,
186			'buttons' => $this->createButton
187			? [$createButton, 'print', 'reset', 'reload', 'import', 'export', $columnsButton, $lengthButton]
188			: ['print', 'reset', 'reload', 'export', $columnsButton, $lengthButton],
189			], $this->builderParameters);
190			}
191
192			/**
193			* Get filename for export.
194			*
195			* @return string
196			*/
197			protected function filename(): string
198			{
199			$model = $this->model ?? trim(str_replace('DataTable', '', mb_strrchr(static::class, '\\')), " \t\n\r\0\x0B\\");
200
201			$resource = str_plural(mb_strtolower(array_last(explode(class_exists($model) ? '\\' : '.', $model))));
			0 ignored issues – show Deprecated Code introduced 2019-08-03 00:05 UTC by Report Bug Copy Issue Report The function `array_last()` has been deprecated with message: Arr::last() should be used directly instead. Will be removed in Laravel 6.0. This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history... Deprecated Code introduced 2019-08-03 00:05 UTC by Report Bug Copy Issue Report The function `str_plural()` has been deprecated with message: Str::plural() should be used directly instead. Will be removed in Laravel 6.0. This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
202
203			return $resource.'-export-'.date('Y-m-d').'-'.time();
204			}
205			}
206

rinvex / cortex-foundation

AbstractDataTable::getColumns() last analyzed 2019-09-03 21:54 UTC

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

AbstractDataTable::getColumns()
last analyzed 2019-09-03 21:54 UTC