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 |
||
| 34 | class OrganizationRuleController extends Controller |
||
| 35 | { |
||
| 36 | /** |
||
| 37 | * List all current organization's rules. |
||
| 38 | * |
||
| 39 | * @ApiDoc( |
||
| 40 | * resource=true, |
||
| 41 | * description="List all current organization's articles", |
||
| 42 | * statusCodes={ |
||
| 43 | * 200="Returned on success.", |
||
| 44 | * 500="Returned when unexpected error occurred." |
||
| 45 | * }, |
||
| 46 | * filters={ |
||
| 47 | * {"name"="sorting", "dataType"="string", "pattern"="[updatedAt]=asc|desc"} |
||
| 48 | * } |
||
| 49 | * ) |
||
| 50 | * @Route("/api/{version}/organization/rules/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_list_organization_rules") |
||
| 51 | * @Method("GET") |
||
| 52 | * |
||
| 53 | * @Cache(expires="10 minutes", public=true) |
||
| 54 | */ |
||
| 55 | public function rulesAction(Request $request) |
||
| 73 | |||
| 74 | /** |
||
| 75 | * Create a new Organization Rule. |
||
| 76 | * |
||
| 77 | * @ApiDoc( |
||
| 78 | * resource=true, |
||
| 79 | * description="Create a new organization rule", |
||
| 80 | * statusCodes={ |
||
| 81 | * 201="Returned on success.", |
||
| 82 | * 400="Returned on validation error.", |
||
| 83 | * 405="Method Not Allowed." |
||
| 84 | * }, |
||
| 85 | * input="SWP\Bundle\RuleBundle\Form\Type\RuleType" |
||
| 86 | * ) |
||
| 87 | * @Route("/api/{version}/organization/rules/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_create_organization_rule") |
||
| 88 | * @Method("POST") |
||
| 89 | */ |
||
| 90 | View Code Duplication | public function createAction(Request $request) |
|
| 108 | |||
| 109 | /** |
||
| 110 | * Show single organiation's rule. |
||
| 111 | * |
||
| 112 | * @ApiDoc( |
||
| 113 | * resource=true, |
||
| 114 | * description="Show single organization rule", |
||
| 115 | * statusCodes={ |
||
| 116 | * 200="Returned on success." |
||
| 117 | * } |
||
| 118 | * ) |
||
| 119 | * @Route("/api/{version}/organization/rules/{id}", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_show_organization_rule", requirements={"id"="\d+"}) |
||
| 120 | * @Method("GET") |
||
| 121 | * |
||
| 122 | * @Cache(expires="10 minutes", public=true) |
||
| 123 | */ |
||
| 124 | public function getAction(int $id) |
||
| 128 | |||
| 129 | /** |
||
| 130 | * Updates organization's rule. |
||
| 131 | * |
||
| 132 | * @ApiDoc( |
||
| 133 | * resource=true, |
||
| 134 | * description="Updates organization rule", |
||
| 135 | * statusCodes={ |
||
| 136 | * 200="Returned on success.", |
||
| 137 | * 400="Returned when validation failed.", |
||
| 138 | * 500="Returned when unexpected error." |
||
| 139 | * }, |
||
| 140 | * input="SWP\Bundle\CoreBundle\Form\Type\RuleType" |
||
| 141 | * ) |
||
| 142 | * @Route("/api/{version}/organization/rules/{id}", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_update_organization_rule", requirements={"id"="\d+"}) |
||
| 143 | * @Method("PATCH") |
||
| 144 | */ |
||
| 145 | View Code Duplication | public function updateRuleAction(Request $request, int $id) |
|
| 161 | |||
| 162 | /** |
||
| 163 | * Delete single organization rule. |
||
| 164 | * |
||
| 165 | * @ApiDoc( |
||
| 166 | * resource=true, |
||
| 167 | * description="Delete single organization rule", |
||
| 168 | * statusCodes={ |
||
| 169 | * 204="Returned on success.", |
||
| 170 | * 404="Returned when rule not found.", |
||
| 171 | * 405="Returned when method not allowed." |
||
| 172 | * } |
||
| 173 | * ) |
||
| 174 | * @Route("/api/{version}/organization/rules/{id}", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_delete_organization_rule", requirements={"id"="\d+"}) |
||
| 175 | * @Method("DELETE") |
||
| 176 | */ |
||
| 177 | View Code Duplication | public function deleteAction(int $id) |
|
| 185 | |||
| 186 | private function findOr404(int $id) |
||
| 201 | |||
| 202 | private function getRuleRepository() |
||
| 206 | |||
| 207 | private function getEventDispatcher() |
||
| 211 | } |
||
| 212 |
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.