Grid::addColumn() - Code Metrics - Inspection of "call html builder by getGridHelper" - adam-boduch/laravel-grid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 14f10a...6ec6b5 )

by Adam

created 2016-08-04 05:45 UTC

Grid::addColumn() A

↳ Parent: Grid

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	2
eloc	8
c	2
b	0
f	0
nc	2
nop	2
dl	0
loc	13
rs	9.4285

<?php

namespace Boduch\Grid;

use Boduch\Grid\Components\RowAction;
use Boduch\Grid\Source\SourceInterface;
use Illuminate\Pagination\LengthAwarePaginator;
use Illuminate\Pagination\Paginator;

class Grid
{
    /**
     * @var string
     */
    protected $template = 'laravel-grid::grid';

    /**
     * @var GridHelper
     */
    protected $gridHelper;

    /**
     * @var SourceInterface
     */
    protected $source;

    /**
     * @var Column[]
     */
    protected $columns = [];

    /**
     * @var int
     */
    protected $perPage = 15;

    /**
     * @var string
     */
    protected $emptyMessage = 'Brak danych do wyświetlenia.';

    /**
     * @var Rows
     */
    protected $rows;

    /**
     * Total number of records.
     *
     * @var int
     */
    protected $total = 0;

    /**
     * @var RowAction[]
     */
    protected $rowActions = [];

    /**
     * @var array
     */
    protected $defaultOrder = [
        'column' => 'id',
        'direction' => 'desc'
    ];

    /**
     * @var Order
     */
    protected $order;

    /**
     * @var bool
     */
    protected $enablePagination = true;

    /**
     * @var callable
     */
    protected $eachCallback;

    /**
     * @var array
     */
    protected $data = [];

    /**
     * @param GridHelper $gridHelper
     */
    public function __construct(GridHelper $gridHelper)
    {
        $this->gridHelper = $gridHelper;

        $this->makeDefaultOrder();
    }

    public function buildGrid()
    {
        //
    }

    /**
     * @return GridHelper
     */
    public function getGridHelper()
    {
        return $this->gridHelper;
    }

    /**
     * @param SourceInterface $source
     * @return $this
     */
    public function setSource(SourceInterface $source)
    {
        $this->source = $source;

        return $this;
    }

    /**
     * @param string $name
     * @param array $options
     * @return $this
     */
    public function addColumn($name, array $options = [])
    {
        if ($name instanceof Column) {
            $column = $name;
        } else {
            $column = $this->makeColumn($name, $options);
        }

        $column->setGrid($this);
        $this->columns[$column->getName()] = $column;

        return $this;
    }

    /**
     * @return Column[]
     */
    public function getColumns()
    {
        return $this->columns;
    }

    /**
     * @param Order $order
     * @return $this
     */
    public function setDefaultOrder(Order $order)
    {
        $this->order = $order;

        return $this;
    }

    /**
     * @return Order
     */
    public function getOrder()
    {
        return $this->order;
    }

    /**
     * @param int $perPage
     * @return $this
     */
    public function setPerPage($perPage)
    {
        $this->perPage = $perPage;

        return $this;
    }

    /**
     * @return int
     */
    public function getPerPage()
    {
        return $this->perPage;
    }

    /**
     * @return string
     */
    public function getEmptyMessage()
    {
        return $this->emptyMessage;
    }

    /**
     * @param string $emptyMessage
     */
    public function setEmptyMessage($emptyMessage)
    {
        $this->emptyMessage = $emptyMessage;
    }

    /**
     * @param RowAction $rowAction
     * @return $this
     */
    public function addRowAction(RowAction $rowAction)
    {
        $rowAction->setGrid($this);
        $this->rowActions[] = $rowAction;

        return $this;
    }

    /**
     * @param bool $flag
     * @return $this
     */
    public function setEnablePagination($flag)
    {
        $this->enablePagination = (bool) $flag;
        $this->setPerPage(null);

        return $this;
    }

    /**
     * @return bool
     */
    public function isPaginationEnabled()
    {
        return $this->enablePagination;
    }

    /**
     * @param callable $callback
     */
    public function each(callable $callback)
    {
        $this->eachCallback = $callback;
    }

    /**
     * @param array $data
     * @return $this
     */
    public function setData($data)
    {
        $this->data = $data;

        return $this;
    }

    /**
     * @return \Illuminate\View\View;

     */
    public function render()
    {
        $rows = $this->getRows();
        $pagination = null;

        if ($this->enablePagination) {
            $pagination = $this->getPaginator($rows)->appends($this->gridHelper->getRequest()->except('page'));
        }

        return $this->gridHelper->getView()->make($this->template, [
            'columns'       => $this->columns,
            'rows'          => $rows,
            'pagination'    => $pagination,
            'grid'          => $this,
            'is_filterable' => $this->isFilterable()
        ], $this->data);
    }

