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 |
||
26 | class UsersController extends BaseSettingsController |
||
27 | { |
||
28 | /** |
||
29 | * List users |
||
30 | * |
||
31 | * @Route("/", name="KunstmaanUserManagementBundle_settings_users") |
||
32 | * @Template("@KunstmaanAdminList/Default/list.html.twig") |
||
33 | * |
||
34 | * @return array |
||
|
|||
35 | */ |
||
36 | public function listAction(Request $request) |
||
58 | |||
59 | /** |
||
60 | * Get an instance of the admin user class. |
||
61 | * |
||
62 | * @return BaseUser |
||
63 | */ |
||
64 | private function getUserClassInstance() |
||
70 | |||
71 | /** |
||
72 | * Add a user |
||
73 | * |
||
74 | * @Route("/add", name="KunstmaanUserManagementBundle_settings_users_add", methods={"GET", "POST"}) |
||
75 | * @Template("@KunstmaanUserManagement/Users/add.html.twig") |
||
76 | * |
||
77 | * @return array |
||
78 | */ |
||
79 | public function addAction(Request $request) |
||
123 | |||
124 | /** |
||
125 | * Edit a user |
||
126 | * |
||
127 | * @param int $id |
||
128 | * |
||
129 | * @Route("/{id}/edit", requirements={"id" = "\d+"}, name="KunstmaanUserManagementBundle_settings_users_edit", methods={"GET", "POST"}) |
||
130 | * @Template("@KunstmaanUserManagement/Users/edit.html.twig") |
||
131 | * |
||
132 | * @return array |
||
133 | * |
||
134 | * @throws AccessDeniedException |
||
135 | */ |
||
136 | public function editAction(Request $request, $id) |
||
213 | |||
214 | /** |
||
215 | * Delete a user |
||
216 | * |
||
217 | * @param Request $request |
||
218 | * @param int $id |
||
219 | * |
||
220 | * @Route("/{id}/delete", requirements={"id" = "\d+"}, name="KunstmaanUserManagementBundle_settings_users_delete", methods={"POST"}) |
||
221 | * |
||
222 | * @return array |
||
223 | * |
||
224 | * @throws AccessDeniedException |
||
225 | * |
||
226 | * @deprecated this method is deprecated since KunstmaanUserManagementBundle 5.6 and will be removed in KunstmaanUserManagementBundle 6.0 |
||
227 | */ |
||
228 | public function deleteAction(Request $request, $id) |
||
229 | { |
||
230 | @trigger_error('Using the deleteAction method from the UsersController is deprecated since KunstmaanUserManagementBundle 5.6 and will be replaced by the method deleteFormAction in KunstmaanUserManagementBundle 6.0. Use the correct method instead.', E_USER_DEPRECATED); |
||
231 | $this->denyAccessUnlessGranted('ROLE_SUPER_ADMIN'); |
||
232 | |||
233 | /* @var EntityManager $em */ |
||
234 | $em = $this->getDoctrine()->getManager(); |
||
235 | /* @var UserInterface $user */ |
||
236 | $user = $em->getRepository($this->container->getParameter('fos_user.model.user.class'))->find($id); |
||
237 | View Code Duplication | if (!\is_null($user)) { |
|
238 | $userEvent = new UserEvent($user, $request); |
||
239 | $this->container->get('event_dispatcher')->dispatch(UserEvents::USER_DELETE_INITIALIZE, $userEvent); |
||
240 | |||
241 | $em->remove($user); |
||
242 | $em->flush(); |
||
243 | |||
244 | $this->addFlash( |
||
245 | FlashTypes::SUCCESS, |
||
246 | $this->container->get('translator')->trans('kuma_user.users.delete.flash.success.%username%', [ |
||
247 | '%username%' => $user->getUsername(), |
||
248 | ]) |
||
249 | ); |
||
250 | } |
||
251 | |||
252 | return new RedirectResponse($this->generateUrl('KunstmaanUserManagementBundle_settings_users')); |
||
253 | } |
||
254 | |||
255 | /** |
||
256 | * @Route("/form-delete/{id}", requirements={"id" = "\d+"}, name="KunstmaanUserManagementBundle_settings_users_form_delete", methods={"POST"}) |
||
257 | */ |
||
258 | public function deleteFormAction(Request $request, $id) |
||
259 | { |
||
260 | $this->denyAccessUnlessGranted('ROLE_SUPER_ADMIN'); |
||
261 | |||
262 | $submittedToken = $request->request->get('token'); |
||
263 | if (!$this->isCsrfTokenValid('delete-user', $submittedToken)) { |
||
264 | return new RedirectResponse($this->generateUrl('KunstmaanUserManagementBundle_settings_users')); |
||
265 | } |
||
266 | |||
267 | /* @var EntityManager $em */ |
||
268 | $em = $this->getDoctrine()->getManager(); |
||
269 | /* @var UserInterface $user */ |
||
270 | $user = $em->getRepository($this->container->getParameter('fos_user.model.user.class'))->find($id); |
||
271 | View Code Duplication | if (!\is_null($user)) { |
|
272 | $userEvent = new UserEvent($user, $request); |
||
273 | $this->container->get('event_dispatcher')->dispatch(UserEvents::USER_DELETE_INITIALIZE, $userEvent); |
||
274 | |||
275 | $em->remove($user); |
||
276 | $em->flush(); |
||
277 | |||
278 | $this->addFlash( |
||
279 | FlashTypes::SUCCESS, |
||
280 | $this->container->get('translator')->trans('kuma_user.users.delete.flash.success.%username%', [ |
||
281 | '%username%' => $user->getUsername(), |
||
282 | ]) |
||
283 | ); |
||
284 | } |
||
285 | |||
286 | return new RedirectResponse($this->generateUrl('KunstmaanUserManagementBundle_settings_users')); |
||
287 | } |
||
288 | |||
289 | /** |
||
290 | * @return \Symfony\Component\HttpFoundation\Response |
||
291 | */ |
||
292 | public function changePasswordAction() |
||
304 | } |
||
305 |
This check looks for the generic type
array
as a return type and suggests a more specific type. This type is inferred from the actual code.