Grid::addComponent() - Code Metrics - Inspection of "button component" - adam-boduch/laravel-grid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6ec6b5...364731 )

by Adam

created 2016-08-04 06:55 UTC

Grid::addComponent() A

↳ Parent: Grid

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	4
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	7
rs	9.4285

<?php

namespace Boduch\Grid;

use Boduch\Grid\Components\Component;
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 $viewData = [];

    /**
     * @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 Component $component
     * @return $this
     */
    public function addComponent(Component $component)
    {
        $component->setGrid($this);
        $this->viewData[$component->getName()] = $component->render();

        return $this;
    }

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

        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->viewData);
    }

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

adam-boduch / laravel-grid

Push — master ( 6ec6b5...364731 )

Grid::addComponent() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like