pamil /
Sylius
Complex classes like UserController often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use UserController, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 36 | class UserController extends ResourceController |
||
| 37 | { |
||
| 38 | /** |
||
| 39 | * @param Request $request |
||
| 40 | * |
||
| 41 | * @return Response |
||
| 42 | */ |
||
| 43 | public function changePasswordAction(Request $request) |
||
| 44 | { |
||
| 45 | $configuration = $this->requestConfigurationFactory->create($this->metadata, $request); |
||
| 46 | |||
| 47 | if (!$this->container->get('security.authorization_checker')->isGranted('IS_AUTHENTICATED_REMEMBERED')) { |
||
| 48 | throw new AccessDeniedException('You have to be registered user to access this section.'); |
||
| 49 | } |
||
| 50 | |||
| 51 | $user = $this->container->get('security.token_storage')->getToken()->getUser(); |
||
| 52 | |||
| 53 | $changePassword = new ChangePassword(); |
||
| 54 | $formType = $this->getSyliusAttribute($request, 'form', 'sylius_user_change_password'); |
||
| 55 | $form = $this->createResourceForm($configuration, $formType, $changePassword); |
||
| 56 | |||
| 57 | if (in_array($request->getMethod(), ['POST', 'PUT', 'PATCH']) && $form->submit($request, !$request->isMethod('PATCH'))->isValid()) { |
||
| 58 | return $this->handleChangePassword($request, $configuration, $user, $changePassword->getNewPassword()); |
||
| 59 | } |
||
| 60 | |||
| 61 | if (!$configuration->isHtmlRequest()) { |
||
| 62 | return $this->viewHandler->handle($configuration, View::create($form, Response::HTTP_BAD_REQUEST)); |
||
| 63 | } |
||
| 64 | |||
| 65 | return $this->container->get('templating')->renderResponse( |
||
| 66 | $configuration->getTemplate('changePassword.html'), |
||
| 67 | ['form' => $form->createView()] |
||
| 68 | ); |
||
| 69 | } |
||
| 70 | |||
| 71 | /** |
||
| 72 | * @param Request $request |
||
| 73 | * |
||
| 74 | * @return Response |
||
| 75 | */ |
||
| 76 | public function requestPasswordResetTokenAction(Request $request) |
||
| 83 | |||
| 84 | /** |
||
| 85 | * @param Request $request |
||
| 86 | * |
||
| 87 | * @return Response |
||
| 88 | */ |
||
| 89 | public function requestPasswordResetPinAction(Request $request) |
||
| 96 | |||
| 97 | /** |
||
| 98 | * @param Request $request |
||
| 99 | * @param string $token |
||
| 100 | * |
||
| 101 | * @return Response |
||
| 102 | */ |
||
| 103 | public function resetPasswordAction(Request $request, $token) |
||
| 138 | |||
| 139 | /** |
||
| 140 | * @param Request $request |
||
| 141 | * @param string $token |
||
| 142 | * |
||
| 143 | * @return Response |
||
| 144 | */ |
||
| 145 | public function verifyAction(Request $request, $token) |
||
| 146 | { |
||
| 147 | $configuration = $this->requestConfigurationFactory->create($this->metadata, $request); |
||
| 148 | $redirectRoute = $this->getSyliusAttribute($request, 'redirect', null); |
||
| 149 | |||
| 150 | $response = $this->redirectToRoute($redirectRoute); |
||
| 151 | |||
| 152 | /** @var UserInterface $user */ |
||
| 153 | $user = $this->repository->findOneBy(['emailVerificationToken' => $token]); |
||
| 154 | if (null === $user) { |
||
| 155 | if (!$configuration->isHtmlRequest()) { |
||
| 156 | return $this->viewHandler->handle($configuration, View::create($configuration, Response::HTTP_BAD_REQUEST)); |
||
| 157 | } |
||
| 158 | |||
| 159 | $this->addFlash('error', 'sylius.user.verification.error'); |
||
| 160 | |||
| 161 | return $this->redirectToRoute($redirectRoute); |
||
| 162 | } |
||
| 163 | |||
| 164 | $eventDispatcher = $this->container->get('event_dispatcher'); |
||
| 165 | $eventDispatcher->dispatch(UserEvents::PRE_EMAIL_VERIFICATION, new GenericEvent($user)); |
||
| 166 | |||
| 167 | $user->setVerifiedAt(new \DateTime()); |
||
| 168 | $user->setEmailVerificationToken(null); |
||
| 169 | |||
| 170 | $this->manager->flush(); |
||
| 171 | |||
| 172 | $eventDispatcher->dispatch(UserEvents::POST_EMAIL_VERIFICATION, new GenericEvent($user)); |
||
| 173 | |||
| 174 | if (!$configuration->isHtmlRequest()) { |
||
| 175 | return $this->viewHandler->handle($configuration, View::create($user)); |
||
| 176 | } |
||
| 177 | |||
| 178 | $flashMessage = $this->getSyliusAttribute($request, 'flash', 'sylius.user.verification.success'); |
||
| 179 | $this->addFlash('success', $flashMessage); |
||
| 180 | |||
| 181 | return $response; |
||
| 182 | } |
||
| 183 | |||
| 184 | /** |
||
| 185 | * @param Request $request |
||
| 186 | * |
||
| 187 | * @return Response |
||
| 188 | */ |
||
| 189 | public function requestVerificationTokenAction(Request $request) |
||
| 222 | |||
| 223 | /** |
||
| 224 | * @param Request $request |
||
| 225 | * @param GeneratorInterface $generator |
||
| 226 | * @param string $senderEvent |
||
| 227 | * |
||
| 228 | * @return Response |
||
| 229 | */ |
||
| 230 | protected function prepareResetPasswordRequest(Request $request, GeneratorInterface $generator, $senderEvent) |
||
| 231 | { |
||
| 232 | $configuration = $this->requestConfigurationFactory->create($this->metadata, $request); |
||
| 233 | |||
| 234 | $passwordReset = new PasswordResetRequest(); |
||
| 235 | $formType = $this->getSyliusAttribute($request, 'form', 'sylius_user_request_password_reset'); |
||
| 236 | $form = $this->createResourceForm($configuration, $formType, $passwordReset); |
||
| 237 | $template = $this->getSyliusAttribute($request, 'template', null); |
||
| 238 | Assert::notNull($template, 'Template is not configured.'); |
||
| 239 | |||
| 240 | if (in_array($request->getMethod(), ['POST', 'PUT', 'PATCH']) && $form->submit($request, !$request->isMethod('PATCH'))->isValid()) { |
||
| 241 | $user = $this->repository->findOneByEmail($passwordReset->getEmail()); |
||
|
|
|||
| 242 | if (null !== $user) { |
||
| 243 | $this->handleResetPasswordRequest($generator, $user, $senderEvent); |
||
| 244 | } |
||
| 245 | |||
| 246 | if (!$configuration->isHtmlRequest()) { |
||
| 247 | return $this->viewHandler->handle($configuration, View::create(null, Response::HTTP_NO_CONTENT)); |
||
| 248 | } |
||
| 249 | |||
| 250 | $this->addFlash('success', 'sylius.user.password.reset.requested'); |
||
| 251 | $redirectRoute = $this->getSyliusAttribute($request, 'redirect', null); |
||
| 252 | Assert::notNull($redirectRoute, 'Redirect is not configured.'); |
||
| 253 | |||
| 254 | if (is_array($redirectRoute)) { |
||
| 255 | return $this->redirectHandler->redirectToRoute( |
||
| 256 | $configuration, |
||
| 257 | $configuration->getParameters()->get('redirect')['route'], |
||
| 258 | $configuration->getParameters()->get('redirect')['parameters'] |
||
| 259 | ); |
||
| 260 | } |
||
| 261 | |||
| 262 | return $this->redirectHandler->redirectToRoute($configuration, $redirectRoute); |
||
| 263 | } |
||
| 264 | |||
| 265 | if (!$configuration->isHtmlRequest()) { |
||
| 266 | return $this->viewHandler->handle($configuration, View::create($form, Response::HTTP_BAD_REQUEST)); |
||
| 267 | } |
||
| 268 | |||
| 269 | return $this->container->get('templating')->renderResponse( |
||
| 270 | $template, |
||
| 271 | [ |
||
| 272 | 'form' => $form->createView(), |
||
| 273 | ] |
||
| 274 | ); |
||
| 275 | } |
||
| 276 | |||
| 277 | /** |
||
| 278 | * @param string $type |
||
| 279 | * @param string $message |
||
| 280 | */ |
||
| 281 | protected function addFlash($type, $message) |
||
| 286 | |||
| 287 | /** |
||
| 288 | * @param RequestConfiguration $configuration |
||
| 289 | * @param string $type |
||
| 290 | * @param mixed $resource |
||
| 291 | * |
||
| 292 | * @return FormInterface |
||
| 293 | */ |
||
| 294 | protected function createResourceForm(RequestConfiguration $configuration, $type, $resource) |
||
| 302 | |||
| 303 | /** |
||
| 304 | * @param Request $request |
||
| 305 | * @param RequestConfiguration $configuration |
||
| 306 | * @param UserInterface $user |
||
| 307 | * |
||
| 308 | * @return RedirectResponse |
||
| 309 | */ |
||
| 310 | protected function handleExpiredToken(Request $request, RequestConfiguration $configuration, UserInterface $user) |
||
| 328 | |||
| 329 | /** |
||
| 330 | * @param GeneratorInterface $generator |
||
| 331 | * @param UserInterface $user |
||
| 332 | * @param string $senderEvent |
||
| 333 | */ |
||
| 334 | protected function handleResetPasswordRequest(GeneratorInterface $generator, UserInterface $user, $senderEvent) |
||
| 347 | |||
| 348 | /** |
||
| 349 | * @param Request $request |
||
| 350 | * @param RequestConfiguration $configuration |
||
| 351 | * @param UserInterface $user |
||
| 352 | * @param string $newPassword |
||
| 353 | * |
||
| 354 | * @return Response |
||
| 355 | */ |
||
| 356 | protected function handleResetPassword(Request $request, RequestConfiguration $configuration, UserInterface $user, $newPassword) |
||
| 379 | |||
| 380 | /** |
||
| 381 | * @param Request $request |
||
| 382 | * @param RequestConfiguration $configuration |
||
| 383 | * @param UserInterface $user |
||
| 384 | * @param string $newPassword |
||
| 385 | * |
||
| 386 | * @return Response |
||
| 387 | */ |
||
| 388 | protected function handleChangePassword(Request $request, RequestConfiguration $configuration, UserInterface $user, $newPassword) |
||
| 409 | |||
| 410 | /** |
||
| 411 | * @param Request $request |
||
| 412 | * @param string $attribute |
||
| 413 | * @param mixed $default |
||
| 414 | * |
||
| 415 | * @return mixed |
||
| 416 | */ |
||
| 417 | private function getSyliusAttribute(Request $request, $attribute, $default = null) |
||
| 423 | } |
||
| 424 |
This check marks calls to methods that do not seem to exist on an object.
This is most likely the result of a method being renamed without all references to it being renamed likewise.