ezsystems /
ezpublish-kernel
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:
Complex classes like Role 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 Role, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 34 | class Role extends RestController |
||
| 35 | { |
||
| 36 | /** |
||
| 37 | * Role service. |
||
| 38 | * |
||
| 39 | * @var \eZ\Publish\API\Repository\RoleService |
||
| 40 | */ |
||
| 41 | protected $roleService; |
||
| 42 | |||
| 43 | /** |
||
| 44 | * User service. |
||
| 45 | * |
||
| 46 | * @var \eZ\Publish\API\Repository\UserService |
||
| 47 | */ |
||
| 48 | protected $userService; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Location service. |
||
| 52 | * |
||
| 53 | * @var \eZ\Publish\API\Repository\LocationService |
||
| 54 | */ |
||
| 55 | protected $locationService; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * Construct controller. |
||
| 59 | * |
||
| 60 | * @param \eZ\Publish\API\Repository\RoleService $roleService |
||
| 61 | * @param \eZ\Publish\API\Repository\UserService $userService |
||
| 62 | * @param \eZ\Publish\API\Repository\LocationService $locationService |
||
| 63 | */ |
||
| 64 | public function __construct( |
||
| 65 | RoleService $roleService, |
||
| 66 | UserService $userService, |
||
| 67 | LocationService $locationService |
||
| 68 | ) { |
||
| 69 | $this->roleService = $roleService; |
||
| 70 | $this->userService = $userService; |
||
| 71 | $this->locationService = $locationService; |
||
| 72 | } |
||
| 73 | |||
| 74 | /** |
||
| 75 | * Create new role. |
||
| 76 | * |
||
| 77 | * Defaults to publishing the role, but you can create a draft instead by setting the POST parameter publish=false |
||
| 78 | * |
||
| 79 | * @return \eZ\Publish\Core\REST\Server\Values\CreatedRole |
||
| 80 | */ |
||
| 81 | public function createRole(Request $request) |
||
| 127 | |||
| 128 | /** |
||
| 129 | * Creates a new RoleDraft for an existing Role. |
||
| 130 | * |
||
| 131 | * @since 6.2 |
||
| 132 | * |
||
| 133 | * @throws \eZ\Publish\API\Repository\Exceptions\ForbiddenException if the Role already has a Role Draft that will need to be removed first, |
||
| 134 | * or if the authenticated user is not allowed to create a role |
||
| 135 | * @throws \eZ\Publish\Core\REST\Server\Exceptions\BadRequestException if a policy limitation in the $roleCreateStruct is not valid |
||
| 136 | * |
||
| 137 | * @return \eZ\Publish\Core\REST\Server\Values\CreatedRole |
||
| 138 | */ |
||
| 139 | public function createRoleDraft($roleId, Request $request) |
||
| 157 | |||
| 158 | /** |
||
| 159 | * Loads list of roles. |
||
| 160 | * |
||
| 161 | * @return \eZ\Publish\Core\REST\Server\Values\RoleList |
||
| 162 | */ |
||
| 163 | public function listRoles(Request $request) |
||
| 164 | { |
||
| 165 | $roles = array(); |
||
| 166 | if ($request->query->has('identifier')) { |
||
| 167 | try { |
||
| 168 | $role = $this->roleService->loadRoleByIdentifier($request->query->get('identifier')); |
||
| 169 | $roles[] = $role; |
||
| 170 | } catch (APINotFoundException $e) { |
||
| 171 | // Do nothing |
||
| 172 | } |
||
| 173 | } else { |
||
| 174 | $offset = $request->query->has('offset') ? (int)$request->query->get('offset') : 0; |
||
| 175 | $limit = $request->query->has('limit') ? (int)$request->query->get('limit') : -1; |
||
| 176 | |||
| 177 | $roles = array_slice( |
||
| 178 | $this->roleService->loadRoles(), |
||
| 179 | $offset >= 0 ? $offset : 0, |
||
| 180 | $limit >= 0 ? $limit : null |
||
| 181 | ); |
||
| 182 | } |
||
| 183 | |||
| 184 | return new Values\RoleList($roles, $request->getPathInfo()); |
||
| 185 | } |
||
| 186 | |||
| 187 | /** |
||
| 188 | * Loads role. |
||
| 189 | * |
||
| 190 | * @param $roleId |
||
| 191 | * |
||
| 192 | * @return \eZ\Publish\API\Repository\Values\User\Role |
||
| 193 | */ |
||
| 194 | public function loadRole($roleId) |
||
| 195 | { |
||
| 196 | return $this->roleService->loadRole($roleId); |
||
| 197 | } |
||
| 198 | |||
| 199 | /** |
||
| 200 | * Loads a role draft. |
||
| 201 | * |
||
| 202 | * @param mixed $roleId Original role ID, or ID of the role draft itself |
||
| 203 | * |
||
| 204 | * @return \eZ\Publish\API\Repository\Values\User\RoleDraft |
||
| 205 | */ |
||
| 206 | public function loadRoleDraft($roleId) |
||
| 207 | { |
||
| 208 | try { |
||
| 209 | // First try to load the draft for given role. |
||
| 210 | return $this->roleService->loadRoleDraftByRoleId($roleId); |
||
| 211 | } catch (NotFoundException $e) { |
||
| 212 | // We might want a newly created role, so try to load it by its ID. |
||
| 213 | // loadRoleDraft() might throw a NotFoundException (wrong $roleId). If so, let it bubble up. |
||
| 214 | return $this->roleService->loadRoleDraft($roleId); |
||
| 215 | } |
||
| 216 | } |
||
| 217 | |||
| 218 | /** |
||
| 219 | * Updates a role. |
||
| 220 | * |
||
| 221 | * @param $roleId |
||
| 222 | * |
||
| 223 | * @return \eZ\Publish\API\Repository\Values\User\Role |
||
| 224 | */ |
||
| 225 | public function updateRole($roleId, Request $request) |
||
| 226 | { |
||
| 227 | $createStruct = $this->inputDispatcher->parse( |
||
| 228 | new Message( |
||
| 229 | array('Content-Type' => $request->headers->get('Content-Type')), |
||
| 230 | $request->getContent() |
||
| 231 | ) |
||
| 232 | ); |
||
| 233 | |||
| 234 | return $this->roleService->updateRole( |
||
| 235 | $this->roleService->loadRole($roleId), |
||
| 236 | $this->mapToUpdateStruct($createStruct) |
||
| 237 | ); |
||
| 238 | } |
||
| 239 | |||
| 240 | /** |
||
| 241 | * Updates a role draft. |
||
| 242 | * |
||
| 243 | * @param mixed $roleId Original role ID, or ID of the role draft itself |
||
| 244 | * |
||
| 245 | * @return \eZ\Publish\API\Repository\Values\User\RoleDraft |
||
| 246 | */ |
||
| 247 | public function updateRoleDraft($roleId, Request $request) |
||
| 267 | |||
| 268 | /** |
||
| 269 | * Publishes a role draft. |
||
| 270 | * |
||
| 271 | * @param mixed $roleId Original role ID, or ID of the role draft itself |
||
| 272 | * |
||
| 273 | * @return \eZ\Publish\Core\REST\Server\Values\PublishedRole |
||
| 274 | */ |
||
| 275 | public function publishRoleDraft($roleId) |
||
| 276 | { |
||
| 277 | try { |
||
| 278 | // First try to load the draft for given role. |
||
| 279 | $roleDraft = $this->roleService->loadRoleDraftByRoleId($roleId); |
||
| 280 | } catch (NotFoundException $e) { |
||
| 281 | // We might want a newly created role, so try to load it by its ID. |
||
| 282 | // loadRoleDraft() might throw a NotFoundException (wrong $roleId). If so, let it bubble up. |
||
| 283 | $roleDraft = $this->roleService->loadRoleDraft($roleId); |
||
| 284 | } |
||
| 285 | |||
| 286 | $this->roleService->publishRoleDraft($roleDraft); |
||
| 287 | |||
| 288 | $role = $this->roleService->loadRole($roleId); |
||
| 289 | |||
| 290 | return new Values\PublishedRole(['role' => new Values\RestRole($role)]); |
||
| 291 | } |
||
| 292 | |||
| 293 | /** |
||
| 294 | * Delete a role by ID. |
||
| 295 | * |
||
| 296 | * @param $roleId |
||
| 297 | * |
||
| 298 | * @return \eZ\Publish\Core\REST\Server\Values\NoContent |
||
| 299 | */ |
||
| 300 | public function deleteRole($roleId) |
||
| 301 | { |
||
| 302 | $this->roleService->deleteRole( |
||
| 303 | $this->roleService->loadRole($roleId) |
||
| 304 | ); |
||
| 305 | |||
| 306 | return new Values\NoContent(); |
||
| 307 | } |
||
| 308 | |||
| 309 | /** |
||
| 310 | * Delete a role draft by ID. |
||
| 311 | * |
||
| 312 | * @since 6.2 |
||
| 313 | * |
||
| 314 | * @param $roleId |
||
| 315 | * |
||
| 316 | * @return \eZ\Publish\Core\REST\Server\Values\NoContent |
||
| 317 | */ |
||
| 318 | public function deleteRoleDraft($roleId) |
||
| 326 | |||
| 327 | /** |
||
| 328 | * Loads the policies for the role. |
||
| 329 | * |
||
| 330 | * @param $roleId |
||
| 331 | * |
||
| 332 | * @return \eZ\Publish\Core\REST\Server\Values\PolicyList |
||
| 333 | */ |
||
| 334 | public function loadPolicies($roleId, Request $request) |
||
| 335 | { |
||
| 336 | $loadedRole = $this->roleService->loadRole($roleId); |
||
| 337 | |||
| 338 | return new Values\PolicyList($loadedRole->getPolicies(), $request->getPathInfo()); |
||
| 339 | } |
||
| 340 | |||
| 341 | /** |
||
| 342 | * Deletes all policies from a role. |
||
| 343 | * |
||
| 344 | * @param $roleId |
||
| 345 | * |
||
| 346 | * @return \eZ\Publish\Core\REST\Server\Values\NoContent |
||
| 347 | */ |
||
| 348 | public function deletePolicies($roleId) |
||
| 358 | |||
| 359 | /** |
||
| 360 | * Loads a policy. |
||
| 361 | * |
||
| 362 | * @param $roleId |
||
| 363 | * @param $policyId |
||
| 364 | * |
||
| 365 | * @throws \eZ\Publish\Core\REST\Common\Exceptions\NotFoundException |
||
| 366 | * |
||
| 367 | * @return \eZ\Publish\API\Repository\Values\User\Policy |
||
| 368 | */ |
||
| 369 | public function loadPolicy($roleId, $policyId, Request $request) |
||
| 370 | { |
||
| 371 | $loadedRole = $this->roleService->loadRole($roleId); |
||
| 372 | foreach ($loadedRole->getPolicies() as $policy) { |
||
| 373 | if ($policy->id == $policyId) { |
||
| 374 | return $policy; |
||
| 375 | } |
||
| 376 | } |
||
| 377 | |||
| 378 | throw new Exceptions\NotFoundException("Policy not found: '{$request->getPathInfo()}'."); |
||
| 379 | } |
||
| 380 | |||
| 381 | /** |
||
| 382 | * Adds a policy to role. |
||
| 383 | * |
||
| 384 | * @param $roleId int ID of a role or a role draft |
||
| 385 | * |
||
| 386 | * @return \eZ\Publish\Core\REST\Server\Values\CreatedPolicy |
||
| 387 | */ |
||
| 388 | public function addPolicy($roleId, Request $request) |
||
| 419 | |||
| 420 | /** |
||
| 421 | * Adds a policy to a role draft. |
||
| 422 | * |
||
| 423 | * @since 6.2 |
||
| 424 | * @deprecated since 6.3, use {@see addPolicy} |
||
| 425 | * |
||
| 426 | * @param $roleId |
||
| 427 | * |
||
| 428 | * @return \eZ\Publish\Core\REST\Server\Values\CreatedPolicy |
||
| 429 | */ |
||
| 430 | public function addPolicyByRoleDraft($roleId, Request $request) |
||
| 454 | |||
| 455 | /** |
||
| 456 | * Get the last added policy for $role. |
||
| 457 | * |
||
| 458 | * This is needed because the RoleService addPolicy() and addPolicyByRoleDraft() methods return the role, |
||
| 459 | * not the policy. |
||
| 460 | * |
||
| 461 | * @param $role \eZ\Publish\API\Repository\Values\User\Role |
||
| 462 | * |
||
| 463 | * @return \eZ\Publish\API\Repository\Values\User\Policy |
||
| 464 | */ |
||
| 465 | private function getLastAddedPolicy($role) |
||
| 478 | |||
| 479 | /** |
||
| 480 | * Updates a policy. |
||
| 481 | * |
||
| 482 | * @param $roleId int ID of a role or a role draft |
||
| 483 | * @param $policyId int ID of a policy |
||
| 484 | * |
||
| 485 | * @throws \eZ\Publish\Core\REST\Common\Exceptions\NotFoundException |
||
| 486 | * |
||
| 487 | * @return \eZ\Publish\API\Repository\Values\User\Policy |
||
| 488 | */ |
||
| 489 | public function updatePolicy($roleId, $policyId, Request $request) |
||
| 532 | |||
| 533 | /** |
||
| 534 | * Updates a policy. |
||
| 535 | * |
||
| 536 | * @since 6.2 |
||
| 537 | * @deprecated since 6.3, use {@see updatePolicy} |
||
| 538 | * |
||
| 539 | * @param $roleId |
||
| 540 | * @param $policyId |
||
| 541 | * |
||
| 542 | * @throws \eZ\Publish\Core\REST\Common\Exceptions\NotFoundException |
||
| 543 | * |
||
| 544 | * @return \eZ\Publish\API\Repository\Values\User\Policy |
||
| 545 | */ |
||
| 546 | public function updatePolicyByRoleDraft($roleId, $policyId, Request $request) |
||
| 571 | |||
| 572 | /** |
||
| 573 | * Delete a policy from role. |
||
| 574 | * |
||
| 575 | * @param $roleId int ID of a role or a role draft |
||
| 576 | * @param $policyId int ID of a policy |
||
| 577 | * |
||
| 578 | * @throws \eZ\Publish\Core\REST\Common\Exceptions\NotFoundException |
||
| 579 | * |
||
| 580 | * @return \eZ\Publish\Core\REST\Server\Values\NoContent |
||
| 581 | */ |
||
| 582 | public function deletePolicy($roleId, $policyId, Request $request) |
||
| 622 | |||
| 623 | /** |
||
| 624 | * Remove a policy from a role draft. |
||
| 625 | * |
||
| 626 | * @since 6.2 |
||
| 627 | * @deprecated since 6.3, use {@see deletePolicy} |
||
| 628 | * |
||
| 629 | * @param $roleId |
||
| 630 | * @param $policyId |
||
| 631 | * |
||
| 632 | * @throws \eZ\Publish\Core\REST\Common\Exceptions\NotFoundException |
||
| 633 | * |
||
| 634 | * @return \eZ\Publish\Core\REST\Server\Values\NoContent |
||
| 635 | */ |
||
| 636 | View Code Duplication | public function removePolicyByRoleDraft($roleId, $policyId, Request $request) |
|
| 656 | |||
| 657 | /** |
||
| 658 | * Assigns role to user. |
||
| 659 | * |
||
| 660 | * @param $userId |
||
| 661 | * |
||
| 662 | * @return \eZ\Publish\Core\REST\Server\Values\RoleAssignmentList |
||
| 663 | */ |
||
| 664 | public function assignRoleToUser($userId, Request $request) |
||
| 665 | { |
||
| 686 | |||
| 687 | /** |
||
| 688 | * Assigns role to user group. |
||
| 689 | * |
||
| 690 | * @param $groupPath |
||
| 691 | * |
||
| 692 | * @return \eZ\Publish\Core\REST\Server\Values\RoleAssignmentList |
||
| 693 | */ |
||
| 694 | public function assignRoleToUserGroup($groupPath, Request $request) |
||
| 719 | |||
| 720 | /** |
||
| 721 | * Un-assigns role from user. |
||
| 722 | * |
||
| 723 | * @param $userId |
||
| 724 | * @param $roleId |
||
| 725 | * |
||
| 726 | * @return \eZ\Publish\Core\REST\Server\Values\RoleAssignmentList |
||
| 727 | */ |
||
| 728 | public function unassignRoleFromUser($userId, $roleId) |
||
| 739 | |||
| 740 | /** |
||
| 741 | * Un-assigns role from user group. |
||
| 742 | * |
||
| 743 | * @param $groupPath |
||
| 744 | * @param $roleId |
||
| 745 | * |
||
| 746 | * @return \eZ\Publish\Core\REST\Server\Values\RoleAssignmentList |
||
| 747 | */ |
||
| 748 | public function unassignRoleFromUserGroup($groupPath, $roleId) |
||
| 761 | |||
| 762 | /** |
||
| 763 | * Loads role assignments for user. |
||
| 764 | * |
||
| 765 | * @param $userId |
||
| 766 | * |
||
| 767 | * @return \eZ\Publish\Core\REST\Server\Values\RoleAssignmentList |
||
| 768 | */ |
||
| 769 | public function loadRoleAssignmentsForUser($userId) |
||
| 777 | |||
| 778 | /** |
||
| 779 | * Loads role assignments for user group. |
||
| 780 | * |
||
| 781 | * @param $groupPath |
||
| 782 | * |
||
| 783 | * @return \eZ\Publish\Core\REST\Server\Values\RoleAssignmentList |
||
| 784 | */ |
||
| 785 | public function loadRoleAssignmentsForUserGroup($groupPath) |
||
| 795 | |||
| 796 | /** |
||
| 797 | * Returns a role assignment to the given user. |
||
| 798 | * |
||
| 799 | * @param $userId |
||
| 800 | * @param $roleId |
||
| 801 | * |
||
| 802 | * @throws \eZ\Publish\Core\REST\Common\Exceptions\NotFoundException |
||
| 803 | * |
||
| 804 | * @return \eZ\Publish\Core\REST\Server\Values\RestUserRoleAssignment |
||
| 805 | */ |
||
| 806 | public function loadRoleAssignmentForUser($userId, $roleId, Request $request) |
||
| 819 | |||
| 820 | /** |
||
| 821 | * Returns a role assignment to the given user group. |
||
| 822 | * |
||
| 823 | * @param $groupPath |
||
| 824 | * @param $roleId |
||
| 825 | * |
||
| 826 | * @throws \eZ\Publish\Core\REST\Common\Exceptions\NotFoundException |
||
| 827 | * |
||
| 828 | * @return \eZ\Publish\Core\REST\Server\Values\RestUserGroupRoleAssignment |
||
| 829 | */ |
||
| 830 | public function loadRoleAssignmentForUserGroup($groupPath, $roleId, Request $request) |
||
| 845 | |||
| 846 | /** |
||
| 847 | * Search all policies which are applied to a given user. |
||
| 848 | * |
||
| 849 | * @return \eZ\Publish\Core\REST\Server\Values\PolicyList |
||
| 850 | */ |
||
| 851 | public function listPoliciesForUser(Request $request) |
||
| 860 | |||
| 861 | /** |
||
| 862 | * Maps a RoleCreateStruct to a RoleUpdateStruct. |
||
| 863 | * |
||
| 864 | * Needed since both structs are encoded into the same media type on input. |
||
| 865 | * |
||
| 866 | * @param \eZ\Publish\API\Repository\Values\User\RoleCreateStruct $createStruct |
||
| 867 | * |
||
| 868 | * @return \eZ\Publish\API\Repository\Values\User\RoleUpdateStruct |
||
| 869 | */ |
||
| 870 | protected function mapToUpdateStruct(RoleCreateStruct $createStruct) |
||
| 878 | } |
||
| 879 |
Loading history...
This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass.
Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type.