DataProcessor::escapeColumns() - Code Metrics - Inspection of "Bump v8.12.1 :rocket:" - yajra/laravel-datatables - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 920cd0...253df5 )

by Arjay

created 2018-11-23 07:59 UTC

DataProcessor::escapeColumns() A

↳ Parent: DataProcessor

Complexity

Conditions	4
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
nc	1
nop	1
dl	0
loc	15
rs	9.7666
c	0
b	0
f	0

<?php

namespace Yajra\DataTables\Processors;

use Illuminate\Support\Arr;
use Yajra\DataTables\Utilities\Helper;

class DataProcessor
{
    /**
     * @var int
     */
    protected $start;

    /**
     * Columns to escape value.
     *
     * @var array
     */
    protected $escapeColumns = [];

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

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

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

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

    /**
     * @var mixed
     */
    protected $results;

    /**
     * @var array
     */
    protected $templates;

    /**
     * @var bool
     */
    protected $includeIndex;

    /**
     * @var array
     */
    protected $rawColumns;

    /**
     * @var array
     */
    protected $exceptions = ['DT_RowId', 'DT_RowClass', 'DT_RowData', 'DT_RowAttr'];

    /**
     * @param mixed $results
     * @param array $columnDef
     * @param array $templates
     * @param int   $start
     */
    public function __construct($results, array $columnDef, array $templates, $start)
    {
        $this->results       = $results;
        $this->appendColumns = $columnDef['append'];
        $this->editColumns   = $columnDef['edit'];
        $this->excessColumns = $columnDef['excess'];
        $this->onlyColumns   = $columnDef['only'];
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->escapeColumns = $columnDef['escape'];
        $this->includeIndex  = $columnDef['index'];
        $this->rawColumns    = $columnDef['raw'];
        $this->templates     = $templates;
        $this->start         = $start;
    }

    /**
     * Process data to output on browser.
     *
     * @param bool $object
     * @return array
     */
    public function process($object = false)
    {
        $this->output = [];
        $indexColumn  = config('datatables.index_column', 'DT_RowIndex');

        foreach ($this->results as $row) {
            $data  = Helper::convertToArray($row);
            $value = $this->addColumns($data, $row);
            $value = $this->editColumns($value, $row);
            $value = $this->setupRowVariables($value, $row);
            $value = $this->selectOnlyNeededColumns($value);
            $value = $this->removeExcessColumns($value);

            if ($this->includeIndex) {
                $value[$indexColumn] = ++$this->start;
            }

            $this->output[] = $object ? $value : $this->flatten($value);
        }

        return $this->escapeColumns($this->output);
    }

    /**
     * Process add columns.
     *
     * @param mixed $data
     * @param mixed $row
     * @return array
     */
    protected function addColumns($data, $row)

    {
        foreach ($this->appendColumns as $key => $value) {
            $value['content'] = Helper::compileContent($value['content'], $data, $row);
            $data             = Helper::includeInArray($value, $data);
        }

        return $data;
    }

    /**
     * Process edit columns.
     *
     * @param mixed $data
     * @param mixed $row
     * @return array
     */
    protected function editColumns($data, $row)

    {
        foreach ($this->editColumns as $key => $value) {
            $value['content'] = Helper::compileContent($value['content'], $data, $row);
            Arr::set($data, $value['name'], $value['content']);
        }

        return $data;
    }

    /**
     * Setup additional DT row variables.
     *
     * @param mixed $data
     * @param mixed $row
     * @return array
     */
    protected function setupRowVariables($data, $row)
    {
        $processor = new RowProcessor($data, $row);

        return $processor
            ->rowValue('DT_RowId', $this->templates['DT_RowId'])
            ->rowValue('DT_RowClass', $this->templates['DT_RowClass'])
            ->rowData('DT_RowData', $this->templates['DT_RowData'])
            ->rowData('DT_RowAttr', $this->templates['DT_RowAttr'])
            ->getData();
    }

    /**
     * Get only needed columns.
     *
     * @param array $data
     * @return array
     */
    protected function selectOnlyNeededColumns(array $data)
    {
        if (is_null($this->onlyColumns)) {
            return $data;
        } else {
            return array_intersect_key($data, array_flip(array_merge($this->onlyColumns, $this->exceptions)));
        }
    }

