HtmlTableContent - Code Metrics - Inspection of "Refactoring properties Ctrl" - jcheron/phalcon-jquery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ea2a7d...e9bdcb )

by Jean-Christophe

created 2016-04-30 01:20 UTC

HtmlTableContent B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	215
Duplicated Lines	5.12 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
wmc	40
c	5
b	0
f	0
lcom	1
cbo	3
dl	11
loc	215
rs	8.2608

20 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	3
A	setRowCount()	0	12	3
A	getTdTagName()	0	3	1
A	createItem()	0	10	2
A	addRow()	0	3	1
A	getCell()	0	7	2
A	getRow()	0	3	1
A	setCellValue()	0	7	2
B	setValues()	0	18	5
A	setColValues()	11	11	3
A	addColVariations()	0	7	2
A	setRowValues()	0	8	2
A	colCenter()	0	7	2
A	colRight()	0	7	2
A	getRowCount()	0	3	1
A	getColCount()	0	6	2
A	delete()	0	11	3
A	mergeCol()	0	3	1
A	mergeRow()	0	3	1
A	setFullWidth()	0	3	1

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 HtmlTableContent 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 HtmlTableContent, and based on these observations, apply Extract Interface, too.

<?php

namespace Ajax\semantic\html\content\table;

use Ajax\semantic\html\base\HtmlSemCollection;
use Ajax\service\JArray;

/**
 * a table content (thead, tbody or tfoot)
 * @author jc
 *
 */
class HtmlTableContent extends HtmlSemCollection {
	protected $_tdTagNames=[ "thead" => "th","tbody" => "td","tfoot" => "th" ];

	/**
	 *
	 * @param string $identifier
	 * @param string $tagName
	 * @param int $rowCount
	 * @param int $colCount
	 */
	public function __construct($identifier, $tagName="tbody", $rowCount=NULL, $colCount=NULL) {
		parent::__construct($identifier, $tagName, "");
		if (isset($rowCount) && isset($colCount))
			$this->setRowCount($rowCount, $colCount);
	}

	/**
	 *
	 * @param int $rowCount
	 * @param int $colCount
	 * @return \Ajax\semantic\html\content\table\HtmlTableContent
	 */
	public function setRowCount($rowCount, $colCount) {
		$count=$this->count();
		for($i=$count; $i < $rowCount; $i++) {
			$this->addItem(NULL);
		}
		for($i=0; $i < $rowCount; $i++) {
			$item=$this->content[$i];
			$item->setTdTagName($this->_tdTagNames[$this->tagName]);
			$this->content[$i]->setColCount($colCount);
		}
		return $this;
	}

	public function getTdTagName($tagName) {

		return $this->_tdTagNames[$this->tagName];
	}

	/**
	 *
	 * {@inheritDoc}
	 *
	 * @see \Ajax\common\html\HtmlCollection::createItem()
	 */
	protected function createItem($value) {
		$count=$this->count();
		$tr=new HtmlTR("", $value);

		$tr->setContainer($this, $count);
		$tr->setTdTagName($this->_tdTagNames[$this->tagName]);
		if (isset($value) === true) {
			$tr->setColCount($value);
		}
		return $tr;
	}

	public function addRow($colCount) {
		return $this->addItem($colCount);
	}

	/**
	 * Returns the cell (HtmlTD) at position $row,$col
	 * @param int $row
	 * @param int $col
	 * @return \Ajax\semantic\html\content\HtmlTD
	 */
	public function getCell($row, $col) {
		$row=$this->getItem($row);
		if (isset($row)) {
			$col=$row->getItem($col);
		}
		return $col;
	}

	/**
	 *
	 * @param int $index
	 * @return \Ajax\semantic\html\content\HtmlTR
	 */
	public function getRow($index) {
		return $this->getItem($index);
	}