    /**
     * Is table filterable?
     *
     * @return bool
     */
    public function isFilterable()
    {
        $hasFilters = false;

        foreach ($this->columns as $column) {
            if ($column->isFilterable()) {
                $hasFilters = true;
                break;
            }
        }

        return $hasFilters;
    }

    /**
     * @return Rows
     */
    public function getRows()
    {
        if (empty($this->source)) {
            throw new \InvalidArgumentException('You MUST set the data grid source by calling setSource() method.');
        }

        if (!empty($this->rows)) {
            return $this->rows;
        }

        if ($this->gridHelper->getRequest()->has('column') && !empty($this->defaultOrder)) {
            $this->order = new Order(
                $this->gridHelper->getRequest()->get('column', $this->defaultOrder['column']),
                $this->gridHelper->getRequest()->get('direction', $this->defaultOrder['direction'])
            );

            $validator = $this->gridHelper->getValidatorInstance($this->getValidatorRules());

            if ($validator->fails()) {
                $this->makeDefaultOrder();
            }
        }

        $data = $this->execute();
        $this->rows = new Rows();

        // special column for action buttons
        $actions = new Column(['name' => '__actions__']);
        $actions->setGrid($this);

        foreach ($data as $mixed) {
            $row = new Row($mixed);
            $row->setGrid($this);

            foreach ($this->columns as $column) {
                $row->addCell(new Cell($column, $mixed));
            }

            $row->addCell((new Action($actions, $mixed))->setRowActions($this->rowActions));

            if ($this->eachCallback) {
                $this->eachCallback->call($this, $row);
            }
            $this->rows->addRow($row);
        }

        $this->columns[] = $actions;

        return $this->rows;
    }

    /**
     * @param Rows $rows
     * @return LengthAwarePaginator
     */
    protected function getPaginator(Rows $rows)
    {
        return new LengthAwarePaginator($rows, $this->total, $this->perPage, $this->resolveCurrentPage(), [
            'path' => $this->resolveCurrentPath(),
        ]);
    }

    /**
     * @return mixed
     */
    protected function execute()
    {
        $this->source->applyFilters($this->columns, $this->gridHelper->getRequest());

        if ($this->enablePagination) {
            $this->total = $this->source->total();
        }

        return $this->source->execute($this->perPage, $this->resolveCurrentPage(), $this->order);
    }

    /**
     * @return int
     */
    protected function resolveCurrentPage()
    {
        return Paginator::resolveCurrentPage();
    }

    /**
     * @return string
     */
    protected function resolveCurrentPath()
    {
        return Paginator::resolveCurrentPath();
    }

    /**
     * @return array
     */
    protected function getValidatorRules()
    {
        $allowed = [];

        foreach ($this->columns as $column) {
            if ($column->isSortable()) {
                $allowed[] = $column->getName();
            }
        }

        return [
            'column' => 'sometimes|in:' . implode(',', $allowed),
            'direction' => 'sometimes|in:asc,desc'
        ];
    }

    protected function makeDefaultOrder()
    {
        $this->order = $this->defaultOrder
            ? new Order($this->defaultOrder['column'], $this->defaultOrder['direction'])
            : new Order();
    }

    /**
     * @param string $name
     * @param array $options
     * @return Column
     */
    protected function makeColumn($name, array $options = [])
    {
        $options = $this->setupColumnOptions($name, $options);

        return new Column($options);
    }

    /**
     * @param string $name
     * @param array $options
     * @return array
     */
    protected function setupColumnOptions($name, array $options)
    {
        $default = ['name' => $name];

        return array_merge($default, $options);
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return (string) $this->render();
    }
}


