Complex classes like Player 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 Player, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
17 | class Player extends AvatarModel implements NamedModel, DuplexUrlInterface, EloInterface |
||
18 | { |
||
19 | /** |
||
20 | * These are built-in roles that cannot be deleted via the web interface so we will be storing these values as |
||
21 | * constant variables. Hopefully, a user won't be silly enough to delete them manually from the database. |
||
22 | * |
||
23 | * @TODO Deprecate these and use the Role constants |
||
24 | */ |
||
25 | const DEVELOPER = Role::DEVELOPER; |
||
26 | const ADMIN = Role::ADMINISTRATOR; |
||
27 | const COP = Role::COP; |
||
28 | const REFEREE = Role::REFEREE; |
||
29 | const S_ADMIN = Role::SYSADMIN; |
||
30 | const PLAYER = Role::PLAYER; |
||
31 | const PLAYER_NO_PM = Role::PLAYER_NO_PM; |
||
32 | |||
33 | /** |
||
34 | * The bzid of the player |
||
35 | * @var int |
||
36 | */ |
||
37 | protected $bzid; |
||
38 | |||
39 | /** |
||
40 | * The id of the player's team |
||
41 | * @var int |
||
42 | */ |
||
43 | protected $team; |
||
44 | |||
45 | /** |
||
46 | * The player's e-mail address |
||
47 | * @var string |
||
48 | */ |
||
49 | protected $email; |
||
50 | |||
51 | /** |
||
52 | * Whether the player has verified their e-mail address |
||
53 | * @var bool |
||
54 | */ |
||
55 | protected $verified; |
||
56 | |||
57 | /** |
||
58 | * What kind of events the player should be e-mailed about |
||
59 | * @var string |
||
60 | */ |
||
61 | protected $receives; |
||
62 | |||
63 | /** |
||
64 | * A confirmation code for the player's e-mail address verification |
||
65 | * @var string |
||
66 | */ |
||
67 | protected $confirmCode; |
||
68 | |||
69 | /** |
||
70 | * Whether the callsign of the player is outdated |
||
71 | * @var bool |
||
72 | */ |
||
73 | protected $outdated; |
||
74 | |||
75 | /** |
||
76 | * The player's profile description |
||
77 | * @var string |
||
78 | */ |
||
79 | protected $description; |
||
80 | |||
81 | /** |
||
82 | * The id of the player's country |
||
83 | * @var int |
||
84 | */ |
||
85 | protected $country; |
||
86 | |||
87 | /** |
||
88 | * The site theme this player has chosen |
||
89 | * @var string |
||
90 | */ |
||
91 | protected $theme; |
||
92 | |||
93 | /** |
||
94 | * Whether or not this player has opted-in for color blindness assistance. |
||
95 | * @var bool |
||
96 | */ |
||
97 | protected $color_blind_enabled; |
||
98 | |||
99 | /** |
||
100 | * The player's timezone PHP identifier, e.g. "Europe/Paris" |
||
101 | * @var string |
||
102 | */ |
||
103 | protected $timezone; |
||
104 | |||
105 | /** |
||
106 | * The date the player joined the site |
||
107 | * @var TimeDate |
||
108 | */ |
||
109 | protected $joined; |
||
110 | |||
111 | /** |
||
112 | * The date of the player's last login |
||
113 | * @var TimeDate |
||
114 | */ |
||
115 | protected $last_login; |
||
116 | |||
117 | /** |
||
118 | * The date of the player's last match |
||
119 | * @var Match |
||
120 | */ |
||
121 | protected $last_match; |
||
122 | |||
123 | /** |
||
124 | * The roles a player belongs to |
||
125 | * @var Role[] |
||
126 | */ |
||
127 | protected $roles; |
||
128 | |||
129 | /** |
||
130 | * The permissions a player has |
||
131 | * @var Permission[] |
||
132 | */ |
||
133 | protected $permissions; |
||
134 | |||
135 | /** |
||
136 | * A section for admins to write notes about players |
||
137 | * @var string |
||
138 | */ |
||
139 | protected $admin_notes; |
||
140 | |||
141 | /** |
||
142 | * The ban of the player, or null if the player is not banned |
||
143 | * @var Ban|null |
||
144 | */ |
||
145 | protected $ban; |
||
146 | |||
147 | /** |
||
148 | * Cached results for match summaries |
||
149 | * |
||
150 | * @var array |
||
151 | */ |
||
152 | private $cachedMatchSummary; |
||
153 | |||
154 | /** |
||
155 | * The cached match count for a player |
||
156 | * |
||
157 | * @var int |
||
158 | */ |
||
159 | private $cachedMatchCount = null; |
||
160 | |||
161 | /** |
||
162 | * The Elo for this player that has been explicitly set for this player from a database query. This value will take |
||
163 | * precedence over having to build to an Elo season history. |
||
164 | * |
||
165 | * @var int |
||
166 | */ |
||
167 | private $elo; |
||
168 | private $eloSeason; |
||
169 | private $eloSeasonHistory; |
||
170 | |||
171 | private $matchActivity; |
||
172 | |||
173 | /** |
||
174 | * The name of the database table used for queries |
||
175 | */ |
||
176 | const TABLE = "players"; |
||
177 | 76 | ||
178 | /** |
||
179 | 76 | * The location where avatars will be stored |
|
180 | 76 | */ |
|
181 | 76 | const AVATAR_LOCATION = "/web/assets/imgs/avatars/players/"; |
|
182 | 76 | ||
183 | 76 | const EDIT_PERMISSION = Permission::EDIT_USER; |
|
184 | 76 | const SOFT_DELETE_PERMISSION = Permission::SOFT_DELETE_USER; |
|
185 | 76 | const HARD_DELETE_PERMISSION = Permission::HARD_DELETE_USER; |
|
186 | |||
187 | 76 | /** |
|
188 | * {@inheritdoc} |
||
189 | */ |
||
190 | 76 | protected function assignResult($player) |
|
208 | 76 | ||
209 | /** |
||
210 | 76 | * {@inheritdoc} |
|
211 | */ |
||
212 | 76 | protected function assignLazyResult($player) |
|
240 | 76 | ||
241 | /** |
||
242 | * Add a player a new role |
||
243 | * |
||
244 | * @param Role|int $role_id The role ID to add a player to |
||
245 | * |
||
246 | * @return bool Whether the operation was successful or not |
||
247 | */ |
||
248 | public function addRole($role_id) |
||
268 | 1 | ||
269 | /** |
||
270 | 1 | * Get the notes admins have left about a player |
|
271 | * @return string The notes |
||
272 | */ |
||
273 | public function getAdminNotes() |
||
279 | |||
280 | /** |
||
281 | * Get the player's BZID |
||
282 | * @return int The BZID |
||
283 | */ |
||
284 | public function getBZID() |
||
288 | |||
289 | /** |
||
290 | * Get the country a player belongs to |
||
291 | * |
||
292 | * @return Country The country belongs to |
||
293 | 30 | */ |
|
294 | public function getCountry() |
||
298 | |||
299 | 30 | /** |
|
300 | 29 | * Get the e-mail address of the player |
|
301 | * |
||
302 | * @return string The address |
||
303 | 30 | */ |
|
304 | public function getEmailAddress() |
||
310 | |||
311 | /** |
||
312 | * Build a key that we'll use for caching season Elo data in this model |
||
313 | 3 | * |
|
314 | * @param string|null $season The season to get |
||
315 | 3 | * @param int|null $year The year of the season to get |
|
316 | * |
||
317 | 3 | * @return string |
|
318 | */ |
||
319 | private function buildSeasonKey(&$season, &$year) |
||
331 | |||
332 | 3 | /** |
|
333 | * Build a key to use for caching season Elo data in this model from a timestamp |
||
334 | 3 | * |
|
335 | 3 | * @param DateTime $timestamp |
|
336 | * |
||
337 | * @return string |
||
338 | */ |
||
339 | 3 | private function buildSeasonKeyFromTimestamp(\DateTime $timestamp) |
|
345 | 3 | ||
346 | /** |
||
347 | 3 | * Remove all Elo data for this model for matches occurring after the given match (inclusive) |
|
348 | 1 | * |
|
349 | * This function will not remove the Elo data for this match from the database. Ideally, this function should only |
||
350 | * be called during Elo recalculation for this match. |
||
351 | * |
||
352 | * @internal |
||
353 | 2 | * |
|
354 | 2 | * @param Match $match |
|
355 | * |
||
356 | 2 | * @see Match::recalculateElo() |
|
357 | */ |
||
358 | public function invalidateMatchFromCache(Match $match) |
||
376 | |||
377 | /** |
||
378 | 30 | * Get the Elo changes for a player for a given season |
|
379 | * |
||
380 | * @param string|null $season The season to get |
||
381 | * @param int|null $year The year of the season to get |
||
382 | * |
||
383 | * @return array |
||
384 | */ |
||
385 | public function getEloSeasonHistory($season = null, $year = null) |
||
420 | 30 | ||
421 | 29 | /** |
|
422 | * Get the player's Elo for a season. |
||
423 | * |
||
424 | 30 | * With the default arguments, it will fetch the Elo for the current season. |
|
425 | * |
||
426 | 30 | * @param string|null $season The season we're looking for: winter, spring, summer, or fall |
|
427 | 30 | * @param int|null $year The year of the season we're looking for |
|
428 | 30 | * |
|
429 | * @return int The player's Elo |
||
430 | */ |
||
431 | public function getElo($season = null, $year = null) |
||
456 | 30 | ||
457 | 29 | /** |
|
458 | * Adjust the Elo of a player for the current season based on a Match |
||
459 | 29 | * |
|
460 | * **Warning:** If $match is null, the Elo for the player will be modified but the value will not be persisted to |
||
461 | 30 | * the database. |
|
462 | * |
||
463 | * @param int $adjust The value to be added to the current ELO (negative to subtract) |
||
464 | * @param Match|null $match The match where this Elo change took place |
||
465 | */ |
||
466 | public function adjustElo($adjust, Match $match = null) |
||
491 | |||
492 | /** |
||
493 | * Returns whether the player has verified their e-mail address |
||
494 | * |
||
495 | * @return bool `true` for verified players |
||
496 | */ |
||
497 | public function isVerified() |
||
503 | |||
504 | /** |
||
505 | * Returns the confirmation code for the player's e-mail address verification |
||
506 | 1 | * |
|
507 | * @return string The player's confirmation code |
||
508 | 1 | */ |
|
509 | public function getConfirmCode() |
||
515 | |||
516 | /** |
||
517 | * Returns what kind of events the player should be e-mailed about |
||
518 | * |
||
519 | * @return string The type of notifications |
||
520 | */ |
||
521 | public function getReceives() |
||
527 | |||
528 | /** |
||
529 | * Finds out whether the specified player wants and can receive an e-mail |
||
530 | * message |
||
531 | * |
||
532 | * @param string $type |
||
533 | * @return bool `true` if the player should be sent an e-mail |
||
534 | */ |
||
535 | public function canReceive($type) |
||
550 | |||
551 | /** |
||
552 | * Find out whether the specified confirmation code is correct |
||
553 | * |
||
554 | * This method protects against timing attacks |
||
555 | * |
||
556 | * @param string $code The confirmation code to check |
||
557 | * @return bool `true` for a correct e-mail verification code |
||
558 | */ |
||
559 | public function isCorrectConfirmCode($code) |
||
569 | |||
570 | /** |
||
571 | * Get the player's sanitized description |
||
572 | * @return string The description |
||
573 | */ |
||
574 | public function getDescription() |
||
580 | |||
581 | /** |
||
582 | * Get the joined date of the player |
||
583 | * @return TimeDate The joined date of the player |
||
584 | */ |
||
585 | public function getJoinedDate() |
||
591 | |||
592 | /** |
||
593 | * Get all of the known IPs used by the player |
||
594 | * |
||
595 | * @return string[][] An array containing IPs and hosts |
||
596 | */ |
||
597 | public function getKnownIPs() |
||
604 | |||
605 | /** |
||
606 | * Get the last login for a player |
||
607 | * @return TimeDate The date of the last login |
||
608 | */ |
||
609 | public function getLastLogin() |
||
615 | |||
616 | /** |
||
617 | * Get the last match |
||
618 | * @return Match |
||
619 | */ |
||
620 | 1 | public function getLastMatch() |
|
626 | |||
627 | /** |
||
628 | * Get all of the callsigns a player has used to log in to the website |
||
629 | * @return string[] An array containing all of the past callsigns recorded for a player |
||
630 | */ |
||
631 | public function getPastCallsigns() |
||
635 | |||
636 | /** |
||
637 | * Get the player's team |
||
638 | * @return Team The object representing the team |
||
639 | */ |
||
640 | public function getTeam() |
||
644 | 76 | ||
645 | /** |
||
646 | 76 | * Get the player's timezone PHP identifier (example: "Europe/Paris") |
|
647 | 76 | * @return string The timezone |
|
648 | */ |
||
649 | 76 | public function getTimezone() |
|
655 | |||
656 | /** |
||
657 | * Get the roles of the player |
||
658 | 2 | * @return Role[] |
|
659 | */ |
||
660 | 2 | public function getRoles() |
|
666 | 2 | ||
667 | /** |
||
668 | * Rebuild the list of permissions a user has been granted |
||
669 | */ |
||
670 | private function updateUserPermissions() |
||
679 | |||
680 | /** |
||
681 | * Check if a player has a specific permission |
||
682 | * |
||
683 | * @param string|null $permission The permission to check for |
||
684 | * |
||
685 | * @return bool Whether or not the player has the permission |
||
686 | */ |
||
687 | public function hasPermission($permission) |
||
697 | |||
698 | /** |
||
699 | * Check whether or not a player been in a match or has logged on in the specified amount of time to be considered |
||
700 | * active |
||
701 | * |
||
702 | * @return bool True if the player has been active |
||
703 | */ |
||
704 | public function hasBeenActive() |
||
720 | |||
721 | /** |
||
722 | 1 | * Check whether the callsign of the player is outdated |
|
723 | * |
||
724 | 1 | * Returns true if this player has probably changed their callsign, making |
|
725 | * the current username stored in the database obsolete |
||
726 | * |
||
727 | * @return bool Whether or not the player is disabled |
||
728 | */ |
||
729 | public function isOutdated() |
||
735 | |||
736 | /** |
||
737 | * Check if a player's account has been disabled |
||
738 | * |
||
739 | * @return bool Whether or not the player is disabled |
||
740 | 1 | */ |
|
741 | public function isDisabled() |
||
745 | |||
746 | 1 | /** |
|
747 | * Check if everyone can log in as this user on a test environment |
||
748 | * |
||
749 | * @return bool |
||
750 | */ |
||
751 | public function isTestUser() |
||
755 | |||
756 | /** |
||
757 | * Check if a player is teamless |
||
758 | * |
||
759 | * @return bool True if the player is teamless |
||
760 | */ |
||
761 | public function isTeamless() |
||
765 | |||
766 | 2 | /** |
|
767 | * Mark a player's account as banned |
||
768 | 2 | * |
|
769 | * @deprecated The players table shouldn't have any indicators of banned status, the Bans table is the authoritative source |
||
770 | */ |
||
771 | public function markAsBanned() |
||
775 | |||
776 | /** |
||
777 | * Mark a player's account as unbanned |
||
778 | * |
||
779 | * @deprecated The players table shouldn't have any indicators of banned status, the Bans table is the authoritative source |
||
780 | */ |
||
781 | public function markAsUnbanned() |
||
785 | |||
786 | /** |
||
787 | * Find out if a player is hard banned |
||
788 | * |
||
789 | * @return bool |
||
790 | */ |
||
791 | public function isBanned() |
||
797 | |||
798 | /** |
||
799 | * Get the ban of the player |
||
800 | * |
||
801 | * This method performs a load of all the lazy parameters of the Player |
||
802 | * |
||
803 | * @return Ban|null The current ban of the player, or null if the player is |
||
804 | * is not banned |
||
805 | */ |
||
806 | public function getBan() |
||
812 | |||
813 | /** |
||
814 | * Remove a player from a role |
||
815 | * |
||
816 | * @param int $role_id The role ID to add or remove |
||
817 | * |
||
818 | * @return bool Whether the operation was successful or not |
||
819 | */ |
||
820 | public function removeRole($role_id) |
||
827 | |||
828 | /** |
||
829 | * Set the player's email address and reset their verification status |
||
830 | * @param string $email The address |
||
831 | */ |
||
832 | public function setEmailAddress($email) |
||
846 | |||
847 | /** |
||
848 | * Set whether the player has verified their e-mail address |
||
849 | * |
||
850 | * @param bool $verified Whether the player is verified or not |
||
851 | * @return self |
||
852 | */ |
||
853 | public function setVerified($verified) |
||
863 | |||
864 | /** |
||
865 | * Generate a new random confirmation token for e-mail address verification |
||
866 | * |
||
867 | * @return self |
||
868 | */ |
||
869 | public function generateNewConfirmCode() |
||
876 | |||
877 | /** |
||
878 | * Set the confirmation token for e-mail address verification |
||
879 | * |
||
880 | * @param string $code The confirmation code |
||
881 | * @return self |
||
882 | 76 | */ |
|
883 | private function setConfirmCode($code) |
||
889 | |||
890 | /** |
||
891 | * Set what kind of events the player should be e-mailed about |
||
892 | * |
||
893 | * @param string $receives The type of notification |
||
894 | * @return self |
||
895 | */ |
||
896 | public function setReceives($receives) |
||
902 | |||
903 | /** |
||
904 | * Set whether the callsign of the player is outdated |
||
905 | * |
||
906 | * @param bool $outdated Whether the callsign is outdated |
||
907 | * @return self |
||
908 | */ |
||
909 | public function setOutdated($outdated) |
||
915 | |||
916 | /** |
||
917 | * Set the player's description |
||
918 | * @param string $description The description |
||
919 | */ |
||
920 | public function setDescription($description) |
||
924 | 29 | ||
925 | /** |
||
926 | * Set the player's timezone |
||
927 | * @param string $timezone The timezone |
||
928 | */ |
||
929 | public function setTimezone($timezone) |
||
933 | |||
934 | /** |
||
935 | * Set the player's team |
||
936 | * @param int $team The team's ID |
||
937 | */ |
||
938 | public function setTeam($team) |
||
942 | |||
943 | /** |
||
944 | * Set the match the player last participated in |
||
945 | * |
||
946 | * @param int $match The match's ID |
||
947 | */ |
||
948 | public function setLastMatch($match) |
||
952 | |||
953 | /** |
||
954 | * Set the player's status |
||
955 | * @param string $status The new status |
||
956 | */ |
||
957 | public function setStatus($status) |
||
961 | |||
962 | /** |
||
963 | * Set the player's admin notes |
||
964 | * @param string $admin_notes The new admin notes |
||
965 | * @return self |
||
966 | */ |
||
967 | 1 | public function setAdminNotes($admin_notes) |
|
971 | |||
972 | /** |
||
973 | * Set the player's country |
||
974 | * @param int $country The ID of the new country |
||
975 | * @return self |
||
976 | 1 | */ |
|
977 | public function setCountry($country) |
||
981 | |||
982 | /** |
||
983 | * Get the player's chosen theme preference |
||
984 | * |
||
985 | * @return string |
||
986 | */ |
||
987 | public function getTheme() |
||
993 | |||
994 | /** |
||
995 | * Set the site theme for the player |
||
996 | * |
||
997 | * If the chosen site theme is invalid, it'll be defaulted to the site default (the first theme defined) |
||
998 | * |
||
999 | * @param string $theme |
||
1000 | */ |
||
1001 | public function setTheme($theme) |
||
1011 | |||
1012 | /** |
||
1013 | * Whether or not this player has color blind assistance enabled. |
||
1014 | * |
||
1015 | * @return bool |
||
1016 | */ |
||
1017 | public function hasColorBlindAssist() |
||
1023 | |||
1024 | /** |
||
1025 | * Set a player's setting for color blind assistance. |
||
1026 | * |
||
1027 | * @param bool $enabled |
||
1028 | * |
||
1029 | * @return self |
||
1030 | */ |
||
1031 | public function setColorBlindAssist($enabled) |
||
1035 | |||
1036 | /** |
||
1037 | * Updates this player's last login |
||
1038 | */ |
||
1039 | public function updateLastLogin() |
||
1043 | |||
1044 | 76 | /** |
|
1045 | * Get the player's username |
||
1046 | 76 | * @return string The username |
|
1047 | */ |
||
1048 | 76 | public function getUsername() |
|
1052 | |||
1053 | /** |
||
1054 | * Get the player's username, safe for use in your HTML |
||
1055 | * @return string The username |
||
1056 | */ |
||
1057 | 76 | public function getEscapedUsername() |
|
1061 | |||
1062 | /** |
||
1063 | * Alias for Player::setUsername() |
||
1064 | * |
||
1065 | * @param string $username The new username |
||
1066 | * @return self |
||
1067 | */ |
||
1068 | public function setName($username) |
||
1072 | |||
1073 | /** |
||
1074 | * Mark all the unread messages of a player as read |
||
1075 | * |
||
1076 | * @return void |
||
1077 | */ |
||
1078 | public function markMessagesAsRead() |
||
1085 | |||
1086 | /** |
||
1087 | * Set the roles of a user |
||
1088 | * |
||
1089 | * @todo Is it worth making this faster? |
||
1090 | * @param Role[] $roles The new roles of the user |
||
1091 | * @return self |
||
1092 | */ |
||
1093 | public function setRoles($roles) |
||
1116 | |||
1117 | /** |
||
1118 | * Give or remove a role to/form a player |
||
1119 | * |
||
1120 | * @param int $role_id The role ID to add or remove |
||
1121 | * @param string $action Whether to "add" or "remove" a role for a player |
||
1122 | * |
||
1123 | * @return bool Whether the operation was successful or not |
||
1124 | */ |
||
1125 | private function modifyRole($role_id, $action) |
||
1143 | |||
1144 | /** |
||
1145 | * Given a player's BZID, get a player object |
||
1146 | * |
||
1147 | * @param int $bzid The player's BZID |
||
1148 | * @return Player |
||
1149 | */ |
||
1150 | public static function getFromBZID($bzid) |
||
1154 | |||
1155 | /** |
||
1156 | * Get a single player by their username |
||
1157 | * |
||
1158 | * @param string $username The username to look for |
||
1159 | * @return Player |
||
1160 | */ |
||
1161 | public static function getFromUsername($username) |
||
1167 | |||
1168 | /** |
||
1169 | * Get all the players in the database that have an active status |
||
1170 | * @return Player[] An array of player BZIDs |
||
1171 | */ |
||
1172 | public static function getPlayers() |
||
1178 | |||
1179 | /** |
||
1180 | * Show the number of notifications the user hasn't read yet |
||
1181 | * @return int |
||
1182 | */ |
||
1183 | public function countUnreadNotifications() |
||
1187 | |||
1188 | /** |
||
1189 | * Count the number of matches a player has participated in |
||
1190 | * @return int |
||
1191 | */ |
||
1192 | public function getMatchCount() |
||
1203 | |||
1204 | /** |
||
1205 | * Get the (victory/total matches) ratio of the player |
||
1206 | * @return float |
||
1207 | */ |
||
1208 | public function getMatchWinRatio() |
||
1223 | |||
1224 | /** |
||
1225 | * Get the (total caps made by team/total matches) ratio of the player |
||
1226 | * @return float |
||
1227 | */ |
||
1228 | public function getMatchAverageCaps() |
||
1252 | |||
1253 | 1 | /** |
|
1254 | * Get the match activity in matches per day for a player |
||
1255 | * |
||
1256 | * @return float |
||
1257 | */ |
||
1258 | public function getMatchActivity() |
||
1278 | 76 | ||
1279 | /** |
||
1280 | * Return an array of matches this player participated in per month. |
||
1281 | 76 | * |
|
1282 | * ``` |
||
1283 | * ['yyyy-mm'] = <number of matches> |
||
1284 | * ``` |
||
1285 | * |
||
1286 | * @param TimeDate|string $timePeriod |
||
1287 | * |
||
1288 | * @return int[] |
||
1289 | */ |
||
1290 | public function getMatchSummary($timePeriod = '1 year ago') |
||
1305 | |||
1306 | /** |
||
1307 | * Show the number of messages the user hasn't read yet |
||
1308 | * @return int |
||
1309 | */ |
||
1310 | public function countUnreadMessages() |
||
1316 | |||
1317 | /** |
||
1318 | * Get all of the members belonging to a team |
||
1319 | * @param int $teamID The ID of the team to fetch the members of |
||
1320 | * @return Player[] An array of Player objects of the team members |
||
1321 | */ |
||
1322 | public static function getTeamMembers($teamID) |
||
1328 | |||
1329 | 76 | /** |
|
1330 | * {@inheritdoc} |
||
1331 | 76 | */ |
|
1332 | 76 | public static function getActiveStatuses() |
|
1336 | 76 | ||
1337 | 76 | /** |
|
1338 | 76 | * {@inheritdoc} |
|
1339 | 76 | */ |
|
1340 | 76 | public static function getEagerColumns($prefix = null) |
|
1355 | |||
1356 | /** |
||
1357 | * {@inheritdoc} |
||
1358 | */ |
||
1359 | public static function getLazyColumns($prefix = null) |
||
1379 | |||
1380 | 76 | /** |
|
1381 | * Get a query builder for players |
||
1382 | 76 | * @return PlayerQueryBuilder |
|
1383 | */ |
||
1384 | 76 | public static function getQueryBuilder() |
|
1396 | |||
1397 | /** |
||
1398 | * Enter a new player to the database |
||
1399 | * @param int $bzid The player's bzid |
||
1400 | * @param string $username The player's username |
||
1401 | * @param int $team The player's team |
||
1402 | * @param string $status The player's status |
||
1403 | * @param int $role_id The player's role when they are first created |
||
1404 | * @param string $avatar The player's profile avatar |
||
1405 | * @param string $description The player's profile description |
||
1406 | * @param int $country The player's country |
||
1407 | * @param string $timezone The player's timezone |
||
1408 | * @param string|\TimeDate $joined The date the player joined |
||
1409 | * @param string|\TimeDate $last_login The timestamp of the player's last login |
||
1410 | * @return Player An object representing the player that was just entered |
||
1411 | 1 | */ |
|
1412 | 1 | public static function newPlayer($bzid, $username, $team = null, $status = "active", $role_id = self::PLAYER, $avatar = "", $description = "", $country = 1, $timezone = null, $joined = "now", $last_login = "now") |
|
1438 | |||
1439 | /** |
||
1440 | * Determine if a player exists in the database |
||
1441 | * @param int $bzid The player's bzid |
||
1442 | * @return bool Whether the player exists in the database |
||
1443 | */ |
||
1444 | public static function playerBZIDExists($bzid) |
||
1448 | |||
1449 | 1 | /** |
|
1450 | * Change a player's callsign and add it to the database if it does not |
||
1451 | * exist as a past callsign |
||
1452 | 1 | * |
|
1453 | * @param string $username The new username of the player |
||
1454 | * @return self |
||
1455 | */ |
||
1456 | public function setUsername($username) |
||
1487 | |||
1488 | /** |
||
1489 | * Alphabetical order function for use in usort (case-insensitive) |
||
1490 | * @return Closure The sort function |
||
1491 | */ |
||
1492 | public static function getAlphabeticalSort() |
||
1498 | |||
1499 | /** |
||
1500 | * {@inheritdoc} |
||
1501 | * @todo Add a constraint that does this automatically |
||
1502 | */ |
||
1503 | public function wipe() |
||
1509 | |||
1510 | /** |
||
1511 | * Find whether the player can delete a model |
||
1512 | * |
||
1513 | * @param PermissionModel $model The model that will be seen |
||
1514 | * @param bool $showDeleted Whether to show deleted models to admins |
||
1515 | * @return bool |
||
1516 | */ |
||
1517 | public function canSee($model, $showDeleted = false) |
||
1521 | |||
1522 | /** |
||
1523 | * Find whether the player can delete a model |
||
1524 | * |
||
1525 | * @param PermissionModel $model The model that will be deleted |
||
1526 | * @param bool $hard Whether to check for hard-delete perms, as opposed |
||
1527 | * to soft-delete ones |
||
1528 | * @return bool |
||
1529 | */ |
||
1530 | public function canDelete($model, $hard = false) |
||
1538 | |||
1539 | /** |
||
1540 | * Find whether the player can create a model |
||
1541 | * |
||
1542 | * @param string $modelName The PHP class identifier of the model type |
||
1543 | * @return bool |
||
1544 | */ |
||
1545 | public function canCreate($modelName) |
||
1549 | |||
1550 | /** |
||
1551 | * Find whether the player can edit a model |
||
1552 | * |
||
1553 | * @param PermissionModel $model The model which will be edited |
||
1554 | * @return bool |
||
1555 | */ |
||
1556 | public function canEdit($model) |
||
1560 | } |
||
1561 |
This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.
Both the
$myVar
assignment in line 1 and the$higher
assignment in line 2 are dead. The first because$myVar
is never used and the second because$higher
is always overwritten for every possible time line.