Row::getActiveRowProperty() - Code Metrics - Inspection of "Row update: ActiveRow property moved to separate m..." - ublaboo/datagrid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 655b5a...34bcd6 )

by Pavel

created 2016-12-24 10:34 UTC

Row::getActiveRowProperty() C

↳ Parent: Row

Complexity

Conditions	7
Paths	9

Size

Total Lines	24
Code Lines	14

Duplication

Lines	18
Ratio	75 %

Code Coverage

Tests	1
CRAP Score	45.5427

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	18
loc	24
ccs	1
cts	13
cp	0.0769
rs	6.7272
cc	7
eloc	14
nc	9
nop	2
crap	45.5427

<?php

/**
 * @copyright   Copyright (c) 2015 ublaboo <[email protected]>
 * @author      Pavel Janda <[email protected]>
 * @package     Ublaboo
 */

namespace Ublaboo\DataGrid;

use Nette;
use LeanMapper;
use Nextras;
use DibiRow;
use Ublaboo\DataGrid\Utils\PropertyAccessHelper;
use Nette\Utils\Html;
use Ublaboo\DataGrid\Exception\DataGridException;
use Nette\Database\Table\ActiveRow;

class Row extends Nette\Object
{

	/**
	 * @var DataGrid
	 */
	protected $datagrid;

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

	/**
	 * @var string
	 */
	protected $primary_key;

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

	/**
	 * @var Html
	 */
	protected $control;


	/**
	 * @param DataGrid $datagrid
	 * @param mixed    $item
	 * @param string   $primary_key
	 */
	public function __construct(DataGrid $datagrid, $item, $primary_key)
	{
		$this->control = Html::el('tr');
		$this->datagrid = $datagrid;
		$this->item = $item;
		$this->primary_key = $primary_key;
		$this->id = $this->getValue($primary_key);

		if ($datagrid->hasColumnsSummary()) {
			$datagrid->getColumnsSummary()->add($this);
		}
	}


	/**
	 * Get id value of item
	 * @return mixed
	 */
	public function getId()
	{
		return $this->id;
	}


	/**
	 * Get item value of key
	 * @param  mixed $key
	 * @return mixed
	 */
	public function getValue($key)
	{
		if ($this->item instanceof LeanMapper\Entity) {
			return $this->getLeanMapperEntityProperty($this->item, $key);

		} else if ($this->item instanceof Nextras\Orm\Entity\Entity) {
			return $this->getNextrasEntityProperty($this->item, $key);

		} else if ($this->item instanceof DibiRow) {

			return $this->item->{$this->formatDibiRowKey($key)};

		} else if ($this->item instanceof ActiveRow) {
			return $this->getActiveRowProperty($this->item, $key);

		} else if ($this->item instanceof Nette\Database\Row) {
			return $this->item->{$key};

		} else if (is_array($this->item)) {
			return $this->item[$key];

		} else {
			/**
			 * Doctrine entity
			 */
			return $this->getDoctrineEntityProperty($this->item, $key);

		}
	}


	/**
	 * @return Html
	 */
	public function getControl()
	{
		return $this->control;
	}


	/**
	 * @return string
	 */
	public function getControlClass()
	{
		if (!$class = $this->control->class) {
			return '';
		}

		return implode(' ', array_keys($class));
	}


	/**
	 * @param  ActiveRow $item
	 * @param  string    $key
	 * @return mixed|NULL
	 */
	public function getActiveRowProperty(ActiveRow $item, $key)

	{
		if (preg_match("/^:([a-zA-Z0-9_$]+)\.([a-zA-Z0-9_$]+)(:([a-zA-Z0-9_$]+))?$/", $key, $matches)) {

			$relatedTable = $matches[1];
			$relatedColumn = $matches[2];
			$throughColumn = isset($matches[4]) ? $matches[4] : NULL;

			$relatedRow = $this->item->related($relatedTable, $throughColumn)->fetch();

			return $relatedRow ? $relatedRow->{$relatedColumn} : NULL;
		}

		if (preg_match("/^([a-zA-Z0-9_$]+)\.([a-zA-Z0-9_$]+)(:([a-zA-Z0-9_$]+))?$/", $key, $matches)) {

			$referencedTable = $matches[1];
			$referencedColumn = $matches[2];
			$throughColumn = isset($matches[4]) ? $matches[4] : NULL;

			$referencedRow = $this->item->ref($referencedTable, $throughColumn);

			return $referencedRow ? $referencedRow->{$referencedColumn} : NULL;
		}

		return $this->item->{$key};
	}


