allejo /
bzion
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) |
||
| 386 | |||
| 387 | /** |
||
| 388 | * Get the Elo changes for a player for a given season |
||
| 389 | * |
||
| 390 | * @param string|null $season The season to get |
||
| 391 | * @param int|null $year The year of the season to get |
||
| 392 | 30 | * |
|
| 393 | * @return array |
||
| 394 | 30 | */ |
|
| 395 | 30 | public function getEloSeasonHistory($season = null, $year = null) |
|
| 430 | |||
| 431 | /** |
||
| 432 | * Get the player's Elo for a season. |
||
| 433 | 30 | * |
|
| 434 | * With the default arguments, it will fetch the Elo for the current season. |
||
| 435 | * |
||
| 436 | * @param string|null $season The season we're looking for: winter, spring, summer, or fall |
||
| 437 | * @param int|null $year The year of the season we're looking for |
||
| 438 | * |
||
| 439 | * @return int The player's Elo |
||
| 440 | */ |
||
| 441 | public function getElo($season = null, $year = null) |
||
| 466 | |||
| 467 | /** |
||
| 468 | * Adjust the Elo of a player for the current season based on a Match |
||
| 469 | * |
||
| 470 | * **Warning:** If $match is null, the Elo for the player will be modified but the value will not be persisted to |
||
| 471 | * the database. |
||
| 472 | * |
||
| 473 | * @param int $adjust The value to be added to the current ELO (negative to subtract) |
||
| 474 | * @param Match|null $match The match where this Elo change took place |
||
| 475 | */ |
||
| 476 | public function adjustElo($adjust, Match $match = null) |
||
| 493 | |||
| 494 | /** |
||
| 495 | * Returns whether the player has verified their e-mail address |
||
| 496 | * |
||
| 497 | * @return bool `true` for verified players |
||
| 498 | */ |
||
| 499 | public function isVerified() |
||
| 505 | |||
| 506 | 1 | /** |
|
| 507 | * Returns the confirmation code for the player's e-mail address verification |
||
| 508 | 1 | * |
|
| 509 | * @return string The player's confirmation code |
||
| 510 | 1 | */ |
|
| 511 | public function getConfirmCode() |
||
| 517 | |||
| 518 | /** |
||
| 519 | * Returns what kind of events the player should be e-mailed about |
||
| 520 | * |
||
| 521 | * @return string The type of notifications |
||
| 522 | */ |
||
| 523 | public function getReceives() |
||
| 529 | |||
| 530 | /** |
||
| 531 | * Finds out whether the specified player wants and can receive an e-mail |
||
| 532 | * message |
||
| 533 | * |
||
| 534 | * @param string $type |
||
| 535 | * @return bool `true` if the player should be sent an e-mail |
||
| 536 | */ |
||
| 537 | public function canReceive($type) |
||
| 552 | |||
| 553 | /** |
||
| 554 | * Find out whether the specified confirmation code is correct |
||
| 555 | * |
||
| 556 | * This method protects against timing attacks |
||
| 557 | * |
||
| 558 | * @param string $code The confirmation code to check |
||
| 559 | * @return bool `true` for a correct e-mail verification code |
||
| 560 | */ |
||
| 561 | public function isCorrectConfirmCode($code) |
||
| 571 | |||
| 572 | /** |
||
| 573 | * Get the player's sanitized description |
||
| 574 | * @return string The description |
||
| 575 | */ |
||
| 576 | public function getDescription() |
||
| 582 | |||
| 583 | /** |
||
| 584 | * Get the joined date of the player |
||
| 585 | * @return TimeDate The joined date of the player |
||
| 586 | */ |
||
| 587 | public function getJoinedDate() |
||
| 593 | |||
| 594 | /** |
||
| 595 | * Get all of the known IPs used by the player |
||
| 596 | * |
||
| 597 | * @return string[][] An array containing IPs and hosts |
||
| 598 | */ |
||
| 599 | public function getKnownIPs() |
||
| 606 | |||
| 607 | /** |
||
| 608 | * Get the last login for a player |
||
| 609 | * @return TimeDate The date of the last login |
||
| 610 | */ |
||
| 611 | 23 | public function getLastLogin() |
|
| 617 | |||
| 618 | /** |
||
| 619 | * Get the last match |
||
| 620 | 1 | * @return Match |
|
| 621 | */ |
||
| 622 | 1 | public function getLastMatch() |
|
| 628 | |||
| 629 | /** |
||
| 630 | * Get all of the callsigns a player has used to log in to the website |
||
| 631 | * @return string[] An array containing all of the past callsigns recorded for a player |
||
| 632 | */ |
||
| 633 | public function getPastCallsigns() |
||
| 637 | |||
| 638 | /** |
||
| 639 | * Get the player's team |
||
| 640 | * @return Team The object representing the team |
||
| 641 | 76 | */ |
|
| 642 | public function getTeam() |
||
| 646 | 76 | ||
| 647 | 76 | /** |
|
| 648 | * Get the player's timezone PHP identifier (example: "Europe/Paris") |
||
| 649 | 76 | * @return string The timezone |
|
| 650 | */ |
||
| 651 | public function getTimezone() |
||
| 657 | |||
| 658 | 2 | /** |
|
| 659 | * Get the roles of the player |
||
| 660 | 2 | * @return Role[] |
|
| 661 | 1 | */ |
|
| 662 | public function getRoles() |
||
| 668 | |||
| 669 | /** |
||
| 670 | * Rebuild the list of permissions a user has been granted |
||
| 671 | */ |
||
| 672 | private function updateUserPermissions() |
||
| 681 | |||
| 682 | /** |
||
| 683 | * Check if a player has a specific permission |
||
| 684 | * |
||
| 685 | * @param string|null $permission The permission to check for |
||
| 686 | * |
||
| 687 | * @return bool Whether or not the player has the permission |
||
| 688 | */ |
||
| 689 | public function hasPermission($permission) |
||
| 699 | |||
| 700 | /** |
||
| 701 | * Check whether or not a player been in a match or has logged on in the specified amount of time to be considered |
||
| 702 | * active |
||
| 703 | * |
||
| 704 | * @return bool True if the player has been active |
||
| 705 | */ |
||
| 706 | public function hasBeenActive() |
||
| 722 | 1 | ||
| 723 | /** |
||
| 724 | 1 | * Check whether the callsign of the player is outdated |
|
| 725 | * |
||
| 726 | * Returns true if this player has probably changed their callsign, making |
||
| 727 | * the current username stored in the database obsolete |
||
| 728 | * |
||
| 729 | * @return bool Whether or not the player is disabled |
||
| 730 | */ |
||
| 731 | public function isOutdated() |
||
| 737 | |||
| 738 | /** |
||
| 739 | * Check if a player's account has been disabled |
||
| 740 | 1 | * |
|
| 741 | * @return bool Whether or not the player is disabled |
||
| 742 | 1 | */ |
|
| 743 | public function isDisabled() |
||
| 747 | |||
| 748 | /** |
||
| 749 | * Check if everyone can log in as this user on a test environment |
||
| 750 | * |
||
| 751 | * @return bool |
||
| 752 | */ |
||
| 753 | public function isTestUser() |
||
| 757 | |||
| 758 | /** |
||
| 759 | * Check if a player is teamless |
||
| 760 | * |
||
| 761 | * @return bool True if the player is teamless |
||
| 762 | */ |
||
| 763 | public function isTeamless() |
||
| 767 | |||
| 768 | 2 | /** |
|
| 769 | * Mark a player's account as banned |
||
| 770 | * |
||
| 771 | * @deprecated The players table shouldn't have any indicators of banned status, the Bans table is the authoritative source |
||
| 772 | */ |
||
| 773 | public function markAsBanned() |
||
| 777 | |||
| 778 | /** |
||
| 779 | * Mark a player's account as unbanned |
||
| 780 | * |
||
| 781 | * @deprecated The players table shouldn't have any indicators of banned status, the Bans table is the authoritative source |
||
| 782 | */ |
||
| 783 | public function markAsUnbanned() |
||
| 787 | |||
| 788 | /** |
||
| 789 | * Find out if a player is hard banned |
||
| 790 | * |
||
| 791 | * @return bool |
||
| 792 | */ |
||
| 793 | public function isBanned() |
||
| 799 | |||
| 800 | /** |
||
| 801 | * Get the ban of the player |
||
| 802 | * |
||
| 803 | * This method performs a load of all the lazy parameters of the Player |
||
| 804 | * |
||
| 805 | * @return Ban|null The current ban of the player, or null if the player is |
||
| 806 | * is not banned |
||
| 807 | */ |
||
| 808 | public function getBan() |
||
| 814 | |||
| 815 | /** |
||
| 816 | * Remove a player from a role |
||
| 817 | * |
||
| 818 | * @param int $role_id The role ID to add or remove |
||
| 819 | * |
||
| 820 | * @return bool Whether the operation was successful or not |
||
| 821 | */ |
||
| 822 | public function removeRole($role_id) |
||
| 829 | |||
| 830 | /** |
||
| 831 | * Set the player's email address and reset their verification status |
||
| 832 | * @param string $email The address |
||
| 833 | */ |
||
| 834 | public function setEmailAddress($email) |
||
| 848 | |||
| 849 | /** |
||
| 850 | * Set whether the player has verified their e-mail address |
||
| 851 | * |
||
| 852 | * @param bool $verified Whether the player is verified or not |
||
| 853 | * @return self |
||
| 854 | */ |
||
| 855 | public function setVerified($verified) |
||
| 865 | |||
| 866 | /** |
||
| 867 | * Generate a new random confirmation token for e-mail address verification |
||
| 868 | * |
||
| 869 | * @return self |
||
| 870 | */ |
||
| 871 | public function generateNewConfirmCode() |
||
| 878 | |||
| 879 | /** |
||
| 880 | * Set the confirmation token for e-mail address verification |
||
| 881 | * |
||
| 882 | 76 | * @param string $code The confirmation code |
|
| 883 | * @return self |
||
| 884 | 76 | */ |
|
| 885 | private function setConfirmCode($code) |
||
| 891 | |||
| 892 | /** |
||
| 893 | * Set what kind of events the player should be e-mailed about |
||
| 894 | * |
||
| 895 | * @param string $receives The type of notification |
||
| 896 | * @return self |
||
| 897 | */ |
||
| 898 | public function setReceives($receives) |
||
| 904 | |||
| 905 | /** |
||
| 906 | * Set whether the callsign of the player is outdated |
||
| 907 | * |
||
| 908 | * @param bool $outdated Whether the callsign is outdated |
||
| 909 | * @return self |
||
| 910 | */ |
||
| 911 | 55 | public function setOutdated($outdated) |
|
| 917 | |||
| 918 | /** |
||
| 919 | * Set the player's description |
||
| 920 | * @param string $description The description |
||
| 921 | 29 | */ |
|
| 922 | public function setDescription($description) |
||
| 926 | |||
| 927 | /** |
||
| 928 | * Set the player's timezone |
||
| 929 | * @param string $timezone The timezone |
||
| 930 | */ |
||
| 931 | public function setTimezone($timezone) |
||
| 935 | |||
| 936 | /** |
||
| 937 | * Set the player's team |
||
| 938 | * @param int $team The team's ID |
||
| 939 | */ |
||
| 940 | public function setTeam($team) |
||
| 944 | |||
| 945 | /** |
||
| 946 | * Set the match the player last participated in |
||
| 947 | * |
||
| 948 | * @param int $match The match's ID |
||
| 949 | */ |
||
| 950 | public function setLastMatch($match) |
||
| 954 | |||
| 955 | /** |
||
| 956 | * Set the player's status |
||
| 957 | * @param string $status The new status |
||
| 958 | */ |
||
| 959 | public function setStatus($status) |
||
| 963 | |||
| 964 | /** |
||
| 965 | * Set the player's admin notes |
||
| 966 | * @param string $admin_notes The new admin notes |
||
| 967 | 1 | * @return self |
|
| 968 | */ |
||
| 969 | 1 | public function setAdminNotes($admin_notes) |
|
| 973 | |||
| 974 | /** |
||
| 975 | * Set the player's country |
||
| 976 | 1 | * @param int $country The ID of the new country |
|
| 977 | * @return self |
||
| 978 | 1 | */ |
|
| 979 | public function setCountry($country) |
||
| 983 | |||
| 984 | /** |
||
| 985 | * Get the player's chosen theme preference |
||
| 986 | * |
||
| 987 | * @return string |
||
| 988 | */ |
||
| 989 | public function getTheme() |
||
| 995 | |||
| 996 | /** |
||
| 997 | * Set the site theme for the player |
||
| 998 | * |
||
| 999 | * If the chosen site theme is invalid, it'll be defaulted to the site default (the first theme defined) |
||
| 1000 | * |
||
| 1001 | * @param string $theme |
||
| 1002 | */ |
||
| 1003 | public function setTheme($theme) |
||
| 1013 | |||
| 1014 | /** |
||
| 1015 | * Whether or not this player has color blind assistance enabled. |
||
| 1016 | * |
||
| 1017 | * @return bool |
||
| 1018 | */ |
||
| 1019 | public function hasColorBlindAssist() |
||
| 1025 | |||
| 1026 | /** |
||
| 1027 | * Set a player's setting for color blind assistance. |
||
| 1028 | * |
||
| 1029 | * @param bool $enabled |
||
| 1030 | * |
||
| 1031 | * @return self |
||
| 1032 | */ |
||
| 1033 | public function setColorBlindAssist($enabled) |
||
| 1037 | |||
| 1038 | /** |
||
| 1039 | * Updates this player's last login |
||
| 1040 | */ |
||
| 1041 | public function updateLastLogin() |
||
| 1045 | |||
| 1046 | 76 | /** |
|
| 1047 | * Get the player's username |
||
| 1048 | 76 | * @return string The username |
|
| 1049 | 76 | */ |
|
| 1050 | 76 | public function getUsername() |
|
| 1054 | |||
| 1055 | /** |
||
| 1056 | * Get the player's username, safe for use in your HTML |
||
| 1057 | 76 | * @return string The username |
|
| 1058 | */ |
||
| 1059 | public function getEscapedUsername() |
||
| 1063 | |||
| 1064 | /** |
||
| 1065 | * Alias for Player::setUsername() |
||
| 1066 | * |
||
| 1067 | * @param string $username The new username |
||
| 1068 | * @return self |
||
| 1069 | 23 | */ |
|
| 1070 | public function setName($username) |
||
| 1074 | |||
| 1075 | /** |
||
| 1076 | * Mark all the unread messages of a player as read |
||
| 1077 | * |
||
| 1078 | * @return void |
||
| 1079 | */ |
||
| 1080 | 1 | public function markMessagesAsRead() |
|
| 1087 | |||
| 1088 | /** |
||
| 1089 | * Set the roles of a user |
||
| 1090 | * |
||
| 1091 | * @todo Is it worth making this faster? |
||
| 1092 | * @param Role[] $roles The new roles of the user |
||
| 1093 | * @return self |
||
| 1094 | */ |
||
| 1095 | public function setRoles($roles) |
||
| 1118 | |||
| 1119 | /** |
||
| 1120 | * Give or remove a role to/form a player |
||
| 1121 | * |
||
| 1122 | * @param int $role_id The role ID to add or remove |
||
| 1123 | * @param string $action Whether to "add" or "remove" a role for a player |
||
| 1124 | * |
||
| 1125 | * @return bool Whether the operation was successful or not |
||
| 1126 | */ |
||
| 1127 | private function modifyRole($role_id, $action) |
||
| 1145 | |||
| 1146 | /** |
||
| 1147 | * Given a player's BZID, get a player object |
||
| 1148 | * |
||
| 1149 | * @param int $bzid The player's BZID |
||
| 1150 | * @return Player |
||
| 1151 | */ |
||
| 1152 | public static function getFromBZID($bzid) |
||
| 1156 | |||
| 1157 | /** |
||
| 1158 | * Get a single player by their username |
||
| 1159 | * |
||
| 1160 | * @param string $username The username to look for |
||
| 1161 | * @return Player |
||
| 1162 | */ |
||
| 1163 | public static function getFromUsername($username) |
||
| 1169 | |||
| 1170 | /** |
||
| 1171 | * Get all the players in the database that have an active status |
||
| 1172 | * @return Player[] An array of player BZIDs |
||
| 1173 | */ |
||
| 1174 | public static function getPlayers() |
||
| 1180 | |||
| 1181 | /** |
||
| 1182 | * Show the number of notifications the user hasn't read yet |
||
| 1183 | * @return int |
||
| 1184 | */ |
||
| 1185 | public function countUnreadNotifications() |
||
| 1189 | |||
| 1190 | /** |
||
| 1191 | * Count the number of matches a player has participated in |
||
| 1192 | * @return int |
||
| 1193 | */ |
||
| 1194 | public function getMatchCount() |
||
| 1205 | |||
| 1206 | /** |
||
| 1207 | * Get the (victory/total matches) ratio of the player |
||
| 1208 | * @return float |
||
| 1209 | */ |
||
| 1210 | public function getMatchWinRatio() |
||
| 1225 | |||
| 1226 | /** |
||
| 1227 | * Get the (total caps made by team/total matches) ratio of the player |
||
| 1228 | * @return float |
||
| 1229 | 1 | */ |
|
| 1230 | public function getMatchAverageCaps() |
||
| 1254 | |||
| 1255 | /** |
||
| 1256 | * Get the match activity in matches per day for a player |
||
| 1257 | * |
||
| 1258 | * @return float |
||
| 1259 | 76 | */ |
|
| 1260 | public function getMatchActivity() |
||
| 1280 | |||
| 1281 | 76 | /** |
|
| 1282 | * Return an array of matches this player participated in per month. |
||
| 1283 | * |
||
| 1284 | * ``` |
||
| 1285 | * ['yyyy-mm'] = <number of matches> |
||
| 1286 | * ``` |
||
| 1287 | * |
||
| 1288 | * @param TimeDate|string $timePeriod |
||
| 1289 | * |
||
| 1290 | * @return int[] |
||
| 1291 | */ |
||
| 1292 | public function getMatchSummary($timePeriod = '1 year ago') |
||
| 1307 | |||
| 1308 | /** |
||
| 1309 | * Show the number of messages the user hasn't read yet |
||
| 1310 | * @return int |
||
| 1311 | */ |
||
| 1312 | public function countUnreadMessages() |
||
| 1318 | |||
| 1319 | /** |
||
| 1320 | * Get all of the members belonging to a team |
||
| 1321 | * @param int $teamID The ID of the team to fetch the members of |
||
| 1322 | * @return Player[] An array of Player objects of the team members |
||
| 1323 | */ |
||
| 1324 | public static function getTeamMembers($teamID) |
||
| 1330 | |||
| 1331 | 76 | /** |
|
| 1332 | 76 | * {@inheritdoc} |
|
| 1333 | 76 | */ |
|
| 1334 | public static function getActiveStatuses() |
||
| 1338 | 76 | ||
| 1339 | 76 | /** |
|
| 1340 | 76 | * {@inheritdoc} |
|
| 1341 | 76 | */ |
|
| 1342 | 76 | public static function getEagerColumns($prefix = null) |
|
| 1357 | |||
| 1358 | /** |
||
| 1359 | * {@inheritdoc} |
||
| 1360 | */ |
||
| 1361 | public static function getLazyColumns($prefix = null) |
||
| 1381 | |||
| 1382 | 76 | /** |
|
| 1383 | * Get a query builder for players |
||
| 1384 | 76 | * @return PlayerQueryBuilder |
|
| 1385 | */ |
||
| 1386 | public static function getQueryBuilder() |
||
| 1398 | |||
| 1399 | /** |
||
| 1400 | * Enter a new player to the database |
||
| 1401 | * @param int $bzid The player's bzid |
||
| 1402 | * @param string $username The player's username |
||
| 1403 | * @param int $team The player's team |
||
| 1404 | * @param string $status The player's status |
||
| 1405 | * @param int $role_id The player's role when they are first created |
||
| 1406 | * @param string $avatar The player's profile avatar |
||
| 1407 | * @param string $description The player's profile description |
||
| 1408 | * @param int $country The player's country |
||
| 1409 | * @param string $timezone The player's timezone |
||
| 1410 | * @param string|\TimeDate $joined The date the player joined |
||
| 1411 | 1 | * @param string|\TimeDate $last_login The timestamp of the player's last login |
|
| 1412 | 1 | * @return Player An object representing the player that was just entered |
|
| 1413 | 1 | */ |
|
| 1414 | 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") |
||
| 1440 | |||
| 1441 | /** |
||
| 1442 | * Determine if a player exists in the database |
||
| 1443 | * @param int $bzid The player's bzid |
||
| 1444 | * @return bool Whether the player exists in the database |
||
| 1445 | */ |
||
| 1446 | public static function playerBZIDExists($bzid) |
||
| 1450 | |||
| 1451 | /** |
||
| 1452 | 1 | * Change a player's callsign and add it to the database if it does not |
|
| 1453 | * exist as a past callsign |
||
| 1454 | * |
||
| 1455 | * @param string $username The new username of the player |
||
| 1456 | * @return self |
||
| 1457 | */ |
||
| 1458 | public function setUsername($username) |
||
| 1489 | |||
| 1490 | /** |
||
| 1491 | * Alphabetical order function for use in usort (case-insensitive) |
||
| 1492 | * @return Closure The sort function |
||
| 1493 | */ |
||
| 1494 | public static function getAlphabeticalSort() |
||
| 1500 | |||
| 1501 | /** |
||
| 1502 | * {@inheritdoc} |
||
| 1503 | * @todo Add a constraint that does this automatically |
||
| 1504 | */ |
||
| 1505 | public function wipe() |
||
| 1511 | |||
| 1512 | /** |
||
| 1513 | * Find whether the player can delete a model |
||
| 1514 | * |
||
| 1515 | * @param PermissionModel $model The model that will be seen |
||
| 1516 | * @param bool $showDeleted Whether to show deleted models to admins |
||
| 1517 | * @return bool |
||
| 1518 | */ |
||
| 1519 | public function canSee($model, $showDeleted = false) |
||
| 1523 | |||
| 1524 | /** |
||
| 1525 | * Find whether the player can delete a model |
||
| 1526 | * |
||
| 1527 | * @param PermissionModel $model The model that will be deleted |
||
| 1528 | * @param bool $hard Whether to check for hard-delete perms, as opposed |
||
| 1529 | * to soft-delete ones |
||
| 1530 | * @return bool |
||
| 1531 | */ |
||
| 1532 | public function canDelete($model, $hard = false) |
||
| 1540 | |||
| 1541 | /** |
||
| 1542 | * Find whether the player can create a model |
||
| 1543 | * |
||
| 1544 | * @param string $modelName The PHP class identifier of the model type |
||
| 1545 | * @return bool |
||
| 1546 | */ |
||
| 1547 | public function canCreate($modelName) |
||
| 1551 | |||
| 1552 | /** |
||
| 1553 | * Find whether the player can edit a model |
||
| 1554 | * |
||
| 1555 | * @param PermissionModel $model The model which will be edited |
||
| 1556 | * @return bool |
||
| 1557 | */ |
||
| 1558 | public function canEdit($model) |
||
| 1562 | } |
||
| 1563 |
Loading history...
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..