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 |
||
| 19 | View Code Duplication | class TaskMoveColumnUnAssigned extends Base |
|
|
|
|||
| 20 | { |
||
| 21 | /** |
||
| 22 | * Get automatic action description. |
||
| 23 | * |
||
| 24 | * @return string |
||
| 25 | */ |
||
| 26 | public function getDescription() |
||
| 30 | |||
| 31 | /** |
||
| 32 | * Get the list of compatible events. |
||
| 33 | * |
||
| 34 | * @return array |
||
| 35 | */ |
||
| 36 | public function getCompatibleEvents() |
||
| 43 | |||
| 44 | /** |
||
| 45 | * Get the required parameter for the action (defined by the user). |
||
| 46 | * |
||
| 47 | * @return array |
||
| 48 | */ |
||
| 49 | public function getActionRequiredParameters() |
||
| 56 | |||
| 57 | /** |
||
| 58 | * Get the required parameter for the event. |
||
| 59 | * |
||
| 60 | * @return string[] |
||
| 61 | */ |
||
| 62 | public function getEventRequiredParameters() |
||
| 75 | |||
| 76 | /** |
||
| 77 | * Execute the action (move the task to another column). |
||
| 78 | * |
||
| 79 | * @param array $data Event data dictionary |
||
| 80 | * |
||
| 81 | * @return bool True if the action was executed or false when not executed |
||
| 82 | */ |
||
| 83 | public function doAction(array $data) |
||
| 94 | |||
| 95 | /** |
||
| 96 | * Check if the event data meet the action condition. |
||
| 97 | * |
||
| 98 | * @param array $data Event data dictionary |
||
| 99 | * |
||
| 100 | * @return bool |
||
| 101 | */ |
||
| 102 | public function hasRequiredCondition(array $data) |
||
| 106 | } |
||
| 107 |
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.