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 |
||
| 33 | class WidgetController extends FOSRestController |
||
| 34 | { |
||
| 35 | /** |
||
| 36 | * Lists all registered widgets. |
||
| 37 | * |
||
| 38 | * @ApiDoc( |
||
| 39 | * resource=true, |
||
| 40 | * description="Lists all registered widgets", |
||
| 41 | * statusCodes={ |
||
| 42 | * 200="Returned on success." |
||
| 43 | * }, |
||
| 44 | * filters={ |
||
| 45 | * {"name"="sorting", "dataType"="string", "pattern"="[updatedAt]=asc|desc"} |
||
| 46 | * } |
||
| 47 | * ) |
||
| 48 | 2 | * @Route("/api/{version}/templates/widgets/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_list_widgets") |
|
| 49 | * @Method("GET") |
||
| 50 | 2 | * @Cache(expires="10 minutes", public=true) |
|
| 51 | 2 | */ |
|
| 52 | 2 | public function listAction(Request $request) |
|
| 60 | |||
| 61 | /** |
||
| 62 | 2 | * Lists all theme widgets templates. |
|
| 63 | * |
||
| 64 | * @ApiDoc( |
||
| 65 | * resource=true, |
||
| 66 | * description="Lists all theme widgets templates", |
||
| 67 | * statusCodes={ |
||
| 68 | * 200="Returned on success." |
||
| 69 | * } |
||
| 70 | * ) |
||
| 71 | * @Route("/api/{version}/templates/widgets/templates/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_list_widgets_templates") |
||
| 72 | * @Method("GET") |
||
| 73 | * Cache(expires="10 minutes", public=true) |
||
| 74 | */ |
||
| 75 | public function listTemplatesAction(Request $request) |
||
| 101 | |||
| 102 | /** |
||
| 103 | * Get single widget. |
||
| 104 | * |
||
| 105 | * @ApiDoc( |
||
| 106 | * resource=true, |
||
| 107 | * description="Get single widget", |
||
| 108 | * statusCodes={ |
||
| 109 | * 200="Returned on success.", |
||
| 110 | * 404="Widget not found", |
||
| 111 | * 422="Widget id is not number" |
||
| 112 | * } |
||
| 113 | * ) |
||
| 114 | * @Route("/api/{version}/templates/widgets/{id}", requirements={"id"="\d+"}, options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_get_widget") |
||
| 115 | * @Method("GET") |
||
| 116 | 2 | */ |
|
| 117 | public function getAction($id) |
||
| 121 | 2 | ||
| 122 | 2 | /** |
|
| 123 | 2 | * Create new widget. |
|
| 124 | 2 | * |
|
| 125 | 2 | * Note: |
|
| 126 | * |
||
| 127 | 2 | * Widget Type can be widget ID or his class (string). |
|
| 128 | * Example: "SWP\\Bundle\\CoreBundle\\Widget\\ContentListWidget" |
||
| 129 | * |
||
| 130 | * @ApiDoc( |
||
| 131 | * resource=true, |
||
| 132 | * description="Create new widget", |
||
| 133 | * statusCodes={ |
||
| 134 | * 201="Returned on success.", |
||
| 135 | * 400="Returned when form have errors" |
||
| 136 | * }, |
||
| 137 | * input="SWP\Bundle\TemplatesSystemBundle\Form\Type\WidgetType" |
||
| 138 | * ) |
||
| 139 | * @Route("/api/{version}/templates/widgets/", options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_create_widget") |
||
| 140 | * @Method("POST") |
||
| 141 | */ |
||
| 142 | View Code Duplication | public function createAction(Request $request) |
|
| 156 | |||
| 157 | 1 | /** |
|
| 158 | * Delete single widget. |
||
| 159 | * |
||
| 160 | * @ApiDoc( |
||
| 161 | 1 | * resource=true, |
|
| 162 | * description="Delete single widget", |
||
| 163 | * statusCodes={ |
||
| 164 | * 204="Returned on success.", |
||
| 165 | 1 | * 404="Widget not found", |
|
| 166 | 1 | * 422="Widget id is not number" |
|
| 167 | * } |
||
| 168 | 1 | * ) |
|
| 169 | * @Route("/api/{version}/templates/widgets/{id}", requirements={"id"="\d+"}, options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_delete_widget") |
||
| 170 | * @Method("DELETE") |
||
| 171 | */ |
||
| 172 | public function deleteAction($id) |
||
| 185 | |||
| 186 | /** |
||
| 187 | * Update single widget. |
||
| 188 | 1 | * |
|
| 189 | * @ApiDoc( |
||
| 190 | 1 | * resource=true, |
|
| 191 | * description="Update single widget", |
||
| 192 | * statusCodes={ |
||
| 193 | * 201="Returned on success.", |
||
| 194 | 1 | * 404="Widget not found", |
|
| 195 | 1 | * 422="Widget id is not number", |
|
| 196 | * 405="Method Not Allowed" |
||
| 197 | 1 | * }, |
|
| 198 | * input="SWP\Bundle\TemplatesSystemBundle\Form\Type\WidgetType" |
||
| 199 | * ) |
||
| 200 | * @Route("/api/{version}/templates/widgets/{id}", requirements={"id"="\d+"}, options={"expose"=true}, defaults={"version"="v1"}, name="swp_api_templates_update_widget") |
||
| 201 | 1 | * @Method("PATCH") |
|
| 202 | 1 | */ |
|
| 203 | View Code Duplication | public function updateAction(Request $request, $id) |
|
| 219 | |||
| 220 | private function findOr404(int $id) |
||
| 228 | |||
| 229 | private function ensureWidgetDontExists(string $name) |
||
| 235 | |||
| 236 | private function getWidgetRepository() |
||
| 240 | } |
||
| 241 |
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.