    /**
     * Remove declared hidden columns.
     *
     * @param array $data
     * @return array
     */
    protected function removeExcessColumns(array $data)
    {
        foreach ($this->excessColumns as $value) {
            unset($data[$value]);
        }

        return $data;
    }

    /**
     * Flatten array with exceptions.
     *
     * @param array $array
     * @return array
     */
    public function flatten(array $array)
    {
        $return = [];
        foreach ($array as $key => $value) {
            if (in_array($key, $this->exceptions)) {
                $return[$key] = $value;
            } else {
                $return[] = $value;
            }
        }

        return $return;
    }

    /**
     * Escape column values as declared.
     *
     * @param array $output
     * @return array
     */
    protected function escapeColumns(array $output)
    {
        return array_map(function ($row) {
            if ($this->escapeColumns == '*') {
                $row = $this->escapeRow($row);
            } elseif (is_array($this->escapeColumns)) {
                $columns = array_diff($this->escapeColumns, $this->rawColumns);
                foreach ($columns as $key) {
                    array_set($row, $key, e(array_get($row, $key)));
                }
            }

            return $row;
        }, $output);
    }

    /**
     * Escape all values of row.
     *
     * @param array $row
     * @return array
     */
    protected function escapeRow(array $row)
    {
        $arrayDot = array_filter(array_dot($row));
        foreach ($arrayDot as $key => $value) {
            if (! in_array($key, $this->rawColumns)) {
                $arrayDot[$key] = e($value);
            }
        }

        foreach ($arrayDot as $key => $value) {
            array_set($row, $key, $value);
        }

        return $row;
    }
}