	/**
	 *
	 * @param int $row
	 * @param int $col
	 * @param mixed $value
	 * @return \Ajax\semantic\html\content\table\HtmlTableContent
	 */
	public function setCellValue($row, $col, $value="") {
		$cell=$this->getCell($row, $col);
		if (isset($cell) === true) {
			$cell->setValue($value);
		}
		return $this;
	}

	/**
	 * Sets the cells values
	 * @param mixed $values
	 */
	public function setValues($values=array()) {
		$count=$this->count();
		$isArray=true;
		if (\is_array($values) === false) {
			$values=\array_fill(0, $count, $values);
			$isArray=false;
		}
		if (JArray::dimension($values) == 1 && $isArray)
			$values=[ $values ];
		
		$count=\min(\sizeof($values), $count);
		
		for($i=0; $i < $count; $i++) {
			$row=$this->content[$i];
			$row->setValues($values[$i]);
		}
		return $this;
	}

	public function setColValues($colIndex, $values=array()) {

		$count=$this->count();
		if (\is_array($values) === false) {
			$values=\array_fill(0, $count, $values);
		}
		$count=\min(\sizeof($values), $count);
		for($i=0; $i < $count; $i++) {
			$this->getCell($i, $colIndex)->setValue($values[$i]);
		}
		return $this;
	}

	public function addColVariations($colIndex, $variations=array()) {
		$count=$this->count();
		for($i=0; $i < $count; $i++) {
			$this->getCell($i, $colIndex)->addVariations($variations);
		}
		return $this;
	}

	public function setRowValues($rowIndex, $values=array()) {
		$count=$this->count();
		if (\is_array($values) === false) {
			$values=\array_fill(0, $count, $values);
		}
		$this->getItem($rowIndex)->setValues($values);

		return $this;
	}

	public function colCenter($colIndex) {
		$count=$this->count();
		for($i=0; $i < $count; $i++) {
			$this->getCell($i, $colIndex)->textCenterAligned();
		}
		return $this;
	}

	public function colRight($colIndex) {
		$count=$this->count();
		for($i=0; $i < $count; $i++) {
			$this->getCell($i, $colIndex)->textRightAligned();
		}
		return $this;
	}

	/**
	 * Returns the number of rows (TR)
	 * @return int
	 */
	public function getRowCount() {
		return $this->count();
	}

	/**
	 * Returns the number of columns (TD)
	 * @return int
	 */
	public function getColCount() {
		$result=0;
		if ($this->count() > 0)
			$result=$this->getItem(0)->getColCount();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
		return $result;
	}

	/**
	 * Removes the cell at position $rowIndex,$colIndex
	 * @param int $rowIndex
	 * @param int $colIndex
	 * @return \Ajax\semantic\html\content\table\HtmlTableContent
	 */
	public function delete($rowIndex, $colIndex=NULL) {
		if (isset($colIndex)) {
			$row=$this->getItem($rowIndex);
			if (isset($row) === true) {
				$row->delete($colIndex);
			}
		} else {
			$this->removeItem($rowIndex);
		}
		return $this;
	}

	public function mergeCol($rowIndex=0, $colIndex=0) {
		return $this->getItem($rowIndex)->mergeCol($colIndex);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
	}

	public function mergeRow($rowIndex=0, $colIndex=0) {
		return $this->getItem($rowIndex)->mergeRow($colIndex);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
	}

	public function setFullWidth() {
		return $this->addToProperty("class", "full-width");
	}
}

Push — master ( ea2a7d...e9bdcb )

HtmlTableContent B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

20 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

