zikula /
core
| Total Complexity | 58 |
| Total Lines | 397 |
| Duplicated Lines | 0 % |
| Changes | 1 | ||
| Bugs | 1 | Features | 0 |
Complex classes like UserAdministrationController 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.
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 UserAdministrationController, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 69 | class UserAdministrationController extends AbstractController |
||
| 70 | { |
||
| 71 | /** |
||
| 72 | * @Route("/list/{sort}/{sortdir}/{letter}/{page}", methods = {"GET"}, requirements={"page" = "\d+"}) |
||
| 73 | * @PermissionCheck("moderate") |
||
| 74 | * @Theme("admin") |
||
| 75 | * @Template("@ZikulaUsersModule/UserAdministration/list.html.twig") |
||
| 76 | */ |
||
| 77 | public function listAction( |
||
| 78 | Request $request, |
||
| 79 | UserRepositoryInterface $userRepository, |
||
| 80 | RouterInterface $router, |
||
| 81 | AdministrationActionsHelper $actionsHelper, |
||
| 82 | AuthenticationMethodCollector $authenticationMethodCollector, |
||
| 83 | string $sort = 'uid', |
||
| 84 | string $sortdir = 'DESC', |
||
| 85 | string $letter = 'all', |
||
| 86 | int $page = 1 |
||
| 87 | ): array { |
||
| 88 | $sortableColumns = new SortableColumns($router, 'zikulausersmodule_useradministration_list', 'sort', 'sortdir'); |
||
| 89 | $sortableColumns->addColumns([new Column('uname'), new Column('uid'), new Column('registrationDate'), new Column('lastLogin'), new Column('activated')]); |
||
| 90 | $sortableColumns->setOrderByFromRequest($request); |
||
| 91 | $sortableColumns->setAdditionalUrlParameters([ |
||
| 92 | 'letter' => $letter, |
||
| 93 | 'page' => $page |
||
| 94 | ]); |
||
| 95 | |||
| 96 | $filter = []; |
||
| 97 | if (!empty($letter) && 'all' !== $letter) { |
||
| 98 | $filter['uname'] = ['operator' => 'like', 'operand' => "${letter}%"]; |
||
| 99 | } |
||
| 100 | $pageSize = $this->getVar(UsersConstant::MODVAR_ITEMS_PER_PAGE, UsersConstant::DEFAULT_ITEMS_PER_PAGE); |
||
| 101 | $paginator = $userRepository->query($filter, [$sort => $sortdir], 'and', $page, $pageSize); |
||
| 102 | $paginator->setRoute('zikulausersmodule_useradministration_list'); |
||
| 103 | $routeParameters = [ |
||
| 104 | 'sort' => $sort, |
||
| 105 | 'sortdir' => $sortdir, |
||
| 106 | 'letter' => $letter, |
||
| 107 | ]; |
||
| 108 | $paginator->setRouteParameters($routeParameters); |
||
| 109 | |||
| 110 | return [ |
||
| 111 | 'sort' => $sortableColumns->generateSortableColumns(), |
||
| 112 | 'actionsHelper' => $actionsHelper, |
||
| 113 | 'authMethodCollector' => $authenticationMethodCollector, |
||
| 114 | 'alpha' => new AlphaFilter('zikulausersmodule_useradministration_list', $routeParameters, $letter), |
||
| 115 | 'paginator' => $paginator |
||
| 116 | ]; |
||
| 117 | } |
||
| 118 | |||
| 119 | /** |
||
| 120 | * Called from UsersModule/Resources/public/js/Zikula.Users.Admin.View.js |
||
| 121 | * to populate a username search |
||
| 122 | * |
||
| 123 | * @Route("/getusersbyfragmentastable", methods = {"POST"}, options={"expose"=true, "i18n"=false}) |
||
| 124 | */ |
||
| 125 | public function getUsersByFragmentAsTableAction( |
||
| 126 | Request $request, |
||
| 127 | UserRepositoryInterface $userRepository, |
||
| 128 | AdministrationActionsHelper $actionsHelper |
||
| 129 | ): Response { |
||
| 130 | if (!$this->hasPermission('ZikulaUsersModule', '::', ACCESS_MODERATE)) { |
||
| 131 | return new PlainResponse(''); |
||
| 132 | } |
||
| 133 | $fragment = $request->request->get('fragment'); |
||
| 134 | $filter = [ |
||
| 135 | 'activated' => ['operator' => 'notIn', 'operand' => [ |
||
| 136 | UsersConstant::ACTIVATED_PENDING_REG, |
||
| 137 | UsersConstant::ACTIVATED_PENDING_DELETE |
||
| 138 | ]], |
||
| 139 | 'uname' => ['operator' => 'like', 'operand' => "${fragment}%"] |
||
| 140 | ]; |
||
| 141 | $users = $userRepository->query($filter); |
||
| 142 | |||
| 143 | return $this->render('@ZikulaUsersModule/UserAdministration/userlist.html.twig', [ |
||
| 144 | 'users' => $users, |
||
| 145 | 'actionsHelper' => $actionsHelper |
||
| 146 | ], new PlainResponse()); |
||
| 147 | } |
||
| 148 | |||
| 149 | /** |
||
| 150 | * @Route("/user/modify/{user}", requirements={"user" = "^[1-9]\d*$"}) |
||
| 151 | * @Theme("admin") |
||
| 152 | * @Template("@ZikulaUsersModule/UserAdministration/modify.html.twig") |
||
| 153 | * |
||
| 154 | * @return array|RedirectResponse |
||
| 155 | * @throws AccessDeniedException Thrown if the user hasn't edit permissions for the user record |
||
| 156 | */ |
||
| 157 | public function modifyAction( |
||
| 158 | Request $request, |
||
| 159 | UserEntity $user, |
||
| 160 | CurrentUserApiInterface $currentUserApi, |
||
| 161 | VariableApiInterface $variableApi, |
||
| 162 | EventDispatcherInterface $eventDispatcher, |
||
| 163 | HookDispatcherInterface $hookDispatcher |
||
| 164 | ) { |
||
| 165 | if (!$this->hasPermission('ZikulaUsersModule::', $user->getUname() . '::' . $user->getUid(), ACCESS_EDIT)) { |
||
| 166 | throw new AccessDeniedException(); |
||
| 167 | } |
||
| 168 | if (UsersConstant::USER_ID_ANONYMOUS === $user->getUid()) { |
||
| 169 | throw new AccessDeniedException($this->trans("Error! You can't edit the guest account.")); |
||
| 170 | } |
||
| 171 | |||
| 172 | $form = $this->createForm(AdminModifyUserType::class, $user); |
||
| 173 | $originalUser = clone $user; |
||
| 174 | $editUserFormPostCreatedEvent = new EditUserFormPostCreatedEvent($form); |
||
| 175 | $eventDispatcher->dispatch($editUserFormPostCreatedEvent); |
||
| 176 | $form->handleRequest($request); |
||
| 177 | |||
| 178 | $hook = new ValidationHook(new ValidationProviders()); |
||
| 179 | $hookDispatcher->dispatch(UserManagementUiHooksSubscriber::EDIT_VALIDATE, $hook); |
||
| 180 | $validators = $hook->getValidators(); |
||
| 181 | |||
| 182 | if ($form->isSubmitted() && $form->isValid() && !$validators->hasErrors()) { |
||
| 183 | if ($form->get('submit')->isClicked()) { |
||
|
Bug
introduced
by
|
|||
| 184 | $user = $form->getData(); |
||
| 185 | $this->checkSelf($currentUserApi, $variableApi, $user, $originalUser->getGroups()->toArray()); |
||
| 186 | |||
| 187 | $eventDispatcher->dispatch(new EditUserFormPostValidatedEvent($form, $user)); |
||
| 188 | |||
| 189 | $this->getDoctrine()->getManager()->flush(); |
||
| 190 | |||
| 191 | $updateEvent = UsersConstant::ACTIVATED_PENDING_REG === $user->getActivated() |
||
| 192 | ? new RegistrationPostUpdatedEvent($user, $originalUser) |
||
| 193 | : new ActiveUserPostUpdatedEvent($user, $originalUser); |
||
| 194 | $eventDispatcher->dispatch($updateEvent); |
||
| 195 | |||
| 196 | $hookDispatcher->dispatch(UserManagementUiHooksSubscriber::EDIT_PROCESS, new ProcessHook($user->getUid())); |
||
| 197 | |||
| 198 | $this->addFlash('status', "Done! Saved user's account information."); |
||
| 199 | } elseif ($form->get('cancel')->isClicked()) { |
||
| 200 | $this->addFlash('status', 'Operation cancelled.'); |
||
| 201 | } |
||
| 202 | |||
| 203 | return $this->redirectToRoute('zikulausersmodule_useradministration_list'); |
||
| 204 | } |
||
| 205 | |||
| 206 | return [ |
||
| 207 | 'form' => $form->createView(), |
||
| 208 | 'additionalTemplates' => isset($editUserFormPostCreatedEvent) ? $editUserFormPostCreatedEvent->getTemplates() : [] |
||
| 209 | ]; |
||
| 210 | } |
||
| 211 | |||
| 212 | /** |
||
| 213 | * @Route("/approve/{user}/{force}", requirements={"user" = "^[1-9]\d*$"}) |
||
| 214 | * @PermissionCheck("moderate") |
||
| 215 | * @Theme("admin") |
||
| 216 | * @Template("@ZikulaUsersModule/UserAdministration/approve.html.twig") |
||
| 217 | * |
||
| 218 | * @return array|RedirectResponse |
||
| 219 | */ |
||
| 220 | public function approveAction( |
||
| 273 | ]; |
||
| 274 | } |
||
| 275 | |||
| 276 | /** |
||
| 277 | * @Route("/delete/{user}", requirements={"user" = "^[1-9]\d*$"}) |
||
| 278 | * @PermissionCheck("delete") |
||
| 279 | * @Theme("admin") |
||
| 280 | * @Template("@ZikulaUsersModule/UserAdministration/delete.html.twig") |
||
| 281 | * |
||
| 282 | * @return array|RedirectResponse |
||
| 283 | */ |
||
| 284 | public function deleteAction( |
||
| 285 | Request $request, |
||
| 286 | CurrentUserApiInterface $currentUserApi, |
||
| 287 | UserRepositoryInterface $userRepository, |
||
| 288 | HookDispatcherInterface $hookDispatcher, |
||
| 289 | EventDispatcherInterface $eventDispatcher, |
||
| 290 | UserEntity $user = null |
||
| 291 | ) { |
||
| 292 | $uids = []; |
||
| 293 | if (!isset($user) && 'POST' === $request->getMethod() && $request->request->has('zikulausersmodule_delete')) { |
||
| 294 | $uids = $request->request->get('zikulausersmodule_delete')['users']; |
||
| 295 | } elseif (isset($user)) { |
||
| 296 | $uids = [$user->getUid()]; |
||
| 297 | } |
||
| 298 | $usersImploded = implode(',', $uids); |
||
| 299 | |||
| 300 | $deleteConfirmationForm = $this->createForm(DeleteConfirmationType::class, [ |
||
| 301 | 'users' => $usersImploded |
||
| 302 | ]); |
||
| 303 | $deleteUserFormPostCreatedEvent = new DeleteUserFormPostCreatedEvent($deleteConfirmationForm); |
||
| 304 | $eventDispatcher->dispatch($deleteUserFormPostCreatedEvent); |
||
| 305 | $deleteConfirmationForm->handleRequest($request); |
||
| 306 | if (empty($uids) && !$deleteConfirmationForm->isSubmitted()) { |
||
| 307 | throw new InvalidArgumentException($this->trans('No users selected.')); |
||
| 308 | } |
||
| 309 | if ($deleteConfirmationForm->isSubmitted()) { |
||
| 310 | if ($deleteConfirmationForm->get('cancel')->isClicked()) { |
||
| 311 | $this->addFlash('success', 'Operation cancelled.'); |
||
| 312 | |||
| 313 | return $this->redirectToRoute('zikulausersmodule_useradministration_list'); |
||
| 314 | } |
||
| 315 | $userIdsImploded = $deleteConfirmationForm->get('users')->getData(); |
||
| 316 | $userIds = explode(',', $userIdsImploded); |
||
| 317 | $valid = true; |
||
| 318 | foreach ($userIds as $k => $uid) { |
||
| 319 | if (in_array($uid, [UsersConstant::USER_ID_ANONYMOUS, UsersConstant::USER_ID_ADMIN, $currentUserApi->get('uid')], true)) { |
||
| 320 | unset($userIds[$k]); |
||
| 321 | $this->addFlash('danger', $this->trans('You are not allowed to delete user id %uid%', ['%uid%' => $uid])); |
||
| 322 | continue; |
||
| 323 | } |
||
| 324 | $hookDispatcher->dispatch(UserManagementUiHooksSubscriber::DELETE_VALIDATE, $hook = new ValidationHook()); |
||
| 325 | if ($hook->getValidators()->hasErrors()) { |
||
| 326 | $valid = false; |
||
| 327 | } |
||
| 328 | } |
||
| 329 | if ($valid && $deleteConfirmationForm->isValid()) { |
||
| 330 | // send email to 'denied' registrations. see MailHelper::sendNotification (regdeny) #2915 |
||
| 331 | $deletedUsers = $userRepository->query(['uid' => ['operator' => 'in', 'operand' => $userIds]]); |
||
| 332 | foreach ($deletedUsers as $deletedUser) { |
||
| 333 | if (UsersConstant::ACTIVATED_ACTIVE === $deletedUser->getActivated()) { |
||
| 334 | $eventDispatcher->dispatch(new ActiveUserPostDeletedEvent($deletedUser)); |
||
| 335 | } else { |
||
| 336 | $eventDispatcher->dispatch(new RegistrationPostDeletedEvent($deletedUser)); |
||
| 337 | } |
||
| 338 | $eventDispatcher->dispatch(new DeleteUserFormPostValidatedEvent($deleteConfirmationForm, $deletedUser)); |
||
| 339 | $hookDispatcher->dispatch(UserManagementUiHooksSubscriber::DELETE_PROCESS, new ProcessHook($deletedUser->getUid())); |
||
| 340 | $userRepository->removeAndFlush($deletedUser); |
||
| 341 | } |
||
| 342 | $this->addFlash( |
||
| 343 | 'success', |
||
| 344 | /** @Desc("{count, plural,\n one {User deleted!}\n other {# users deleted!}\n}") */ |
||
| 345 | $this->getTranslator()->trans( |
||
| 346 | 'plural_n.users.deleted', |
||
| 347 | ['%count%' => count($deletedUsers)] |
||
| 348 | ) |
||
| 349 | ); |
||
| 350 | |||
| 351 | return $this->redirectToRoute('zikulausersmodule_useradministration_list'); |
||
| 352 | } |
||
| 353 | } |
||
| 354 | $users = $userRepository->findByUids($uids); |
||
| 355 | |||
| 356 | return [ |
||
| 357 | 'users' => $users, |
||
| 358 | 'form' => $deleteConfirmationForm->createView(), |
||
| 359 | 'additionalTemplates' => isset($deleteUserFormPostCreatedEvent) ? $deleteUserFormPostCreatedEvent->getTemplates() : [] |
||
| 360 | ]; |
||
| 361 | } |
||
| 362 | |||
| 363 | /** |
||
| 364 | * @Route("/search") |
||
| 365 | * @PermissionCheck("moderate") |
||
| 366 | * @Theme("admin") |
||
| 367 | * @Template("@ZikulaUsersModule/UserAdministration/search.html.twig") |
||
| 368 | * |
||
| 369 | * @return array|Response |
||
| 370 | */ |
||
| 371 | public function searchAction( |
||
| 372 | Request $request, |
||
| 373 | UserRepositoryInterface $userRepository, |
||
| 374 | VariableApiInterface $variableApi |
||
| 375 | ) { |
||
| 376 | $form = $this->createForm(SearchUserType::class, []); |
||
| 377 | $form->handleRequest($request); |
||
| 378 | if ($form->isSubmitted()) { |
||
| 379 | $resultsForm = $this->createForm(DeleteType::class, [], [ |
||
| 380 | 'choices' => $userRepository->queryBySearchForm($form->getData(), 250), |
||
| 381 | 'action' => $this->generateUrl('zikulausersmodule_useradministration_delete') |
||
| 382 | ]); |
||
| 383 | |||
| 384 | return $this->render('@ZikulaUsersModule/UserAdministration/searchResults.html.twig', [ |
||
| 385 | 'resultsForm' => $resultsForm->createView(), |
||
| 386 | 'mailForm' => $this->buildMailForm($variableApi)->createView() |
||
| 387 | ]); |
||
| 388 | } |
||
| 389 | |||
| 390 | return [ |
||
| 391 | 'form' => $form->createView() |
||
| 392 | ]; |
||
| 393 | } |
||
| 394 | |||
| 395 | /** |
||
| 396 | * @Route("/mail") |
||
| 397 | * @PermissionCheck({"$_zkModule::MailUsers", "::", "comment"}) |
||
| 398 | */ |
||
| 399 | public function mailUsersAction( |
||
| 423 | } |
||
| 424 | |||
| 425 | private function buildMailForm(VariableApiInterface $variableApi): FormInterface |
||
| 426 | { |
||
| 427 | return $this->createForm(MailType::class, [ |
||
| 428 | 'from' => $variableApi->getSystemVar('sitename'), |
||
| 429 | 'replyto' => $variableApi->getSystemVar('adminmail'), |
||
| 430 | 'format' => 'text', |
||
| 431 | 'batchsize' => 100 |
||
| 432 | ], [ |
||
| 433 | 'action' => $this->generateUrl('zikulausersmodule_useradministration_mailusers') |
||
| 434 | ]); |
||
| 435 | } |
||
| 436 | |||
| 437 | /** |
||
| 438 | * Prevent user from modifying certain aspects of self. |
||
| 439 | */ |
||
| 440 | private function checkSelf( |
||
| 466 | } |
||
| 467 | } |
||
| 468 | } |
||
| 469 |
Loading history...