Zenify /
CodingStandard
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 SwitchDeclarationSniff 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 SwitchDeclarationSniff, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 15 | class SwitchDeclarationSniff extends Squiz_Sniffs_ControlStructures_SwitchDeclarationSniff |
||
| 16 | { |
||
| 17 | |||
| 18 | /** |
||
| 19 | * The number of spaces code should be indented. |
||
| 20 | * |
||
| 21 | * @var int |
||
| 22 | */ |
||
| 23 | public $indent = 1; |
||
| 24 | |||
| 25 | /** |
||
| 26 | * @var array |
||
| 27 | */ |
||
| 28 | private $token; |
||
| 29 | |||
| 30 | /** |
||
| 31 | * @var array[] |
||
| 32 | */ |
||
| 33 | private $tokens; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * @var int |
||
| 37 | */ |
||
| 38 | private $position; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * @var PHP_CodeSniffer_File |
||
| 42 | */ |
||
| 43 | private $file; |
||
| 44 | |||
| 45 | |||
| 46 | /** |
||
| 47 | * {@inheritdoc} |
||
| 48 | */ |
||
| 49 | 1 | public function process(PHP_CodeSniffer_File $file, $position) |
|
| 105 | |||
| 106 | |||
| 107 | /** |
||
| 108 | * @param PHP_CodeSniffer_File $file |
||
| 109 | * @param int $position |
||
| 110 | * @param array $tokens |
||
| 111 | * @param string $type |
||
| 112 | * @param int $caseAlignment |
||
| 113 | */ |
||
| 114 | 1 | private function checkIfKeywordIsIndented(PHP_CodeSniffer_File $file, $position, $tokens, $type, $caseAlignment) |
|
| 121 | |||
| 122 | |||
| 123 | /** |
||
| 124 | * @param int $nextCase |
||
| 125 | * @param int $nextBreak |
||
| 126 | * @param string $type |
||
| 127 | */ |
||
| 128 | 1 | private function checkBreak($nextCase, $nextBreak, $type) |
|
| 171 | |||
| 172 | |||
| 173 | /** |
||
| 174 | * @return bool |
||
| 175 | */ |
||
| 176 | 1 | private function areSwitchStartAndEndKnown() |
|
| 188 | |||
| 189 | |||
| 190 | /** |
||
| 191 | * @param int $nextBreak |
||
| 192 | * @param int $nextCase |
||
| 193 | * @param int $caseAlignment |
||
| 194 | * @param string $type |
||
| 195 | * @param int $opener |
||
| 196 | */ |
||
| 197 | 1 | private function processSwitchStructureToken($nextBreak, $nextCase, $caseAlignment, $type, $opener) |
|
| 217 | |||
| 218 | |||
| 219 | /** |
||
| 220 | * @param int $nextLine |
||
| 221 | * @param int $breakLine |
||
| 222 | * @param int $nextBreak |
||
| 223 | */ |
||
| 224 | 1 | private function ensureBreakIsNotFollowedByBlankLine($nextLine, $breakLine, $nextBreak) |
|
| 231 | |||
| 232 | |||
| 233 | /** |
||
| 234 | * @param int $nextBreak |
||
| 235 | */ |
||
| 236 | 1 | private function ensureNoBlankLinesBeforeBreak($nextBreak) |
|
| 244 | |||
| 245 | |||
| 246 | /** |
||
| 247 | * @param int $nextCase |
||
| 248 | * @param int $nextBreak |
||
| 249 | * @param string $type |
||
| 250 | * @param int $opener |
||
| 251 | */ |
||
| 252 | 1 | private function ensureNoBlankLinesAfterStatement($nextCase, $nextBreak, $type, $opener) |
|
| 267 | |||
| 268 | |||
| 269 | /** |
||
| 270 | * @param int $nextBreak |
||
| 271 | * @return int |
||
| 272 | */ |
||
| 273 | 1 | private function getNextLineFromNextBreak($nextBreak) |
|
| 284 | |||
| 285 | |||
| 286 | /** |
||
| 287 | * @param int $nextBreak |
||
| 288 | * @param int $caseAlignment |
||
| 289 | */ |
||
| 290 | 1 | private function ensureCaseIndention($nextBreak, $caseAlignment) |
|
| 300 | |||
| 301 | |||
| 302 | /** |
||
| 303 | * @param bool $foundDefault |
||
| 304 | */ |
||
| 305 | 1 | private function ensureDefaultIsPresent($foundDefault) |
|
| 312 | |||
| 313 | |||
| 314 | 1 | private function ensureClosingBraceAlignment(array $switch) |
|
| 321 | |||
| 322 | |||
| 323 | /** |
||
| 324 | * @param string $opener |
||
| 325 | * @param int $nextCase |
||
| 326 | * @param string $type |
||
| 327 | */ |
||
| 328 | 1 | private function ensureNoSpaceBeforeColon($opener, $nextCase, $type) |
|
| 335 | |||
| 336 | |||
| 337 | /** |
||
| 338 | * @param int $nextCase |
||
| 339 | * @param string $type |
||
| 340 | */ |
||
| 341 | 1 | private function checkSpaceAfterKeyword($nextCase, $type) |
|
| 350 | |||
| 351 | } |
||
| 352 |
Loading history...
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.