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 |
||
| 13 | class EventController extends StructureController |
||
| 14 | { |
||
| 15 | /** |
||
| 16 | * @ApiDoc( |
||
| 17 | * resource=true, |
||
| 18 | * description="Show events list.", |
||
| 19 | * section="Campaign", |
||
| 20 | * parameters={ |
||
| 21 | * { |
||
| 22 | * "name"="offset", |
||
| 23 | * "dataType"="integer", |
||
| 24 | * "requirement"="\d+", |
||
| 25 | * "description"="starkerxp_structure.doc.offset.result", |
||
| 26 | * "required"="false" |
||
| 27 | * }, |
||
| 28 | * { |
||
| 29 | * "name"="limit", |
||
| 30 | * "dataType"="integer", |
||
| 31 | * "requirement"="\d+", |
||
| 32 | * "description"="starkerxp_structure.doc.limit.result", |
||
| 33 | * "required"="false" |
||
| 34 | * }, |
||
| 35 | * { |
||
| 36 | * "name"="fields", |
||
| 37 | * "dataType"="string", |
||
| 38 | * "requirement"="\w+", |
||
| 39 | * "description"="starkerxp_structure.doc.list_field.entity", |
||
| 40 | * "required"="false" |
||
| 41 | * }, |
||
| 42 | * { |
||
| 43 | * "name"="sort", |
||
| 44 | * "dataType"="string", |
||
| 45 | * "requirement"="\w+", |
||
| 46 | * "description"="starkerxp_structure.doc.sort.result", |
||
| 47 | * "required"="false" |
||
| 48 | * } |
||
| 49 | * }, |
||
| 50 | * views = { "default" } |
||
| 51 | * ) |
||
| 52 | */ |
||
| 53 | View Code Duplication | public function cgetAction(Request $request) |
|
| 74 | |||
| 75 | |||
| 76 | /** |
||
| 77 | * @ApiDoc( |
||
| 78 | * resource=true, |
||
| 79 | * description="Show event.", |
||
| 80 | * section="Campaign", |
||
| 81 | * requirements={ |
||
| 82 | * { |
||
| 83 | * "name"="campaign_id", |
||
| 84 | * "dataType"="integer", |
||
| 85 | * "requirement"="\d+", |
||
| 86 | * "description"="Permet d'afficher l'élément choisis" |
||
| 87 | * }, |
||
| 88 | * { |
||
| 89 | * "name"="event_id", |
||
| 90 | * "dataType"="integer", |
||
| 91 | * "requirement"="\d+", |
||
| 92 | * "description"="Permet d'afficher l'élément choisis" |
||
| 93 | * } |
||
| 94 | * }, |
||
| 95 | * parameters={ |
||
| 96 | * { |
||
| 97 | * "name"="fields", |
||
| 98 | * "dataType"="string", |
||
| 99 | * "requirement"="\w+", |
||
| 100 | * "description"="starkerxp_structure.doc.list_field.entity", |
||
| 101 | * "required"="false" |
||
| 102 | * } |
||
| 103 | * }, |
||
| 104 | * views = { "default" } |
||
| 105 | * ) |
||
| 106 | */ |
||
| 107 | View Code Duplication | public function getAction(Request $request) |
|
| 123 | |||
| 124 | /** |
||
| 125 | * @ApiDoc( |
||
| 126 | * resource=true, |
||
| 127 | * description="Ajoute un event.", |
||
| 128 | * section="Campaign", |
||
| 129 | * views = { "default" } |
||
| 130 | * ) |
||
| 131 | */ |
||
| 132 | View Code Duplication | public function postAction(Request $request) |
|
| 152 | |||
| 153 | /** |
||
| 154 | * @ApiDoc( |
||
| 155 | * resource=true, |
||
| 156 | * description="Edit event.", |
||
| 157 | * section="Campaign", |
||
| 158 | * requirements={ |
||
| 159 | * { |
||
| 160 | * "name"="campaign_id", |
||
| 161 | * "dataType"="integer", |
||
| 162 | * "requirement"="\d+", |
||
| 163 | * "description"="Permet de modifier un élément de la campaign" |
||
| 164 | * }, |
||
| 165 | * { |
||
| 166 | * "name"="event_id", |
||
| 167 | * "dataType"="integer", |
||
| 168 | * "requirement"="\d+", |
||
| 169 | * "description"="Permet de modifier l'élément choisis" |
||
| 170 | * } |
||
| 171 | * }, |
||
| 172 | * views = { "default" } |
||
| 173 | * ) |
||
| 174 | */ |
||
| 175 | View Code Duplication | public function putAction(Request $request) |
|
| 197 | |||
| 198 | /** |
||
| 199 | * @ApiDoc( |
||
| 200 | * resource=true, |
||
| 201 | * description="Delete event.", |
||
| 202 | * section="Campaign", |
||
| 203 | * requirements={ |
||
| 204 | * { |
||
| 205 | * "name"="campaign_id", |
||
| 206 | * "dataType"="integer", |
||
| 207 | * "requirement"="\d+", |
||
| 208 | * "description"="Permet de supprimer un élément de la campaign" |
||
| 209 | * }, |
||
| 210 | * { |
||
| 211 | * "name"="event_id", |
||
| 212 | * "dataType"="integer", |
||
| 213 | * "requirement"="\d+", |
||
| 214 | * "description"="Permet de supprimer l'élément choisis" |
||
| 215 | * } |
||
| 216 | * }, |
||
| 217 | * views = { "default" } |
||
| 218 | * ) |
||
| 219 | */ |
||
| 220 | public function deleteAction(Request $request) |
||
| 235 | |||
| 236 | } |
||
| 237 |
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.