nazar-pc /
CleverStyle-Framework
Complex classes like Management 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 Management, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 22 | trait Management { |
||
| 23 | /** |
||
| 24 | * Id of current session |
||
| 25 | * |
||
| 26 | * @var false|string |
||
| 27 | */ |
||
| 28 | protected $session_id; |
||
| 29 | /** |
||
| 30 | * User id of current session |
||
| 31 | * |
||
| 32 | * @var int |
||
| 33 | */ |
||
| 34 | protected $user_id; |
||
| 35 | /** |
||
| 36 | * @var bool |
||
| 37 | */ |
||
| 38 | protected $is_admin; |
||
| 39 | /** |
||
| 40 | * @var bool |
||
| 41 | */ |
||
| 42 | protected $is_user; |
||
| 43 | /** |
||
| 44 | * @var bool |
||
| 45 | */ |
||
| 46 | protected $is_guest; |
||
| 47 | /** |
||
| 48 | * Use cookie as source of session id, load session |
||
| 49 | */ |
||
| 50 | 26 | protected function init_session () { |
|
| 60 | /** |
||
| 61 | * Updates information about who is user accessed by methods ::guest() ::user() admin() |
||
| 62 | */ |
||
| 63 | 26 | protected function update_user_is () { |
|
| 64 | 26 | $this->is_guest = $this->user_id == User::GUEST_ID; |
|
| 65 | 26 | $this->is_user = false; |
|
| 66 | 26 | $this->is_admin = false; |
|
| 67 | 26 | if ($this->is_guest) { |
|
| 68 | 26 | return; |
|
| 69 | } |
||
| 70 | /** |
||
| 71 | * Checking of user type |
||
| 72 | */ |
||
| 73 | 18 | $groups = User::instance()->get_groups($this->user_id) ?: []; |
|
| 74 | 18 | if (in_array(User::ADMIN_GROUP_ID, $groups)) { |
|
| 75 | 4 | $this->is_admin = true; |
|
| 76 | 4 | $this->is_user = true; |
|
| 77 | 14 | } elseif (in_array(User::USER_GROUP_ID, $groups)) { |
|
| 78 | 14 | $this->is_user = true; |
|
| 79 | } |
||
| 80 | 18 | } |
|
| 81 | /** |
||
| 82 | * Is admin |
||
| 83 | * |
||
| 84 | * @return bool |
||
| 85 | */ |
||
| 86 | 8 | function admin () { |
|
| 89 | /** |
||
| 90 | * Is user |
||
| 91 | * |
||
| 92 | * @return bool |
||
| 93 | */ |
||
| 94 | function user () { |
||
| 97 | /** |
||
| 98 | * Is guest |
||
| 99 | * |
||
| 100 | * @return bool |
||
| 101 | */ |
||
| 102 | 6 | function guest () { |
|
| 105 | /** |
||
| 106 | * Returns id of current session |
||
| 107 | * |
||
| 108 | * @return false|string |
||
| 109 | */ |
||
| 110 | 22 | function get_id () { |
|
| 113 | /** |
||
| 114 | * Returns user id of current session |
||
| 115 | * |
||
| 116 | * @return int |
||
| 117 | */ |
||
| 118 | 26 | function get_user () { |
|
| 121 | /** |
||
| 122 | * Returns session details by session id |
||
| 123 | * |
||
| 124 | * @param false|null|string $session_id If `null` - loaded from `$this->session_id`, and if that also empty - from cookies |
||
| 125 | * |
||
| 126 | * @return false|array |
||
| 127 | */ |
||
| 128 | function get ($session_id) { |
||
| 133 | /** |
||
| 134 | * @param false|null|string $session_id |
||
| 135 | * |
||
| 136 | * @return false|array |
||
| 137 | */ |
||
| 138 | protected function get_internal ($session_id) { |
||
| 161 | /** |
||
| 162 | * Check whether session was not expired, user agent and IP corresponds to what is expected and user is actually active |
||
| 163 | * |
||
| 164 | * @param mixed $session_data |
||
| 165 | * |
||
| 166 | * @return bool |
||
| 167 | */ |
||
| 168 | protected function is_good_session ($session_data) { |
||
| 174 | /** |
||
| 175 | * Whether session data belongs to current visitor (user agent, remote addr and ip check) |
||
| 176 | * |
||
| 177 | * @param string $session_id |
||
| 178 | * @param string $user_agent |
||
| 179 | * @param string $remote_addr |
||
| 180 | * @param string $ip |
||
| 181 | * |
||
| 182 | * @return bool |
||
| 183 | */ |
||
| 184 | function is_session_owner ($session_id, $user_agent, $remote_addr, $ip) { |
||
| 188 | /** |
||
| 189 | * Whether session data belongs to current visitor (user agent, remote addr and ip check) |
||
| 190 | * |
||
| 191 | * @param array $session_data |
||
| 192 | * @param string|null $user_agent |
||
| 193 | * @param string|null $remote_addr |
||
| 194 | * @param string|null $ip |
||
| 195 | * |
||
| 196 | * @return bool |
||
| 197 | */ |
||
| 198 | protected function is_session_owner_internal ($session_data, $user_agent = null, $remote_addr = null, $ip = null) { |
||
| 218 | /** |
||
| 219 | * Load session by id and return id of session owner (user), update session expiration |
||
| 220 | * |
||
| 221 | * @param false|null|string $session_id If not specified - loaded from `$this->session_id`, and if that also empty - from cookies |
||
| 222 | * |
||
| 223 | * @return int User id |
||
| 224 | */ |
||
| 225 | function load ($session_id = null) { |
||
| 250 | /** |
||
| 251 | * Initialize session (set user id, session id and update who user is) |
||
| 252 | * |
||
| 253 | * @param string $session_id |
||
| 254 | * @param int $user_id |
||
| 255 | * |
||
| 256 | * @return int User id |
||
| 257 | */ |
||
| 258 | 18 | protected function load_initialization ($session_id, $user_id) { |
|
| 264 | /** |
||
| 265 | * Whether profile is activated, not disabled and not blocked |
||
| 266 | * |
||
| 267 | * @param int $user |
||
| 268 | * |
||
| 269 | * @return bool |
||
| 270 | */ |
||
| 271 | 18 | protected function is_user_active ($user) { |
|
| 272 | /** |
||
| 273 | * Optimization, more data requested than actually used here, because data will be requested later, and it would be nice to have that data cached |
||
| 274 | */ |
||
| 275 | 18 | $data = User::instance()->get( |
|
| 276 | [ |
||
| 277 | 18 | 'login', |
|
| 278 | 'username', |
||
| 279 | 'language', |
||
| 280 | 'timezone', |
||
| 281 | 'status', |
||
| 282 | 'block_until', |
||
| 283 | 'avatar' |
||
| 284 | ], |
||
| 285 | $user |
||
| 286 | ); |
||
| 287 | 18 | if (!$data) { |
|
| 288 | return false; |
||
| 289 | } |
||
| 290 | 18 | $L = Language::prefix('system_profile_sign_in_'); |
|
| 291 | 18 | $Page = Page::instance(); |
|
| 292 | 18 | switch ($data['status']) { |
|
| 293 | 18 | case User::STATUS_INACTIVE: |
|
| 294 | /** |
||
| 295 | * If user is disabled |
||
| 296 | */ |
||
| 297 | 2 | $Page->warning($L->your_account_disabled); |
|
| 298 | 2 | return false; |
|
| 299 | 18 | case User::STATUS_NOT_ACTIVATED: |
|
| 300 | /** |
||
| 301 | * If user is not active |
||
| 302 | */ |
||
| 303 | $Page->warning($L->your_account_is_not_active); |
||
| 304 | return false; |
||
| 305 | } |
||
| 306 | 18 | if ($data['block_until'] > time()) { |
|
| 307 | /** |
||
| 308 | * If user if blocked |
||
| 309 | */ |
||
| 310 | $Page->warning($L->your_account_blocked_until(date($L->_datetime, $data['block_until']))); |
||
| 311 | return false; |
||
| 312 | } |
||
| 313 | 18 | return true; |
|
| 314 | } |
||
| 315 | /** |
||
| 316 | * Create the session for the user with specified id |
||
| 317 | * |
||
| 318 | * @param int $user |
||
| 319 | * @param bool $delete_current_session |
||
| 320 | * |
||
| 321 | * @return false|string Session id on success, `false` otherwise |
||
| 322 | */ |
||
| 323 | 18 | function add ($user, $delete_current_session = true) { |
|
| 324 | 18 | $user = (int)$user; |
|
| 325 | 18 | if (!$user) { |
|
| 326 | return false; |
||
| 327 | } |
||
| 328 | 18 | if ($delete_current_session && is_md5($this->session_id)) { |
|
| 329 | 6 | $this->del_internal($this->session_id, false); |
|
| 330 | } |
||
| 331 | 18 | if (!$this->is_user_active($user)) { |
|
| 332 | /** |
||
| 333 | * If data was not loaded or account is not active - create guest session |
||
| 334 | */ |
||
| 335 | 2 | return $this->add(User::GUEST_ID); |
|
| 336 | } |
||
| 337 | 18 | $session_data = $this->create_unique_session($user); |
|
| 338 | 18 | Response::instance()->cookie('session', $session_data['id'], $session_data['expire'], true); |
|
| 339 | 18 | $this->load_initialization($session_data['id'], $session_data['user']); |
|
| 340 | /** |
||
| 341 | * Delete old sessions using probability and system configuration of inserts limits and update ratio |
||
| 342 | */ |
||
| 343 | 18 | $Config = Config::instance(); |
|
| 344 | 18 | if (mt_rand(0, $Config->core['inserts_limit']) < $Config->core['inserts_limit'] / 100 * (100 - $Config->core['update_ratio']) / 5) { |
|
| 345 | 3 | $this->delete_old_sessions(); |
|
| 346 | } |
||
| 347 | 18 | Event::instance()->fire( |
|
| 348 | 18 | 'System/Session/add', |
|
| 349 | [ |
||
| 350 | 18 | 'session_data' => $session_data |
|
| 351 | ] |
||
| 352 | ); |
||
| 353 | 18 | return $session_data['id']; |
|
| 354 | } |
||
| 355 | /** |
||
| 356 | * @param int $user |
||
| 357 | * |
||
| 358 | * @return array Session data |
||
| 359 | */ |
||
| 360 | 18 | protected function create_unique_session ($user) { |
|
| 388 | /** |
||
| 389 | * Destroying of the session |
||
| 390 | * |
||
| 391 | * @param null|string $session_id |
||
| 392 | * |
||
| 393 | * @return bool |
||
| 394 | */ |
||
| 395 | 6 | function del ($session_id = null) { |
|
| 398 | /** |
||
| 399 | * Deletion of the session |
||
| 400 | * |
||
| 401 | * @param string|null $session_id |
||
| 402 | * @param bool $create_guest_session |
||
| 403 | * |
||
| 404 | * @return bool |
||
| 405 | */ |
||
| 406 | 8 | protected function del_internal ($session_id = null, $create_guest_session = true) { |
|
| 437 | /** |
||
| 438 | * Delete all old sessions from DB |
||
| 439 | */ |
||
| 440 | 3 | protected function delete_old_sessions () { |
|
| 446 | /** |
||
| 447 | * Deletion of all user sessions |
||
| 448 | * |
||
| 449 | * @param false|int $user If not specified - current user assumed |
||
| 450 | * |
||
| 451 | * @return bool |
||
| 452 | */ |
||
| 453 | 14 | function del_all ($user = false) { |
|
| 476 | } |
||
| 477 |
