starker-xp /
lapero.net
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 |
||
| 15 | View Code Duplication | class TemplateController extends StructureController |
|
|
|
|||
| 16 | { |
||
| 17 | /** |
||
| 18 | * @ApiDoc( |
||
| 19 | * resource=true, |
||
| 20 | * description="List templates.", |
||
| 21 | * section="Campaign", |
||
| 22 | * parameters={ |
||
| 23 | * { |
||
| 24 | * "name"="offset", |
||
| 25 | * "dataType"="integer", |
||
| 26 | * "requirement"="\d+", |
||
| 27 | * "description"="starkerxp_structure.doc.offset.result", |
||
| 28 | * "required"="false" |
||
| 29 | * }, |
||
| 30 | * { |
||
| 31 | * "name"="limit", |
||
| 32 | * "dataType"="integer", |
||
| 33 | * "requirement"="\d+", |
||
| 34 | * "description"="starkerxp_structure.doc.limit.result", |
||
| 35 | * "required"="false" |
||
| 36 | * }, |
||
| 37 | * { |
||
| 38 | * "name"="fields", |
||
| 39 | * "dataType"="string", |
||
| 40 | * "requirement"="\w+", |
||
| 41 | * "description"="starkerxp_structure.doc.list_field.entity", |
||
| 42 | * "required"="false" |
||
| 43 | * }, |
||
| 44 | * { |
||
| 45 | * "name"="sort", |
||
| 46 | * "dataType"="string", |
||
| 47 | * "requirement"="\w+", |
||
| 48 | * "description"="starkerxp_structure.doc.sort.result", |
||
| 49 | * "required"="false" |
||
| 50 | * } |
||
| 51 | * }, |
||
| 52 | * views = { "default" } |
||
| 53 | * ) |
||
| 54 | * |
||
| 55 | */ |
||
| 56 | public function cgetAction(Request $request) |
||
| 78 | |||
| 79 | |||
| 80 | /** |
||
| 81 | * @ApiDoc( |
||
| 82 | * resource=true, |
||
| 83 | * description="Affiche un template.", |
||
| 84 | * section="Campaign", |
||
| 85 | * requirements={ |
||
| 86 | * { |
||
| 87 | * "name"="template_id", |
||
| 88 | * "dataType"="integer", |
||
| 89 | * "requirement"="\d+", |
||
| 90 | * "description"="Show an element" |
||
| 91 | * } |
||
| 92 | * }, |
||
| 93 | * parameters={ |
||
| 94 | * { |
||
| 95 | * "name"="fields", |
||
| 96 | * "dataType"="string", |
||
| 97 | * "requirement"="\w+", |
||
| 98 | * "description"="starkerxp_structure.doc.list_field.entity", |
||
| 99 | * "required"="false" |
||
| 100 | * } |
||
| 101 | * }, |
||
| 102 | * views = { "default" } |
||
| 103 | * ) |
||
| 104 | */ |
||
| 105 | public function getAction(Request $request) |
||
| 121 | |||
| 122 | /** |
||
| 123 | * @ApiDoc( |
||
| 124 | * resource=true, |
||
| 125 | * description="Ajoute un template.", |
||
| 126 | * section="Campaign", |
||
| 127 | * views = { "default" } |
||
| 128 | * ) |
||
| 129 | */ |
||
| 130 | public function postAction(Request $request) |
||
| 152 | |||
| 153 | /** |
||
| 154 | * @ApiDoc( |
||
| 155 | * resource=true, |
||
| 156 | * description="Modifie un template.", |
||
| 157 | * section="Campaign", |
||
| 158 | * requirements={ |
||
| 159 | * { |
||
| 160 | * "name"="template_id", |
||
| 161 | * "dataType"="integer", |
||
| 162 | * "requirement"="\d+", |
||
| 163 | * "description"="Edit an element." |
||
| 164 | * } |
||
| 165 | * }, |
||
| 166 | * views = { "default" } |
||
| 167 | * ) |
||
| 168 | */ |
||
| 169 | public function putAction(Request $request) |
||
| 170 | { |
||
| 171 | $manager = $this->get("starkerxp_campaign.manager.template"); |
||
| 172 | if (!$entite = $manager->findOneBy(['id' => $request->get('template_id')])) { |
||
| 173 | return new JsonResponse(["payload" => $this->translate("entity.not_found", "template")], 404); |
||
| 174 | } |
||
| 175 | $manager->beginTransaction(); |
||
| 176 | try { |
||
| 177 | $form = $this->createForm(TemplateType::class, $entite, ['method' => 'PUT']); |
||
| 178 | $form->submit($this->getRequestData($request), false); |
||
| 179 | if ($form->isValid()) { |
||
| 180 | $entite = $form->getData(); |
||
| 181 | $manager->update($entite); |
||
| 182 | $this->dispatch(Events::TEMPLATE_UPDATED, new GenericEvent($entite)); |
||
| 183 | |||
| 184 | return new JsonResponse(["payload" => $this->translate("entity.updated", "template")], 204); |
||
| 185 | } |
||
| 186 | } catch (\Exception $e) { |
||
| 187 | $manager->rollback(); |
||
| 188 | |||
| 189 | return new JsonResponse(["payload" => $e->getMessage()], 400); |
||
| 190 | } |
||
| 191 | |||
| 192 | return new JsonResponse(["payload" => $this->getFormErrors($form)], 400); |
||
| 193 | } |
||
| 194 | |||
| 195 | /** |
||
| 196 | * @ApiDoc( |
||
| 197 | * resource=true, |
||
| 198 | * description="Delete a template.", |
||
| 199 | * section="Campaign", |
||
| 200 | * requirements={ |
||
| 201 | * { |
||
| 202 | * "name"="template_id", |
||
| 203 | * "dataType"="integer", |
||
| 204 | * "requirement"="\d+", |
||
| 205 | * "description"="Delete an element." |
||
| 206 | * } |
||
| 207 | * }, |
||
| 208 | * views = { "default" } |
||
| 209 | * ) |
||
| 210 | */ |
||
| 211 | public function deleteAction(Request $request) |
||
| 228 | |||
| 229 | } |
||
| 230 |
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.