phpMv /
phpMv-UI
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:
Complex classes like HtmlGrid 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 HtmlGrid, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 19 | class HtmlGrid extends HtmlSemCollection { |
||
| 20 | use TextAlignmentTrait; |
||
| 21 | private $_createCols; |
||
| 22 | private $_colSizing=true; |
||
| 23 | private $_implicitRows=false; |
||
| 24 | |||
| 25 | public function __construct($identifier, $numRows=1, $numCols=NULL, $createCols=true, $implicitRows=false) { |
||
| 38 | |||
| 39 | public function asSegment() { |
||
| 42 | |||
| 43 | public function asContainer() { |
||
| 46 | |||
| 47 | /** |
||
| 48 | * Defines the grid width (alias for setWidth) |
||
| 49 | * @param int $wide |
||
| 50 | */ |
||
| 51 | View Code Duplication | public function setWide($wide) { |
|
| 59 | |||
| 60 | /** |
||
| 61 | * Defines the grid width |
||
| 62 | * @param int $width |
||
| 63 | * @return \Ajax\semantic\html\collections\HtmlGrid |
||
| 64 | */ |
||
| 65 | public function setWidth($width) { |
||
| 68 | |||
| 69 | /** |
||
| 70 | * Adds a row with $colsCount columns |
||
| 71 | * @param int $colsCount number of columns to create |
||
| 72 | * @return mixed |
||
| 73 | */ |
||
| 74 | public function addRow($colsCount=NULL) { |
||
| 79 | |||
| 80 | /** |
||
| 81 | * Adds a col |
||
| 82 | * @param int $width with of the column to add |
||
| 83 | * @return mixed|\Ajax\semantic\html\collections\HtmlGrid |
||
| 84 | */ |
||
| 85 | public function addCol($width=NULL) { |
||
| 92 | |||
| 93 | /** |
||
| 94 | * |
||
| 95 | * @param array $sizes array of width of the columns to create |
||
| 96 | * @return \Ajax\semantic\html\collections\HtmlGrid |
||
| 97 | */ |
||
| 98 | public function addCols($sizes=array()) { |
||
| 104 | |||
| 105 | /** |
||
| 106 | * Create $rowsCount rows |
||
| 107 | * @param int $rowsCount |
||
| 108 | * @param int $colsCount |
||
| 109 | * @return \Ajax\semantic\html\collections\HtmlGrid |
||
| 110 | */ |
||
| 111 | public function setRowsCount($rowsCount, $colsCount=NULL, $force=false) { |
||
| 131 | |||
| 132 | protected function hasOnlyCols($count) { |
||
| 135 | |||
| 136 | /** |
||
| 137 | * Defines the number of columns in the grid |
||
| 138 | * @param int $numCols |
||
| 139 | * @param boolean $toCreate |
||
| 140 | * @param int $width |
||
| 141 | * @return \Ajax\semantic\html\collections\HtmlGrid |
||
| 142 | */ |
||
| 143 | public function setColsCount($numCols, $toCreate=true, $width=NULL) { |
||
| 161 | |||
| 162 | /** |
||
| 163 | * return the row at $index |
||
| 164 | * @param int $index |
||
| 165 | * @return \Ajax\semantic\html\collections\HtmlGridRow |
||
| 166 | */ |
||
| 167 | public function getRow($index) { |
||
| 170 | |||
| 171 | /** |
||
| 172 | * Returns the row count |
||
| 173 | * @return int |
||
| 174 | */ |
||
| 175 | public function rowCount() { |
||
| 181 | |||
| 182 | /** |
||
| 183 | * Returns the column count |
||
| 184 | * @return int |
||
| 185 | */ |
||
| 186 | public function colCount() { |
||
| 194 | |||
| 195 | /** |
||
| 196 | * Returns the cell (HtmlGridCol) at position rrow,$col |
||
| 197 | * @param int $row |
||
| 198 | * @param int $col |
||
| 199 | * @return \Ajax\semantic\html\collections\HtmlGridCol |
||
| 200 | */ |
||
| 201 | public function getCell($row, $col) { |
||
| 210 | |||
| 211 | /** |
||
| 212 | * Adds dividers between columns ($vertically=false) or between rows ($vertically=true) |
||
| 213 | * @param boolean $vertically |
||
| 214 | * @return \Ajax\semantic\html\collections\HtmlGrid |
||
| 215 | */ |
||
| 216 | public function setDivided($vertically=false) { |
||
| 220 | |||
| 221 | /** |
||
| 222 | * Divides rows into cells |
||
| 223 | * @param boolean $internally true for internal cells |
||
| 224 | * @return \Ajax\semantic\html\collections\HtmlGrid |
||
| 225 | */ |
||
| 226 | public function setCelled($internally=false) { |
||
| 230 | |||
| 231 | /** |
||
| 232 | * A grid can have its columns centered |
||
| 233 | */ |
||
| 234 | public function setCentered() { |
||
| 237 | |||
| 238 | /** |
||
| 239 | * automatically resize all elements to split the available width evenly |
||
| 240 | * @return \Ajax\semantic\html\collections\HtmlGrid |
||
| 241 | */ |
||
| 242 | public function setEqualWidth() { |
||
| 245 | |||
| 246 | /** |
||
| 247 | * Adds vertical or/and horizontal gutters |
||
| 248 | * @param string $value |
||
| 249 | * @return \Ajax\semantic\html\collections\HtmlGrid |
||
| 250 | */ |
||
| 251 | public function setPadded($value=NULL) { |
||
| 256 | |||
| 257 | /** |
||
| 258 | * |
||
| 259 | * @param boolean $very |
||
| 260 | * @return \Ajax\semantic\html\collections\HtmlGrid |
||
| 261 | */ |
||
| 262 | public function setRelaxed($very=false) { |
||
| 266 | |||
| 267 | public function setVerticalAlignment($value=VerticalAlignment::MIDDLE) { |
||
| 270 | |||
| 271 | /** |
||
| 272 | * |
||
| 273 | * {@inheritDoc} |
||
| 274 | * |
||
| 275 | * @see \Ajax\common\html\HtmlCollection::createItem() |
||
| 276 | */ |
||
| 277 | protected function createItem($value) { |
||
| 283 | |||
| 284 | /** |
||
| 285 | * Sets $values to the grid |
||
| 286 | * @param array $values |
||
| 287 | */ |
||
| 288 | public function setValues($values, $force=true) { |
||
| 302 | |||
| 303 | public function setColWidth($numCol,$width){ |
||
| 309 | |||
| 310 | /** |
||
| 311 | * stretch the row contents to take up the entire column height |
||
| 312 | * @return \Ajax\semantic\html\content\HtmlGridRow |
||
| 313 | */ |
||
| 314 | public function setStretched() { |
||
| 317 | |||
| 318 | public function addDivider($afterColIndex, $vertical=true, $content=NULL) { |
||
| 322 | } |
Loading history...
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.