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:
| 1 | <?php |
||
| 11 | View Code Duplication | class Router implements RouterInterface |
|
|
|
|||
| 12 | { |
||
| 13 | /** |
||
| 14 | * @var string |
||
| 15 | */ |
||
| 16 | private $path; |
||
| 17 | |||
| 18 | /** |
||
| 19 | * @var MiddlewareInterface |
||
| 20 | */ |
||
| 21 | private $middleware; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * Whether the middleware must be enabled or not. |
||
| 25 | * |
||
| 26 | * @var ConditionInterface |
||
| 27 | */ |
||
| 28 | private $enableCondition; |
||
| 29 | |||
| 30 | /** |
||
| 31 | * @Important IfSet |
||
| 32 | * |
||
| 33 | * @param MiddlewareInterface $middleware The PSR-7 middleware to call |
||
| 34 | * @param string $path The path to that middleware (defaults to /). |
||
| 35 | * @param ConditionInterface $enableCondition Whether the middleware must be enabled or not. |
||
| 36 | */ |
||
| 37 | public function __construct(MiddlewareInterface $middleware, $path = '/', ConditionInterface $enableCondition = null) |
||
| 43 | |||
| 44 | /** |
||
| 45 | * The path to that middleware (defaults to /). |
||
| 46 | * |
||
| 47 | * @return string |
||
| 48 | */ |
||
| 49 | public function getPath() |
||
| 53 | |||
| 54 | /** |
||
| 55 | * The PSR-7 middleware to call. |
||
| 56 | * |
||
| 57 | * @return MiddlewareInterface |
||
| 58 | */ |
||
| 59 | public function getMiddleware() |
||
| 63 | |||
| 64 | /** |
||
| 65 | * If this returns false, the router is skipped. |
||
| 66 | * |
||
| 67 | * @return bool |
||
| 68 | */ |
||
| 69 | public function isActive() |
||
| 77 | } |
||
| 78 |
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.