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 |
||
20 | class BlogController extends Controller |
||
21 | { |
||
22 | |||
23 | /** |
||
24 | * @param $page |
||
25 | * @Method("GET") |
||
26 | * @Route("/{pager}/{page}", name="homepage", |
||
27 | * defaults={"pager": "page", "page": 1}, |
||
28 | * requirements={ |
||
29 | * "pager": "page", |
||
30 | * "page": "[1-9]\d*", |
||
31 | * }) |
||
32 | * @Template("AppBundle:blog:blogPosts.html.twig") |
||
33 | * |
||
34 | * @return Response |
||
35 | */ |
||
36 | 1 | View Code Duplication | public function indexAction($page = 1) |
46 | |||
47 | /** |
||
48 | * @param $slug |
||
49 | * @Method("GET") |
||
50 | * @Route("/article/{slug}", name="showArticle") |
||
51 | * @Template("AppBundle:blog:blogSingle.html.twig") |
||
52 | * |
||
53 | * @return Response |
||
54 | */ |
||
55 | 1 | public function showAction($slug) |
|
65 | |||
66 | /** |
||
67 | * @param $sortBy |
||
68 | * @param $param |
||
69 | * @param $page |
||
70 | * @Method("GET") |
||
71 | * @Route("/{sortBy}/{param}/{pager}/{page}", name="sortArticles", |
||
72 | * defaults={"pager": "page", "page": 1}, |
||
73 | * requirements={ |
||
74 | * "sortBy": "category|tag|author|date", |
||
75 | * "pager": "page", |
||
76 | * "page": "[1-9]\d*", |
||
77 | * }) |
||
78 | * @Template("AppBundle:blog:blogPosts.html.twig") |
||
79 | * |
||
80 | * @return Response |
||
81 | */ |
||
82 | 3 | public function sortAction($sortBy, $param, $page = 1) |
|
105 | |||
106 | /** |
||
107 | * @param Request $request |
||
108 | * @Method("POST") |
||
109 | * @Route("/search", name="searchArticles") |
||
110 | * @Template("AppBundle:blog:blogPosts.html.twig") |
||
111 | * |
||
112 | * @return Response |
||
113 | */ |
||
114 | public function searchAction(Request $request) |
||
133 | |||
134 | /** |
||
135 | * @param Request $request |
||
136 | * @param $slug |
||
137 | * @Route("/newCommentFor/{slug}", name="commentForm") |
||
138 | * @Template("AppBundle:blog:commentForm.html.twig") |
||
139 | * |
||
140 | * @return array|\Symfony\Component\HttpFoundation\RedirectResponse |
||
141 | */ |
||
142 | 2 | public function newCommentAction(Request $request, $slug) |
|
194 | |||
195 | /** |
||
196 | * @param $slug |
||
197 | * @param $page |
||
198 | * @Route("/comments/{slug}/{pager}/{page}", name="articleComments", |
||
199 | * defaults={"pager": "page", "page": 1}, |
||
200 | * requirements={ |
||
201 | * "pager": "page", |
||
202 | * "page": "[1-9]\d*", |
||
203 | * }) |
||
204 | * @Template("AppBundle:blog:comments.html.twig") |
||
205 | * |
||
206 | * @return Response |
||
207 | */ |
||
208 | 2 | public function showArticleCommentsAction($slug, $page = 1) |
|
218 | |||
219 | /** |
||
220 | * @Route("/success", name="success") |
||
221 | * @Template("AppBundle:blog:success.html.twig") |
||
222 | * |
||
223 | * @return Response |
||
224 | */ |
||
225 | 1 | public function successAction() |
|
229 | |||
230 | /** |
||
231 | * @Route("/search_form_render", name="searchFormRender") |
||
232 | * @Template("AppBundle:blog:widgetSearchForm.html.twig") |
||
233 | * |
||
234 | * @return Response |
||
235 | */ |
||
236 | 5 | public function createSearchFormAction() |
|
244 | } |
||
245 |
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.