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 |
||
28 | class RuleController extends FOSRestController |
||
29 | { |
||
30 | /** |
||
31 | * List all Rule entities for current tenant. |
||
32 | * |
||
33 | * @ApiDoc( |
||
34 | * resource=true, |
||
35 | * description="List all rules", |
||
36 | * statusCodes={ |
||
37 | * 200="Returned on success.", |
||
38 | * 405="Method Not Allowed." |
||
39 | * } |
||
40 | * ) |
||
41 | * @Route("/api/{version}/rules/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_list_rule") |
||
42 | * @Method("GET") |
||
43 | */ |
||
44 | 1 | View Code Duplication | public function listAction(Request $request) |
56 | |||
57 | /** |
||
58 | * Get single Rule Entity. |
||
59 | * |
||
60 | * @ApiDoc( |
||
61 | * resource=true, |
||
62 | * description="Get single rule", |
||
63 | * statusCodes={ |
||
64 | * 200="Returned on success.", |
||
65 | * 404="Rule not found.", |
||
66 | * 405="Method Not Allowed." |
||
67 | * } |
||
68 | * ) |
||
69 | * @Route("/api/{version}/rules/{id}", requirements={"id"="\d+"}, options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_get_rule") |
||
70 | * @Method("GET") |
||
71 | * @ParamConverter("rule", class="SWPCoreBundle:Rule") |
||
72 | */ |
||
73 | 1 | public function getAction(RuleInterface $rule) |
|
77 | |||
78 | /** |
||
79 | * Create new Rule. |
||
80 | * |
||
81 | * @ApiDoc( |
||
82 | * resource=true, |
||
83 | * description="Create new rule", |
||
84 | * statusCodes={ |
||
85 | * 201="Returned on success.", |
||
86 | * 400="Returned on validation error.", |
||
87 | * 405="Method Not Allowed." |
||
88 | * }, |
||
89 | * input="SWP\Bundle\RuleBundle\Form\Type\RuleType" |
||
90 | * ) |
||
91 | * @Route("/api/{version}/rules/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_create_rule") |
||
92 | * @Method("POST") |
||
93 | */ |
||
94 | 4 | View Code Duplication | public function createAction(Request $request) |
110 | |||
111 | /** |
||
112 | * Delete single rule. |
||
113 | * |
||
114 | * @ApiDoc( |
||
115 | * resource=true, |
||
116 | * description="Delete single rule", |
||
117 | * statusCodes={ |
||
118 | * 204="Returned on success.", |
||
119 | * 404="Returned when rule not found.", |
||
120 | * 405="Returned when method not allowed." |
||
121 | * } |
||
122 | * ) |
||
123 | * @Route("/api/{version}/rules/{id}", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_delete_rule", requirements={"id"="\d+"}) |
||
124 | * @Method("DELETE") |
||
125 | * @ParamConverter("rule", class="SWPCoreBundle:Rule") |
||
126 | */ |
||
127 | 1 | public function deleteAction(RuleInterface $rule) |
|
134 | |||
135 | /** |
||
136 | * Updates single rule. |
||
137 | * |
||
138 | * @ApiDoc( |
||
139 | * resource=true, |
||
140 | * description="Update single rule", |
||
141 | * statusCodes={ |
||
142 | * 201="Returned on success.", |
||
143 | * 400="Returned on validation error.", |
||
144 | * 404="Rule not found.", |
||
145 | * 405="Method Not Allowed." |
||
146 | * }, |
||
147 | * input="SWP\Bundle\RuleBundle\Form\Type\RuleType" |
||
148 | * ) |
||
149 | * @Route("/api/{version}/rules/{id}", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_core_update_rule", requirements={"id"="\d+"}) |
||
150 | * @Method("PATCH") |
||
151 | * @ParamConverter("rule", class="SWPCoreBundle:Rule") |
||
152 | */ |
||
153 | 2 | View Code Duplication | public function updateAction(Request $request, RuleInterface $rule) |
171 | } |
||
172 |
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.