Row - Code Metrics - ublaboo/datagrid - Measure and Improve Code Quality continuously with Scrutinizer

Row B
last analyzed 2018-05-01 21:27 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	317
Duplicated Lines	19.56 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

40.45%

Importance

Changes	4
Bugs	0	Features	1

Metric	Value
wmc	44
c	4
b	0
f	1
lcom	2
cbo	3
dl	62
loc	317
rs	8.3396
ccs	36
cts	89
cp	0.4045

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	2
A	getId()	0	4	1
C	getValue()	0	27	7
A	getControl()	0	4	1
A	getControlClass()	0	8	2
C	getActiveRowProperty()	18	24	7
B	getLeanMapperEntityProperty()	22	22	4
B	getNextrasEntityProperty()	22	22	4
B	getDoctrineEntityProperty()	0	23	5
A	getItem()	0	4	1
A	hasGroupAction()	0	6	2
A	hasAction()	0	6	2
A	hasInlineEdit()	0	6	2
A	applyColumnCallback()	0	10	2
A	formatDibiRowKey()	0	8	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Row often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Row, and based on these observations, apply Extract Interface, too.

<?php

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

namespace Ublaboo\DataGrid;

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

class Row
{

	use SmartObject;

	/**
	 * @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) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
			return $this->getLeanMapperEntityProperty($this->item, $key);

		} elseif ($this->item instanceof Nextras\Orm\Entity\Entity) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
			return $this->getNextrasEntityProperty($this->item, $key);

		} elseif ($this->item instanceof DibiRow) {

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

		} elseif ($this->item instanceof ActiveRow) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
			return $this->getActiveRowProperty($this->item, $key);

		} elseif ($this->item instanceof Nette\Database\Row) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
			return $this->item->{$key};

		} elseif (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 = $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 = $item->ref($referencedTable, $throughColumn);

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

		return $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;
	}
}


Row B
last analyzed 2018-05-01 21:27 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

15 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

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

ublaboo / datagrid

Row B last analyzed 2018-05-01 21:27 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

15 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like

Row B
last analyzed 2018-05-01 21:27 UTC