	/**
	 * LeanMapper: Access object properties to get a item value
	 * @param  LeanMapper\Entity $item
	 * @param  mixed             $key
	 * @return mixed
	 */
	public function getLeanMapperEntityProperty(LeanMapper\Entity $item, $key)

	{
		$properties = explode('.', $key);
		$value = $item;

		while ($property = array_shift($properties)) {
			if (!isset($value->{$property})) {
				if ($this->datagrid->strict_entity_property) {
					throw new DataGridException(sprintf(
						'Target Property [%s] is not an object or is empty, trying to get [%s]',
						$value, str_replace('.', '->', $key)
					));
				}

				return NULL;
			}

			$value = $value->{$property};
		}

		return $value;
	}


	/**
	 * Nextras: Access object properties to get a item value
	 * @param  Nextras\Orm\Entity\Entity $item
	 * @param  string                    $key
	 * @return mixed
	 */
	public function getNextrasEntityProperty(Nextras\Orm\Entity\Entity $item, $key)

	{
		$properties = explode('.', $key);
		$value = $item;

		while ($property = array_shift($properties)) {
			if (!isset($value->{$property})) {
				if ($this->datagrid->strict_entity_property) {
					throw new DataGridException(sprintf(
						'Target Property [%s] is not an object or is empty, trying to get [%s]',
						$value, str_replace('.', '->', $key)
					));
				}

				return NULL;
			}

			$value = $value->{$property};
		}

		return $value;
	}


	/**
	 * Doctrine: Access object properties to get a item value
	 * @param  mixed $item
	 * @param  mixed $key
	 * @return mixed
	 */
	public function getDoctrineEntityProperty($item, $key)
	{
		$properties = explode('.', $key);
		$value = $item;
		$accessor = PropertyAccessHelper::getAccessor();

		while ($property = array_shift($properties)) {
			if (!is_object($value) && !$value) {
				if ($this->datagrid->strict_entity_property) {
					throw new DataGridException(sprintf(
						'Target Property [%s] is not an object or is empty, trying to get [%s]',
						$value, str_replace('.', '->', $key)
					));
				}

				return NULL;
			}

			$value = $accessor->getValue($value, $property);
		}

		return $value;
	}


	/**
	 * Get original item
	 * @return mixed
	 */
	public function getItem()
	{
		return $this->item;
	}


	/**
	 * Has particular row group actions allowed?
	 * @return bool
	 */
	public function hasGroupAction()
	{
		$condition = $this->datagrid->getRowCondition('group_action');

		return $condition ? $condition($this->item) : TRUE;
	}


	/**
	 * Has particular row a action allowed?
	 * @param  mixed  $key
	 * @return bool
	 */
	public function hasAction($key)
	{
		$condition = $this->datagrid->getRowCondition('action', $key);

		return $condition ? $condition($this->item) : TRUE;
	}


	/**
	 * Has particular row inlie edit allowed?
	 * @return bool
	 */
	public function hasInlineEdit()
	{
		$condition = $this->datagrid->getRowCondition('inline_edit');

		return $condition ? $condition($this->item) : TRUE;
	}


	/**
	 * @param  string        $key
	 * @param  Column\Column $column
	 * @return void
	 */
	public function applyColumnCallback($key, Column\Column $column)
	{
		$callback = $this->datagrid->getColumnCallback($key);

		if ($callback !== NULL) {
			call_user_func($callback, $column, $this->getItem());
		}

		return $column;
	}


	/**
	 * Key may contain ".", get rid of it (+ the table alias)
	 * 
	 * @param  string $key
	 * @return string
	 */
	private function formatDibiRowKey($key)
	{
		if ($offset = strpos($key, '.')) {
			return substr($key, $offset + 1);
		}

		return $key;
	}

}


