Total Complexity | 40 |
Total Lines | 157 |
Duplicated Lines | 0 % |
Changes | 3 | ||
Bugs | 0 | Features | 0 |
Complex classes like SessionVoter 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 SessionVoter, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
22 | class SessionVoter extends Voter |
||
23 | { |
||
24 | public const VIEW = 'VIEW'; |
||
25 | public const EDIT = 'EDIT'; |
||
26 | public const DELETE = 'DELETE'; |
||
27 | |||
28 | public function __construct( |
||
32 | |||
33 | protected function supports(string $attribute, $subject): bool |
||
42 | } |
||
43 | |||
44 | /** |
||
45 | * Check if user has access to a session. |
||
46 | * |
||
47 | * {@inheritdoc} |
||
48 | */ |
||
49 | protected function voteOnAttribute(string $attribute, $subject, TokenInterface $token): bool |
||
50 | { |
||
51 | /** @var User $user */ |
||
52 | $user = $token->getUser(); |
||
53 | |||
54 | // Make sure there is a user object (i.e. that the user is logged in) |
||
55 | if (!$user instanceof UserInterface) { |
||
56 | return false; |
||
57 | } |
||
58 | |||
59 | // Admins have access to everything. |
||
60 | if ($this->security->isGranted('ROLE_ADMIN')) { |
||
61 | return true; |
||
62 | } |
||
63 | |||
64 | // Checks if the current course was set up |
||
65 | // $session->getCurrentCourse() is set in the class CidReqListener. |
||
66 | /** @var Session $session */ |
||
67 | $session = $subject; |
||
68 | $currentCourse = $session->getCurrentCourse(); |
||
69 | |||
70 | // Course checks. |
||
71 | if ($currentCourse && $currentCourse->isHidden()) { |
||
72 | return false; |
||
73 | } |
||
74 | |||
75 | switch ($attribute) { |
||
76 | case self::VIEW: |
||
77 | // @todo improve performance. |
||
78 | $userIsGeneralCoach = $session->hasUserAsGeneralCoach($user); |
||
79 | if (null === $currentCourse) { |
||
80 | $userIsStudent = $session->getSessionRelCourseByUser($user, Session::STUDENT)->count() > 0; |
||
81 | $userIsCourseCoach = $session->hasCoachInCourseList($user); // The current course will be checked in CourseVoter. |
||
82 | } else { |
||
83 | $userIsCourseCoach = $session->hasCourseCoachInCourse($user, $currentCourse); |
||
84 | $userIsStudent = $session->hasUserInCourse($user, $currentCourse, Session::STUDENT); |
||
85 | } |
||
86 | |||
87 | $visibilityForUser = $session->setAccessVisibilityByUser($user); |
||
88 | |||
89 | if ($userIsStudent && Session::LIST_ONLY == $visibilityForUser) { |
||
90 | return false; |
||
91 | } |
||
92 | |||
93 | if ($userIsGeneralCoach || $userIsCourseCoach) { |
||
94 | $user->addRole(ResourceNodeVoter::ROLE_CURRENT_COURSE_SESSION_TEACHER); |
||
95 | } elseif ($userIsStudent) { // Student access. |
||
96 | $user->addRole(ResourceNodeVoter::ROLE_CURRENT_COURSE_SESSION_STUDENT); |
||
97 | } |
||
98 | |||
99 | if ( |
||
100 | ($userIsGeneralCoach || $userIsCourseCoach || $userIsStudent) |
||
101 | && $visibilityForUser != Session::INVISIBLE |
||
102 | ) { |
||
103 | return true; |
||
104 | } |
||
105 | |||
106 | return false; |
||
107 | |||
108 | case self::EDIT: |
||
109 | case self::DELETE: |
||
110 | $canEdit = $this->canEditSession($user, $session, false); |
||
111 | |||
112 | if ($canEdit) { |
||
113 | $user->addRole(ResourceNodeVoter::ROLE_CURRENT_COURSE_SESSION_TEACHER); |
||
114 | |||
115 | return true; |
||
116 | } |
||
117 | |||
118 | return false; |
||
119 | } |
||
120 | |||
121 | // User don't have access to the session |
||
122 | return false; |
||
123 | } |
||
124 | |||
125 | private function canEditSession(User $user, Session $session, bool $checkSession = true): bool |
||
126 | { |
||
127 | if (!$this->allowToManageSessions()) { |
||
128 | return false; |
||
129 | } |
||
130 | |||
131 | if ($this->security->isGranted('ROLE_ADMIN') && $this->allowed($user, $session)) { |
||
132 | return true; |
||
133 | } |
||
134 | |||
135 | if ($checkSession) { |
||
136 | return $this->allowed($user, $session); |
||
137 | } |
||
138 | |||
139 | return true; |
||
140 | } |
||
141 | |||
142 | private function allowToManageSessions(): bool |
||
143 | { |
||
144 | if ($this->allowManageAllSessions()) { |
||
145 | return true; |
||
146 | } |
||
147 | |||
148 | $setting = $this->settingsManager->getSetting('session.allow_teachers_to_create_sessions'); |
||
149 | |||
150 | return 'true' === $setting && $this->security->isGranted('ROLE_TEACHER'); |
||
151 | } |
||
152 | |||
153 | private function allowManageAllSessions(): bool |
||
154 | { |
||
155 | return $this->security->isGranted('ROLE_ADMIN') || $this->security->isGranted('ROLE_SESSION_MANAGER'); |
||
156 | } |
||
157 | |||
158 | private function allowed(User $user, Session $session): bool |
||
179 | } |
||
180 | } |
||
181 |