1		<?php
2
3		namespace Yajra\DataTables\Processors;
4
5		use Illuminate\Support\Arr;
6		use Yajra\DataTables\Utilities\Helper;
7
8		class DataProcessor
9		{
10		/**
11		* @var int
12		*/
13		protected $start;
14
15		/**
16		* Columns to escape value.
17		*
18		* @var array
19		*/
20		protected $escapeColumns = [];
21
22		/**
23		* Processed data output.
24		*
25		* @var array
26		*/
27		protected $output = [];
28
29		/**
30		* @var array
31		*/
32		protected $appendColumns = [];
33
34		/**
35		* @var array
36		*/
37		protected $editColumns = [];
38
39		/**
40		* @var array
41		*/
42		protected $excessColumns = [];
43
44		/**
45		* @var mixed
46		*/
47		protected $results;
48
49		/**
50		* @var array
51		*/
52		protected $templates;
53
54		/**
55		* @var bool
56		*/
57		protected $includeIndex;
58
59		/**
60		* @var array
61		*/
62		protected $rawColumns;
63
64		/**
65		* @var array
66		*/
67		protected $exceptions = ['DT_RowId', 'DT_RowClass', 'DT_RowData', 'DT_RowAttr'];
68
69		/**
70		* @param mixed $results
71		* @param array $columnDef
72		* @param array $templates
73		* @param int $start
74		*/
75		public function __construct($results, array $columnDef, array $templates, $start)
76		{
77		$this->results = $results;
78		$this->appendColumns = $columnDef['append'];
79		$this->editColumns = $columnDef['edit'];
80		$this->excessColumns = $columnDef['excess'];
81		$this->onlyColumns = $columnDef['only'];
		0 ignored issues – show Bug introduced 2018-10-05 05:58 UTC by Report Bug Copy Issue Report The property `onlyColumns` 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...
82		$this->escapeColumns = $columnDef['escape'];
83		$this->includeIndex = $columnDef['index'];
84		$this->rawColumns = $columnDef['raw'];
85		$this->templates = $templates;
86		$this->start = $start;
87		}
88
89		/**
90		* Process data to output on browser.
91		*
92		* @param bool $object
93		* @return array
94		*/
95		public function process($object = false)
96		{
97		$this->output = [];
98		$indexColumn = config('datatables.index_column', 'DT_RowIndex');
99
100		foreach ($this->results as $row) {
101		$data = Helper::convertToArray($row);
102		$value = $this->addColumns($data, $row);
103		$value = $this->editColumns($value, $row);
104		$value = $this->setupRowVariables($value, $row);
105		$value = $this->selectOnlyNeededColumns($value);
106		$value = $this->removeExcessColumns($value);
107
108		if ($this->includeIndex) {
109		$value[$indexColumn] = ++$this->start;
110		}
111
112		$this->output[] = $object ? $value : $this->flatten($value);
113		}
114
115		return $this->escapeColumns($this->output);
116		}
117
118		/**
119		* Process add columns.
120		*
121		* @param mixed $data
122		* @param mixed $row
123		* @return array
124		*/
125	View Code Duplication	protected function addColumns($data, $row)
		0 ignored issues – show Duplication introduced 2017-08-01 03:31 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
126		{
127		foreach ($this->appendColumns as $key => $value) {
128		$value['content'] = Helper::compileContent($value['content'], $data, $row);
129		$data = Helper::includeInArray($value, $data);
130		}
131
132		return $data;
133		}
134
135		/**
136		* Process edit columns.
137		*
138		* @param mixed $data
139		* @param mixed $row
140		* @return array
141		*/
142	View Code Duplication	protected function editColumns($data, $row)
		0 ignored issues – show Duplication introduced 2017-08-01 03:31 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
143		{
144		foreach ($this->editColumns as $key => $value) {
145		$value['content'] = Helper::compileContent($value['content'], $data, $row);
146		Arr::set($data, $value['name'], $value['content']);
147		}
148
149		return $data;
150		}
151
152		/**
153		* Setup additional DT row variables.
154		*
155		* @param mixed $data
156		* @param mixed $row
157		* @return array
158		*/
159		protected function setupRowVariables($data, $row)
160		{
161		$processor = new RowProcessor($data, $row);
162
163		return $processor
164		->rowValue('DT_RowId', $this->templates['DT_RowId'])
165		->rowValue('DT_RowClass', $this->templates['DT_RowClass'])
166		->rowData('DT_RowData', $this->templates['DT_RowData'])
167		->rowData('DT_RowAttr', $this->templates['DT_RowAttr'])
168		->getData();
169		}
170
171		/**
172		* Get only needed columns.
173		*
174		* @param array $data
175		* @return array
176		*/
177		protected function selectOnlyNeededColumns(array $data)
178		{
179		if (is_null($this->onlyColumns)) {
180		return $data;
181		} else {
182		return array_intersect_key($data, array_flip(array_merge($this->onlyColumns, $this->exceptions)));
183		}
184		}
185
186		/**
187		* Remove declared hidden columns.
188		*
189		* @param array $data
190		* @return array
191		*/
192		protected function removeExcessColumns(array $data)
193		{
194		foreach ($this->excessColumns as $value) {
195		unset($data[$value]);
196		}
197
198		return $data;
199		}
200
201		/**
202		* Flatten array with exceptions.
203		*
204		* @param array $array
205		* @return array
206		*/
207		public function flatten(array $array)
208		{
209		$return = [];
210		foreach ($array as $key => $value) {
211		if (in_array($key, $this->exceptions)) {
212		$return[$key] = $value;
213		} else {
214		$return[] = $value;
215		}
216		}
217
218		return $return;
219		}
220
221		/**
222		* Escape column values as declared.
223		*
224		* @param array $output
225		* @return array
226		*/
227		protected function escapeColumns(array $output)
228		{
229		return array_map(function ($row) {
230		if ($this->escapeColumns == '*') {
231		$row = $this->escapeRow($row);
232		} elseif (is_array($this->escapeColumns)) {
233		$columns = array_diff($this->escapeColumns, $this->rawColumns);
234		foreach ($columns as $key) {
235		array_set($row, $key, e(array_get($row, $key)));
236		}
237		}
238
239		return $row;
240		}, $output);
241		}
242
243		/**
244		* Escape all values of row.
245		*
246		* @param array $row
247		* @return array
248		*/
249		protected function escapeRow(array $row)
250		{
251		$arrayDot = array_filter(array_dot($row));
252		foreach ($arrayDot as $key => $value) {
253		if (! in_array($key, $this->rawColumns)) {
254		$arrayDot[$key] = e($value);
255		}
256		}
257
258		foreach ($arrayDot as $key => $value) {
259		array_set($row, $key, $value);
260		}
261
262		return $row;
263		}
264		}
265

yajra / laravel-datatables

Push — master ( 920cd0...253df5 )

DataProcessor::escapeColumns() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like