1			<?php
2
3			/**
4			* @copyright Copyright (c) 2015 ublaboo <[email protected]>
5			* @author Pavel Janda <[email protected]>
6			* @package Ublaboo
7			*/
8
9			namespace Ublaboo\DataGrid;
10
11			use Nette;
12			use LeanMapper;
13			use Nextras;
14			use DibiRow;
15			use Ublaboo\DataGrid\Utils\PropertyAccessHelper;
16			use Nette\Utils\Html;
17			use Ublaboo\DataGrid\Exception\DataGridException;
18			use Nette\Database\Table\ActiveRow;
19
20			class Row extends Nette\Object
21	1		{
22
23	1		/**
24			* @var DataGrid
25			*/
26			protected $datagrid;
27
28			/**
29			* @var mixed
30			*/
31			protected $item;
32
33			/**
34			* @var string
35			*/
36			protected $primary_key;
37
38			/**
39			* @var mixed
40			*/
41			protected $id;
42
43			/**
44			* @var Html
45			*/
46			protected $control;
47
48
49			/**
50			* @param DataGrid $datagrid
51			* @param mixed $item
52			* @param string $primary_key
53			*/
54			public function __construct(DataGrid $datagrid, $item, $primary_key)
55			{
56	1		$this->control = Html::el('tr');
57	1		$this->datagrid = $datagrid;
58	1		$this->item = $item;
59	1		$this->primary_key = $primary_key;
60	1		$this->id = $this->getValue($primary_key);
61
62	1		if ($datagrid->hasColumnsSummary()) {
63			$datagrid->getColumnsSummary()->add($this);
64			}
65	1		}
66
67
68			/**
69			* Get id value of item
70			* @return mixed
71			*/
72			public function getId()
73			{
74	1		return $this->id;
75			}
76
77
78			/**
79			* Get item value of key
80			* @param mixed $key
81			* @return mixed
82			*/
83			public function getValue($key)
84			{
85	1		if ($this->item instanceof LeanMapper\Entity) {
86	1		return $this->getLeanMapperEntityProperty($this->item, $key);
87
88	1		} else if ($this->item instanceof Nextras\Orm\Entity\Entity) {
89			return $this->getNextrasEntityProperty($this->item, $key);
90
91	1		} else if ($this->item instanceof DibiRow) {
			0 ignored issues – show Bug introduced 2016-02-03 08:01 UTC by Report Bug Copy Issue Report The class `DibiRow` does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json? Loading history...
92			return $this->item->{$this->formatDibiRowKey($key)};
93
94	1		} else if ($this->item instanceof ActiveRow) {
95			return $this->getActiveRowProperty($this->item, $key);
96
97	1		} else if ($this->item instanceof Nette\Database\Row) {
98			return $this->item->{$key};
99
100	1		} else if (is_array($this->item)) {
101	1		return $this->item[$key];
102
103			} else {
104			/**
105			* Doctrine entity
106			*/
107	1		return $this->getDoctrineEntityProperty($this->item, $key);
108
109			}
110			}
111
112
113			/**
114			* @return Html
115			*/
116			public function getControl()
117			{
118	1		return $this->control;
119			}
120
121
122			/**
123			* @return string
124			*/
125			public function getControlClass()
126			{
127	1		if (!$class = $this->control->class) {
128			return '';
129			}
130
131	1		return implode(' ', array_keys($class));
132			}
133
134
135			/**
136			* @param ActiveRow $item
137			* @param string $key
138			* @return mixed\|NULL
139			*/
140			public function getActiveRowProperty(ActiveRow $item, $key)
			0 ignored issues – show Unused Code introduced 2016-12-24 10:36 UTC by Report Bug Copy Issue Report The parameter `$item` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
141			{
142		View Code Duplication	if (preg_match("/^:([a-zA-Z0-9_$]+)\.([a-zA-Z0-9_$]+)(:([a-zA-Z0-9_$]+))?$/", $key, $matches)) {
			0 ignored issues – show Duplication introduced 2016-12-24 10:36 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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			$relatedTable = $matches[1];
144			$relatedColumn = $matches[2];
145			$throughColumn = isset($matches[4]) ? $matches[4] : NULL;
146
147			$relatedRow = $this->item->related($relatedTable, $throughColumn)->fetch();
148
149			return $relatedRow ? $relatedRow->{$relatedColumn} : NULL;
150			}
151
152	1	View Code Duplication	if (preg_match("/^([a-zA-Z0-9_$]+)\.([a-zA-Z0-9_$]+)(:([a-zA-Z0-9_$]+))?$/", $key, $matches)) {
			0 ignored issues – show Duplication introduced 2016-12-24 10:36 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
153			$referencedTable = $matches[1];
154			$referencedColumn = $matches[2];
155			$throughColumn = isset($matches[4]) ? $matches[4] : NULL;
156
157			$referencedRow = $this->item->ref($referencedTable, $throughColumn);
158
159			return $referencedRow ? $referencedRow->{$referencedColumn} : NULL;
160			}
161
162			return $this->item->{$key};
163			}
164
165
166			/**
167			* LeanMapper: Access object properties to get a item value
168			* @param LeanMapper\Entity $item
169			* @param mixed $key
170			* @return mixed
171			*/
172		View Code Duplication	public function getLeanMapperEntityProperty(LeanMapper\Entity $item, $key)
			0 ignored issues – show Duplication introduced 2016-06-29 08:11 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...
173			{
174	1		$properties = explode('.', $key);
175	1		$value = $item;
176
177	1		while ($property = array_shift($properties)) {
178	1		if (!isset($value->{$property})) {
179			if ($this->datagrid->strict_entity_property) {
180			throw new DataGridException(sprintf(
181			'Target Property [%s] is not an object or is empty, trying to get [%s]',
182			$value, str_replace('.', '->', $key)
183			));
184			}
185
186			return NULL;
187			}
188
189	1		$value = $value->{$property};
190	1		}
191
192	1		return $value;
193			}
194
195
196			/**
197			* Nextras: Access object properties to get a item value
198			* @param Nextras\Orm\Entity\Entity $item
199			* @param string $key
200			* @return mixed
201			*/
202		View Code Duplication	public function getNextrasEntityProperty(Nextras\Orm\Entity\Entity $item, $key)
			0 ignored issues – show Duplication introduced 2016-06-29 08:11 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...
203			{
204			$properties = explode('.', $key);
205			$value = $item;
206
207			while ($property = array_shift($properties)) {
208			if (!isset($value->{$property})) {
209	1		if ($this->datagrid->strict_entity_property) {
210			throw new DataGridException(sprintf(
211			'Target Property [%s] is not an object or is empty, trying to get [%s]',
212			$value, str_replace('.', '->', $key)
213			));
214			}
215
216			return NULL;
217			}
218
219			$value = $value->{$property};
220			}
221
222			return $value;
223			}
224
225
226			/**
227			* Doctrine: Access object properties to get a item value
228			* @param mixed $item
229			* @param mixed $key
230			* @return mixed
231			*/
232			public function getDoctrineEntityProperty($item, $key)
233			{
234	1		$properties = explode('.', $key);
235	1		$value = $item;
236	1		$accessor = PropertyAccessHelper::getAccessor();
237
238	1		while ($property = array_shift($properties)) {
239	1		if (!is_object($value) && !$value) {
240			if ($this->datagrid->strict_entity_property) {
241			throw new DataGridException(sprintf(
242			'Target Property [%s] is not an object or is empty, trying to get [%s]',
243			$value, str_replace('.', '->', $key)
244			));
245			}
246
247			return NULL;
248			}
249
250	1		$value = $accessor->getValue($value, $property);
251	1		}
252
253	1		return $value;
254			}
255
256
257			/**
258			* Get original item
259			* @return mixed
260			*/
261			public function getItem()
262			{
263			return $this->item;
264			}
265
266
267			/**
268			* Has particular row group actions allowed?
269			* @return bool
270			*/
271			public function hasGroupAction()
272			{
273			$condition = $this->datagrid->getRowCondition('group_action');
274
275			return $condition ? $condition($this->item) : TRUE;
276			}
277
278
279			/**
280			* Has particular row a action allowed?
281			* @param mixed $key
282			* @return bool
283			*/
284			public function hasAction($key)
285			{
286			$condition = $this->datagrid->getRowCondition('action', $key);
287
288			return $condition ? $condition($this->item) : TRUE;
289			}
290
291
292			/**
293			* Has particular row inlie edit allowed?
294			* @return bool
295			*/
296			public function hasInlineEdit()
297			{
298			$condition = $this->datagrid->getRowCondition('inline_edit');
299
300			return $condition ? $condition($this->item) : TRUE;
301			}
302
303
304			/**
305			* @param string $key
306			* @param Column\Column $column
307			* @return void
308			*/
309			public function applyColumnCallback($key, Column\Column $column)
310			{
311			$callback = $this->datagrid->getColumnCallback($key);
312
313			if ($callback !== NULL) {
314			call_user_func($callback, $column, $this->getItem());
315			}
316
317			return $column;
318			}
319
320
321			/**
322			* Key may contain ".", get rid of it (+ the table alias)
323			*
324			* @param string $key
325			* @return string
326			*/
327			private function formatDibiRowKey($key)
328			{
329			if ($offset = strpos($key, '.')) {
330			return substr($key, $offset + 1);
331			}
332
333			return $key;
334			}
335
336			}
337

ublaboo / datagrid

Push — master ( 655b5a...34bcd6 )

Row::getActiveRowProperty() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like