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 |
||
21 | class UserController extends Controller |
||
22 | { |
||
23 | /** |
||
24 | * @Route("/users", name="users_list") |
||
25 | * @Template("@App/User/users.html.twig") |
||
26 | * |
||
27 | * @param Request $request |
||
28 | * |
||
29 | * @return array |
||
30 | */ |
||
31 | 3 | public function listAction(Request $request) |
|
32 | { |
||
33 | 3 | $em = $this->getDoctrine()->getManager(); |
|
34 | 3 | $filter = new Filter(); |
|
35 | 3 | $filterForm = $this->createForm(UserFilterType::class, $filter) |
|
36 | 3 | ->add('Search', SubmitType::class); |
|
37 | 3 | $filterForm->handleRequest($request); |
|
38 | 3 | $users = $this->get('knp_paginator')->paginate( |
|
39 | 3 | $em->getRepository(User::class)->selectUsersByParams($filter), |
|
40 | 3 | $request->query->getInt('page', 1), |
|
41 | 3 | 10 |
|
42 | ); |
||
43 | 3 | $activationForm = []; |
|
44 | 3 | foreach ($users as $user) { |
|
45 | 3 | $activationForm[$user->getId()] = $this->createForm(ActivationType::class, $user, [ |
|
46 | 3 | 'method' => 'PUT', |
|
47 | 3 | 'action' => $this->generateUrl('activate_user', ['id' => $user->getId()]), |
|
48 | 3 | 'validation_groups' => 'edit', |
|
49 | ]) |
||
50 | 3 | ->createView(); |
|
51 | } |
||
52 | |||
53 | return [ |
||
54 | 3 | 'users' => $users, |
|
55 | 3 | 'filterForm' => $filterForm->createView(), |
|
56 | 3 | 'activationForm' => $activationForm, |
|
57 | ]; |
||
58 | } |
||
59 | |||
60 | /** |
||
61 | * @Route("/user/activate/{id}", name="activate_user") |
||
62 | * |
||
63 | * @Method("PUT") |
||
64 | * |
||
65 | * @param Request $request |
||
66 | * @param User $user |
||
67 | * |
||
68 | * @return RedirectResponse |
||
69 | */ |
||
70 | 1 | public function activationAction(Request $request, User $user) |
|
86 | |||
87 | /** |
||
88 | * @Route("/user/add", name="add_user") |
||
89 | * @Template("@App/User/add.html.twig") |
||
90 | * |
||
91 | * @param Request $request |
||
92 | * |
||
93 | * @return array|RedirectResponse |
||
94 | */ |
||
95 | 1 | public function addAction(Request $request) |
|
118 | |||
119 | /** |
||
120 | * @Route("/user/edit/{id}", name="edit_user") |
||
121 | * @Template("@App/User/add.html.twig") |
||
122 | * |
||
123 | * @param Request $request |
||
124 | * @param User $user |
||
125 | * |
||
126 | * @return array|RedirectResponse |
||
127 | */ |
||
128 | 1 | public function editAction(Request $request, User $user) |
|
129 | { |
||
130 | 1 | $em = $this->getDoctrine()->getManager(); |
|
131 | 1 | $form = $this->createForm(EditType::class, $user, [ |
|
132 | 1 | 'action' => $this->generateUrl('edit_user', ['id' => $user->getId()]), |
|
133 | 1 | 'method' => 'POST', |
|
134 | 1 | 'validation_groups' => 'edit', |
|
135 | ]) |
||
136 | 1 | ->add('Save', SubmitType::class, [ |
|
137 | 1 | 'attr' => ['class' => 'btn btn-primary'], |
|
138 | ]); |
||
139 | 1 | $form->handleRequest($request); |
|
140 | 1 | View Code Duplication | if ($form->isSubmitted()) { |
141 | 1 | if ($form->isValid()) { |
|
142 | 1 | $em->persist($user); |
|
143 | 1 | $em->flush(); |
|
144 | |||
145 | 1 | return $this->redirect($this->generateUrl('users_list')); |
|
146 | } |
||
147 | } |
||
148 | |||
149 | 1 | return ['form' => $form->createView()]; |
|
150 | } |
||
151 | |||
152 | /** |
||
153 | * @Route("/users-list", name="users-list", options={"expose"=true}) |
||
154 | * |
||
155 | * @Method("GET") |
||
156 | * |
||
157 | * @return JsonResponse |
||
158 | */ |
||
159 | public function jsonListAction() |
||
167 | } |
||
168 |
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.