1		<?php
2
3		namespace Ajax\semantic\html\content\table;
4
5		use Ajax\semantic\html\base\HtmlSemCollection;
6		use Ajax\service\JArray;
7
8		/**
9		* a table content (thead, tbody or tfoot)
10		* @author jc
11		*
12		*/
13		class HtmlTableContent extends HtmlSemCollection {
14		protected $_tdTagNames=[ "thead" => "th","tbody" => "td","tfoot" => "th" ];
15
16		/**
17		*
18		* @param string $identifier
19		* @param string $tagName
20		* @param int $rowCount
21		* @param int $colCount
22		*/
23		public function __construct($identifier, $tagName="tbody", $rowCount=NULL, $colCount=NULL) {
24		parent::__construct($identifier, $tagName, "");
25		if (isset($rowCount) && isset($colCount))
26		$this->setRowCount($rowCount, $colCount);
27		}
28
29		/**
30		*
31		* @param int $rowCount
32		* @param int $colCount
33		* @return \Ajax\semantic\html\content\table\HtmlTableContent
34		*/
35		public function setRowCount($rowCount, $colCount) {
36		$count=$this->count();
37		for($i=$count; $i < $rowCount; $i++) {
38		$this->addItem(NULL);
39		}
40		for($i=0; $i < $rowCount; $i++) {
41		$item=$this->content[$i];
42		$item->setTdTagName($this->_tdTagNames[$this->tagName]);
43		$this->content[$i]->setColCount($colCount);
44		}
45		return $this;
46		}
47
48		public function getTdTagName($tagName) {
		0 ignored issues – show Unused Code introduced 2016-04-30 01:24 UTC by Report Bug Copy Issue Report The parameter `$tagName` 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...
49		return $this->_tdTagNames[$this->tagName];
50		}
51
52		/**
53		*
54		* {@inheritDoc}
55		*
56		* @see \Ajax\common\html\HtmlCollection::createItem()
57		*/
58		protected function createItem($value) {
59		$count=$this->count();
60		$tr=new HtmlTR("", $value);
		0 ignored issues – show Unused Code introduced 2016-04-30 01:24 UTC by Report Bug Copy Issue Report The call to `HtmlTR::__construct()` has too many arguments starting with `$value`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
61		$tr->setContainer($this, $count);
62		$tr->setTdTagName($this->_tdTagNames[$this->tagName]);
63		if (isset($value) === true) {
64		$tr->setColCount($value);
65		}
66		return $tr;
67		}
68
69		public function addRow($colCount) {
70		return $this->addItem($colCount);
71		}
72
73		/**
74		* Returns the cell (HtmlTD) at position $row,$col
75		* @param int $row
76		* @param int $col
77		* @return \Ajax\semantic\html\content\HtmlTD
78		*/
79		public function getCell($row, $col) {
80		$row=$this->getItem($row);
81		if (isset($row)) {
82		$col=$row->getItem($col);
83		}
84		return $col;
85		}
86
87		/**
88		*
89		* @param int $index
90		* @return \Ajax\semantic\html\content\HtmlTR
91		*/
92		public function getRow($index) {
93		return $this->getItem($index);
94		}
95
96		/**
97		*
98		* @param int $row
99		* @param int $col
100		* @param mixed $value
101		* @return \Ajax\semantic\html\content\table\HtmlTableContent
102		*/
103		public function setCellValue($row, $col, $value="") {
104		$cell=$this->getCell($row, $col);
105		if (isset($cell) === true) {
106		$cell->setValue($value);
107		}
108		return $this;
109		}
110
111		/**
112		* Sets the cells values
113		* @param mixed $values
114		*/
115		public function setValues($values=array()) {
116		$count=$this->count();
117		$isArray=true;
118		if (\is_array($values) === false) {
119		$values=\array_fill(0, $count, $values);
120		$isArray=false;
121		}
122		if (JArray::dimension($values) == 1 && $isArray)
123		$values=[ $values ];
124
125		$count=\min(\sizeof($values), $count);
126
127		for($i=0; $i < $count; $i++) {
128		$row=$this->content[$i];
129		$row->setValues($values[$i]);
130		}
131		return $this;
132		}
133
134	View Code Duplication	public function setColValues($colIndex, $values=array()) {
		0 ignored issues – show Duplication introduced 2016-04-28 00:37 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...
135		$count=$this->count();
136		if (\is_array($values) === false) {
137		$values=\array_fill(0, $count, $values);
138		}
139		$count=\min(\sizeof($values), $count);
140		for($i=0; $i < $count; $i++) {
141		$this->getCell($i, $colIndex)->setValue($values[$i]);
142		}
143		return $this;
144		}
145
146		public function addColVariations($colIndex, $variations=array()) {
147		$count=$this->count();
148		for($i=0; $i < $count; $i++) {
149		$this->getCell($i, $colIndex)->addVariations($variations);
150		}
151		return $this;
152		}
153
154		public function setRowValues($rowIndex, $values=array()) {
155		$count=$this->count();
156		if (\is_array($values) === false) {
157		$values=\array_fill(0, $count, $values);
158		}
159		$this->getItem($rowIndex)->setValues($values);
		0 ignored issues – show Bug introduced 2016-04-29 00:43 UTC by Report Bug Copy Issue Report The method `setValues()` does not exist on `Ajax\common\html\HtmlDoubleElement`. Did you maybe mean `setValue()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
160		return $this;
161		}
162
163		public function colCenter($colIndex) {
164		$count=$this->count();
165		for($i=0; $i < $count; $i++) {
166		$this->getCell($i, $colIndex)->textCenterAligned();
167		}
168		return $this;
169		}
170
171		public function colRight($colIndex) {
172		$count=$this->count();
173		for($i=0; $i < $count; $i++) {
174		$this->getCell($i, $colIndex)->textRightAligned();
175		}
176		return $this;
177		}
178
179		/**
180		* Returns the number of rows (TR)
181		* @return int
182		*/
183		public function getRowCount() {
184		return $this->count();
185		}
186
187		/**
188		* Returns the number of columns (TD)
189		* @return int
190		*/
191		public function getColCount() {
192		$result=0;
193		if ($this->count() > 0)
194		$result=$this->getItem(0)->getColCount();
		0 ignored issues – show Bug introduced 2016-04-27 00:48 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Ajax\common\html\HtmlDoubleElement` as the method `getColCount()` does only exist in the following sub-classes of `Ajax\common\html\HtmlDoubleElement`: `Ajax\semantic\html\content\table\HtmlTableContent`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
195		return $result;
196		}
197
198		/**
199		* Removes the cell at position $rowIndex,$colIndex
200		* @param int $rowIndex
201		* @param int $colIndex
202		* @return \Ajax\semantic\html\content\table\HtmlTableContent
203		*/
204		public function delete($rowIndex, $colIndex=NULL) {
205		if (isset($colIndex)) {
206		$row=$this->getItem($rowIndex);
207		if (isset($row) === true) {
208		$row->delete($colIndex);
209		}
210		} else {
211		$this->removeItem($rowIndex);
212		}
213		return $this;
214		}
215
216		public function mergeCol($rowIndex=0, $colIndex=0) {
217		return $this->getItem($rowIndex)->mergeCol($colIndex);
		0 ignored issues – show Bug introduced 2016-04-28 00:37 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Ajax\common\html\HtmlDoubleElement` as the method `mergeCol()` does only exist in the following sub-classes of `Ajax\common\html\HtmlDoubleElement`: `Ajax\semantic\html\content\table\HtmlTD`, `Ajax\semantic\html\content\table\HtmlTR`, `Ajax\semantic\html\content\table\HtmlTableContent`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
218		}
219
220		public function mergeRow($rowIndex=0, $colIndex=0) {
221		return $this->getItem($rowIndex)->mergeRow($colIndex);
		0 ignored issues – show Bug introduced 2016-04-28 00:37 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Ajax\common\html\HtmlDoubleElement` as the method `mergeRow()` does only exist in the following sub-classes of `Ajax\common\html\HtmlDoubleElement`: `Ajax\semantic\html\content\table\HtmlTD`, `Ajax\semantic\html\content\table\HtmlTR`, `Ajax\semantic\html\content\table\HtmlTableContent`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
222		}
223
224		public function setFullWidth() {
225		return $this->addToProperty("class", "full-width");
226		}
227		}

jcheron / phalcon-jquery

Push — master ( ea2a7d...e9bdcb )

HtmlTableContent B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

20 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like