1			<?php
2
3			namespace Boduch\Grid;
4
5			use Boduch\Grid\Components\RowAction;
6			use Boduch\Grid\Source\SourceInterface;
7			use Illuminate\Pagination\LengthAwarePaginator;
8			use Illuminate\Pagination\Paginator;
9
10			class Grid
11			{
12			/**
13			* @var string
14			*/
15			protected $template = 'laravel-grid::grid';
16
17			/**
18			* @var GridHelper
19			*/
20			protected $gridHelper;
21
22			/**
23			* @var SourceInterface
24			*/
25			protected $source;
26
27			/**
28			* @var Column[]
29			*/
30			protected $columns = [];
31
32			/**
33			* @var int
34			*/
35			protected $perPage = 15;
36
37			/**
38			* @var string
39			*/
40			protected $emptyMessage = 'Brak danych do wyświetlenia.';
41
42			/**
43			* @var Rows
44			*/
45			protected $rows;
46
47			/**
48			* Total number of records.
49			*
50			* @var int
51			*/
52			protected $total = 0;
53
54			/**
55			* @var RowAction[]
56			*/
57			protected $rowActions = [];
58
59			/**
60			* @var array
61			*/
62			protected $defaultOrder = [
63			'column' => 'id',
64			'direction' => 'desc'
65			];
66
67			/**
68			* @var Order
69			*/
70			protected $order;
71
72			/**
73			* @var bool
74			*/
75			protected $enablePagination = true;
76
77			/**
78			* @var callable
79			*/
80			protected $eachCallback;
81
82			/**
83			* @var array
84			*/
85			protected $data = [];
86
87			/**
88			* @param GridHelper $gridHelper
89			*/
90			public function __construct(GridHelper $gridHelper)
91			{
92			$this->gridHelper = $gridHelper;
93
94			$this->makeDefaultOrder();
95			}
96
97			public function buildGrid()
98			{
99			//
100			}
101
102			/**
103			* @return GridHelper
104			*/
105			public function getGridHelper()
106			{
107			return $this->gridHelper;
108			}
109
110			/**
111			* @param SourceInterface $source
112			* @return $this
113			*/
114			public function setSource(SourceInterface $source)
115			{
116			$this->source = $source;
117
118			return $this;
119			}
120
121			/**
122			* @param string $name
123			* @param array $options
124			* @return $this
125			*/
126			public function addColumn($name, array $options = [])
127			{
128			if ($name instanceof Column) {
129			$column = $name;
130			} else {
131			$column = $this->makeColumn($name, $options);
132			}
133
134			$column->setGrid($this);
135			$this->columns[$column->getName()] = $column;
136
137			return $this;
138			}
139
140			/**
141			* @return Column[]
142			*/
143			public function getColumns()
144			{
145			return $this->columns;
146			}
147
148			/**
149			* @param Order $order
150			* @return $this
151			*/
152			public function setDefaultOrder(Order $order)
153			{
154			$this->order = $order;
155
156			return $this;
157			}
158
159			/**
160			* @return Order
161			*/
162			public function getOrder()
163			{
164			return $this->order;
165			}
166
167			/**
168			* @param int $perPage
169			* @return $this
170			*/
171			public function setPerPage($perPage)
172			{
173			$this->perPage = $perPage;
174
175			return $this;
176			}
177
178			/**
179			* @return int
180			*/
181			public function getPerPage()
182			{
183			return $this->perPage;
184			}
185
186			/**
187			* @return string
188			*/
189			public function getEmptyMessage()
190			{
191			return $this->emptyMessage;
192			}
193
194			/**
195			* @param string $emptyMessage
196			*/
197			public function setEmptyMessage($emptyMessage)
198			{
199			$this->emptyMessage = $emptyMessage;
200			}
201
202			/**
203			* @param RowAction $rowAction
204			* @return $this
205			*/
206			public function addRowAction(RowAction $rowAction)
207			{
208			$rowAction->setGrid($this);
209			$this->rowActions[] = $rowAction;
210
211			return $this;
212			}
213
214			/**
215			* @param bool $flag
216			* @return $this
217			*/
218			public function setEnablePagination($flag)
219			{
220			$this->enablePagination = (bool) $flag;
221			$this->setPerPage(null);
222
223			return $this;
224			}
225
226			/**
227			* @return bool
228			*/
229			public function isPaginationEnabled()
230			{
231			return $this->enablePagination;
232			}
233
234			/**
235			* @param callable $callback
236			*/
237			public function each(callable $callback)
238			{
239			$this->eachCallback = $callback;
240			}
241
242			/**
243			* @param array $data
244			* @return $this
245			*/
246			public function setData($data)
247			{
248			$this->data = $data;
249
250			return $this;
251			}
252
253			/**
254			* @return \Illuminate\View\View;
			0 ignored issues – show Documentation introduced 2016-08-04 05:47 UTC by Report Bug Copy Issue Report The doc-type `\Illuminate\View\View;` could not be parsed: Expected "\|" or "end of type", but got ";" at position 21. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
255			*/
256			public function render()
257			{
258			$rows = $this->getRows();
259			$pagination = null;
260
261			if ($this->enablePagination) {
262			$pagination = $this->getPaginator($rows)->appends($this->gridHelper->getRequest()->except('page'));
263			}
264
265			return $this->gridHelper->getView()->make($this->template, [
266			'columns' => $this->columns,
267			'rows' => $rows,
268			'pagination' => $pagination,
269			'grid' => $this,
270			'is_filterable' => $this->isFilterable()
271			], $this->data);
272			}
273
274			/**
275			* Is table filterable?
276			*
277			* @return bool
278			*/
279			public function isFilterable()
280			{
281			$hasFilters = false;
282
283			foreach ($this->columns as $column) {
284			if ($column->isFilterable()) {
285			$hasFilters = true;
286			break;
287			}
288			}
289
290			return $hasFilters;
291			}
292
293			/**
294			* @return Rows
295			*/
296			public function getRows()
297			{
298			if (empty($this->source)) {
299			throw new \InvalidArgumentException('You MUST set the data grid source by calling setSource() method.');
300			}
301
302			if (!empty($this->rows)) {
303			return $this->rows;
304			}
305
306			if ($this->gridHelper->getRequest()->has('column') && !empty($this->defaultOrder)) {
307			$this->order = new Order(
308			$this->gridHelper->getRequest()->get('column', $this->defaultOrder['column']),
309			$this->gridHelper->getRequest()->get('direction', $this->defaultOrder['direction'])
310			);
311
312			$validator = $this->gridHelper->getValidatorInstance($this->getValidatorRules());
313
314			if ($validator->fails()) {
315			$this->makeDefaultOrder();
316			}
317			}
318
319			$data = $this->execute();
320			$this->rows = new Rows();
321
322			// special column for action buttons
323			$actions = new Column(['name' => '__actions__']);
324			$actions->setGrid($this);
325
326			foreach ($data as $mixed) {
327			$row = new Row($mixed);
328			$row->setGrid($this);
329
330			foreach ($this->columns as $column) {
331			$row->addCell(new Cell($column, $mixed));
332			}
333
334			$row->addCell((new Action($actions, $mixed))->setRowActions($this->rowActions));
335
336			if ($this->eachCallback) {
337			$this->eachCallback->call($this, $row);
338			}
339			$this->rows->addRow($row);
340			}
341
342			$this->columns[] = $actions;
343
344			return $this->rows;
345			}
346
347			/**
348			* @param Rows $rows
349			* @return LengthAwarePaginator
350			*/
351			protected function getPaginator(Rows $rows)
352			{
353			return new LengthAwarePaginator($rows, $this->total, $this->perPage, $this->resolveCurrentPage(), [
354			'path' => $this->resolveCurrentPath(),
355			]);
356			}
357
358			/**
359			* @return mixed
360			*/
361			protected function execute()
362			{
363			$this->source->applyFilters($this->columns, $this->gridHelper->getRequest());
364
365			if ($this->enablePagination) {
366			$this->total = $this->source->total();
367			}
368
369			return $this->source->execute($this->perPage, $this->resolveCurrentPage(), $this->order);
370			}
371
372			/**
373			* @return int
374			*/
375			protected function resolveCurrentPage()
376			{
377			return Paginator::resolveCurrentPage();
378			}
379
380			/**
381			* @return string
382			*/
383			protected function resolveCurrentPath()
384			{
385			return Paginator::resolveCurrentPath();
386			}
387
388			/**
389			* @return array
390			*/
391			protected function getValidatorRules()
392			{
393			$allowed = [];
394
395			foreach ($this->columns as $column) {
396			if ($column->isSortable()) {
397			$allowed[] = $column->getName();
398			}
399			}
400
401			return [
402			'column' => 'sometimes\|in:' . implode(',', $allowed),
403			'direction' => 'sometimes\|in:asc,desc'
404			];
405			}
406
407			protected function makeDefaultOrder()
408			{
409			$this->order = $this->defaultOrder
410			? new Order($this->defaultOrder['column'], $this->defaultOrder['direction'])
411			: new Order();
412			}
413
414			/**
415			* @param string $name
416			* @param array $options
417			* @return Column
418			*/
419			protected function makeColumn($name, array $options = [])
420			{
421			$options = $this->setupColumnOptions($name, $options);
422
423			return new Column($options);
424			}
425
426			/**
427			* @param string $name
428			* @param array $options
429			* @return array
430			*/
431			protected function setupColumnOptions($name, array $options)
432			{
433			$default = ['name' => $name];
434
435			return array_merge($default, $options);
436			}
437
438			/**
439			* @return string
440			*/
441			public function __toString()
442			{
443			return (string) $this->render();
444			}
445			}
446

adam-boduch / laravel-grid

Push — master ( 14f10a...6ec6b5 )

Grid::addColumn() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like