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 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 |
||
| 16 | class Player extends AvatarModel implements NamedModel |
||
| 17 | { |
||
| 18 | /** |
||
| 19 | * These are built-in roles that cannot be deleted via the web interface so we will be storing these values as |
||
| 20 | * constant variables. Hopefully, a user won't be silly enough to delete them manually from the database. |
||
| 21 | * |
||
| 22 | * @TODO Deprecate these and use the Role constants |
||
| 23 | */ |
||
| 24 | const DEVELOPER = Role::DEVELOPER; |
||
| 25 | const ADMIN = Role::ADMINISTRATOR; |
||
| 26 | const COP = Role::COP; |
||
| 27 | const REFEREE = Role::REFEREE; |
||
| 28 | const S_ADMIN = Role::SYSADMIN; |
||
| 29 | const PLAYER = Role::PLAYER; |
||
| 30 | const PLAYER_NO_PM = Role::PLAYER_NO_PM; |
||
| 31 | |||
| 32 | /** |
||
| 33 | * The bzid of the player |
||
| 34 | * @var int |
||
| 35 | */ |
||
| 36 | protected $bzid; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * The id of the player's team |
||
| 40 | * @var int |
||
| 41 | */ |
||
| 42 | protected $team; |
||
| 43 | |||
| 44 | /** |
||
| 45 | * The player's status |
||
| 46 | * @var string |
||
| 47 | */ |
||
| 48 | protected $status; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * The player's e-mail address |
||
| 52 | * @var string |
||
| 53 | */ |
||
| 54 | protected $email; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * Whether the player has verified their e-mail address |
||
| 58 | * @var bool |
||
| 59 | */ |
||
| 60 | protected $verified; |
||
| 61 | |||
| 62 | /** |
||
| 63 | * What kind of events the player should be e-mailed about |
||
| 64 | * @var string |
||
| 65 | */ |
||
| 66 | protected $receives; |
||
| 67 | |||
| 68 | /** |
||
| 69 | * A confirmation code for the player's e-mail address verification |
||
| 70 | * @var string |
||
| 71 | */ |
||
| 72 | protected $confirmCode; |
||
| 73 | |||
| 74 | /** |
||
| 75 | * Whether the callsign of the player is outdated |
||
| 76 | * @var bool |
||
| 77 | */ |
||
| 78 | protected $outdated; |
||
| 79 | |||
| 80 | /** |
||
| 81 | * The player's profile description |
||
| 82 | * @var string |
||
| 83 | */ |
||
| 84 | protected $description; |
||
| 85 | |||
| 86 | /** |
||
| 87 | * The id of the player's country |
||
| 88 | * @var int |
||
| 89 | */ |
||
| 90 | protected $country; |
||
| 91 | |||
| 92 | /** |
||
| 93 | * The player's timezone PHP identifier, e.g. "Europe/Paris" |
||
| 94 | * @var string |
||
| 95 | */ |
||
| 96 | protected $timezone; |
||
| 97 | |||
| 98 | /** |
||
| 99 | * The date the player joined the site |
||
| 100 | * @var TimeDate |
||
| 101 | */ |
||
| 102 | protected $joined; |
||
| 103 | |||
| 104 | /** |
||
| 105 | * The date of the player's last login |
||
| 106 | * @var TimeDate |
||
| 107 | */ |
||
| 108 | protected $last_login; |
||
| 109 | |||
| 110 | /** |
||
| 111 | * The roles a player belongs to |
||
| 112 | * @var Role[] |
||
| 113 | */ |
||
| 114 | protected $roles; |
||
| 115 | |||
| 116 | /** |
||
| 117 | * The permissions a player has |
||
| 118 | * @var Permission[] |
||
| 119 | */ |
||
| 120 | protected $permissions; |
||
| 121 | |||
| 122 | /** |
||
| 123 | * A section for admins to write notes about players |
||
| 124 | * @var string |
||
| 125 | */ |
||
| 126 | protected $admin_notes; |
||
| 127 | |||
| 128 | /** |
||
| 129 | * The ban of the player, or null if the player is not banned |
||
| 130 | * @var Ban|null |
||
| 131 | */ |
||
| 132 | protected $ban; |
||
| 133 | |||
| 134 | /** |
||
| 135 | * The cached match count for a player |
||
| 136 | * |
||
| 137 | * @var int |
||
| 138 | */ |
||
| 139 | private $cachedMatchCount = null; |
||
| 140 | |||
| 141 | /** |
||
| 142 | * The name of the database table used for queries |
||
| 143 | */ |
||
| 144 | const TABLE = "players"; |
||
| 145 | |||
| 146 | /** |
||
| 147 | * The location where avatars will be stored |
||
| 148 | */ |
||
| 149 | const AVATAR_LOCATION = "/web/assets/imgs/avatars/players/"; |
||
| 150 | |||
| 151 | 39 | const EDIT_PERMISSION = Permission::EDIT_USER; |
|
| 152 | const SOFT_DELETE_PERMISSION = Permission::SOFT_DELETE_USER; |
||
| 153 | 39 | const HARD_DELETE_PERMISSION = Permission::HARD_DELETE_USER; |
|
| 154 | 39 | ||
| 155 | 39 | /** |
|
| 156 | 39 | * {@inheritdoc} |
|
| 157 | 39 | */ |
|
| 158 | 39 | protected function assignResult($player) |
|
| 168 | 39 | ||
| 169 | 39 | /** |
|
| 170 | 39 | * {@inheritdoc} |
|
| 171 | 39 | */ |
|
| 172 | 39 | protected function assignLazyResult($player) |
|
| 188 | |||
| 189 | 39 | /** |
|
| 190 | * Add a player a new role |
||
| 191 | 39 | * |
|
| 192 | 1 | * @param Role|int $role_id The role ID to add a player to |
|
| 193 | * |
||
| 194 | * @return bool Whether the operation was successful or not |
||
| 195 | 39 | */ |
|
| 196 | public function addRole($role_id) |
||
| 216 | |||
| 217 | /** |
||
| 218 | * Get the notes admins have left about a player |
||
| 219 | * @return string The notes |
||
| 220 | */ |
||
| 221 | public function getAdminNotes() |
||
| 227 | |||
| 228 | /** |
||
| 229 | * Get the player's BZID |
||
| 230 | * @return int The BZID |
||
| 231 | */ |
||
| 232 | public function getBZID() |
||
| 236 | |||
| 237 | 1 | /** |
|
| 238 | * Get the country a player belongs to |
||
| 239 | * |
||
| 240 | * @return Country The country belongs to |
||
| 241 | */ |
||
| 242 | public function getCountry() |
||
| 246 | |||
| 247 | /** |
||
| 248 | * Get the e-mail address of the player |
||
| 249 | * |
||
| 250 | * @return string The address |
||
| 251 | */ |
||
| 252 | public function getEmailAddress() |
||
| 258 | |||
| 259 | /** |
||
| 260 | * Returns whether the player has verified their e-mail address |
||
| 261 | * |
||
| 262 | * @return bool `true` for verified players |
||
| 263 | */ |
||
| 264 | public function isVerified() |
||
| 270 | |||
| 271 | /** |
||
| 272 | * Returns the confirmation code for the player's e-mail address verification |
||
| 273 | * |
||
| 274 | * @return string The player's confirmation code |
||
| 275 | */ |
||
| 276 | public function getConfirmCode() |
||
| 282 | |||
| 283 | /** |
||
| 284 | * Returns what kind of events the player should be e-mailed about |
||
| 285 | * |
||
| 286 | * @return string The type of notifications |
||
| 287 | */ |
||
| 288 | public function getReceives() |
||
| 294 | |||
| 295 | 1 | /** |
|
| 296 | * Finds out whether the specified player wants and can receive an e-mail |
||
| 297 | 1 | * message |
|
| 298 | * |
||
| 299 | 1 | * @param string $type |
|
| 300 | * @return bool `true` if the player should be sent an e-mail |
||
| 301 | 1 | */ |
|
| 302 | public function canReceive($type) |
||
| 317 | |||
| 318 | /** |
||
| 319 | * Find out whether the specified confirmation code is correct |
||
| 320 | * |
||
| 321 | * This method protects against timing attacks |
||
| 322 | * |
||
| 323 | * @param string $code The confirmation code to check |
||
| 324 | * @return bool `true` for a correct e-mail verification code |
||
| 325 | */ |
||
| 326 | public function isCorrectConfirmCode($code) |
||
| 336 | |||
| 337 | /** |
||
| 338 | * Get the player's sanitized description |
||
| 339 | * @return string The description |
||
| 340 | */ |
||
| 341 | public function getDescription() |
||
| 347 | |||
| 348 | /** |
||
| 349 | * Get the joined date of the player |
||
| 350 | * @return TimeDate The joined date of the player |
||
| 351 | */ |
||
| 352 | public function getJoinedDate() |
||
| 358 | |||
| 359 | /** |
||
| 360 | * Get all of the known IPs used by the player |
||
| 361 | * |
||
| 362 | * @return string[][] An array containing IPs and hosts |
||
| 363 | */ |
||
| 364 | public function getKnownIPs() |
||
| 368 | |||
| 369 | /** |
||
| 370 | * Get the last login for a player |
||
| 371 | * @return TimeDate The date of the last login |
||
| 372 | */ |
||
| 373 | public function getLastLogin() |
||
| 379 | |||
| 380 | /** |
||
| 381 | * Get all of the callsigns a player has used to log in to the website |
||
| 382 | * @return string[] An array containing all of the past callsigns recorded for a player |
||
| 383 | */ |
||
| 384 | public function getPastCallsigns() |
||
| 388 | 2 | ||
| 389 | /** |
||
| 390 | * Get the player's team |
||
| 391 | * @return Team The object representing the team |
||
| 392 | */ |
||
| 393 | public function getTeam() |
||
| 397 | 1 | ||
| 398 | /** |
||
| 399 | 1 | * Get the player's timezone PHP identifier (example: "Europe/Paris") |
|
| 400 | * @return string The timezone |
||
| 401 | */ |
||
| 402 | public function getTimezone() |
||
| 408 | |||
| 409 | /** |
||
| 410 | * Get the roles of the player |
||
| 411 | * @return Role[] |
||
| 412 | */ |
||
| 413 | public function getRoles() |
||
| 419 | 39 | ||
| 420 | /** |
||
| 421 | 39 | * Rebuild the list of permissions a user has been granted |
|
| 422 | 39 | */ |
|
| 423 | private function updateUserPermissions() |
||
| 432 | |||
| 433 | 2 | /** |
|
| 434 | * Check if a player has a specific permission |
||
| 435 | 2 | * |
|
| 436 | 1 | * @param string|null $permission The permission to check for |
|
| 437 | * |
||
| 438 | * @return bool Whether or not the player has the permission |
||
| 439 | 2 | */ |
|
| 440 | public function hasPermission($permission) |
||
| 450 | |||
| 451 | /** |
||
| 452 | * Check whether the callsign of the player is outdated |
||
| 453 | * |
||
| 454 | * Returns true if this player has probably changed their callsign, making |
||
| 455 | * the current username stored in the database obsolete |
||
| 456 | * |
||
| 457 | * @return bool Whether or not the player is disabled |
||
| 458 | */ |
||
| 459 | public function isOutdated() |
||
| 465 | |||
| 466 | /** |
||
| 467 | * Check if a player's account has been disabled |
||
| 468 | * |
||
| 469 | * @return bool Whether or not the player is disabled |
||
| 470 | */ |
||
| 471 | public function isDisabled() |
||
| 475 | |||
| 476 | 1 | /** |
|
| 477 | * Check if everyone can log in as this user on a test environment |
||
| 478 | * |
||
| 479 | * @return bool |
||
| 480 | */ |
||
| 481 | public function isTestUser() |
||
| 485 | |||
| 486 | 18 | /** |
|
| 487 | * Check if a player is teamless |
||
| 488 | * |
||
| 489 | * @return bool True if the player is teamless |
||
| 490 | */ |
||
| 491 | public function isTeamless() |
||
| 495 | |||
| 496 | /** |
||
| 497 | * Mark a player's account as banned |
||
| 498 | 1 | */ |
|
| 499 | public function markAsBanned() |
||
| 507 | |||
| 508 | /** |
||
| 509 | * Mark a player's account as unbanned |
||
| 510 | */ |
||
| 511 | public function markAsUnbanned() |
||
| 519 | |||
| 520 | 2 | /** |
|
| 521 | * Find out if a player is banned |
||
| 522 | * |
||
| 523 | * @return bool |
||
| 524 | */ |
||
| 525 | public function isBanned() |
||
| 529 | |||
| 530 | /** |
||
| 531 | * Get the ban of the player |
||
| 532 | * |
||
| 533 | * This method performs a load of all the lazy parameters of the Player |
||
| 534 | * |
||
| 535 | * @return Ban|null The current ban of the player, or null if the player is |
||
| 536 | * is not banned |
||
| 537 | */ |
||
| 538 | public function getBan() |
||
| 544 | |||
| 545 | /** |
||
| 546 | * Remove a player from a role |
||
| 547 | * |
||
| 548 | * @param int $role_id The role ID to add or remove |
||
| 549 | * |
||
| 550 | * @return bool Whether the operation was successful or not |
||
| 551 | */ |
||
| 552 | public function removeRole($role_id) |
||
| 559 | |||
| 560 | /** |
||
| 561 | * Set the player's email address and reset their verification status |
||
| 562 | * @param string $email The address |
||
| 563 | */ |
||
| 564 | public function setEmailAddress($email) |
||
| 578 | |||
| 579 | /** |
||
| 580 | * Set whether the player has verified their e-mail address |
||
| 581 | * |
||
| 582 | * @param bool $verified Whether the player is verified or not |
||
| 583 | * @return self |
||
| 584 | */ |
||
| 585 | public function setVerified($verified) |
||
| 595 | |||
| 596 | /** |
||
| 597 | * Generate a new random confirmation token for e-mail address verification |
||
| 598 | * |
||
| 599 | * @return self |
||
| 600 | */ |
||
| 601 | public function generateNewConfirmCode() |
||
| 608 | |||
| 609 | /** |
||
| 610 | * Set the confirmation token for e-mail address verification |
||
| 611 | * |
||
| 612 | * @param string $code The confirmation code |
||
| 613 | * @return self |
||
| 614 | */ |
||
| 615 | private function setConfirmCode($code) |
||
| 621 | |||
| 622 | /** |
||
| 623 | * Set what kind of events the player should be e-mailed about |
||
| 624 | * |
||
| 625 | * @param string $receives The type of notification |
||
| 626 | * @return self |
||
| 627 | */ |
||
| 628 | public function setReceives($receives) |
||
| 634 | |||
| 635 | 39 | /** |
|
| 636 | * Set whether the callsign of the player is outdated |
||
| 637 | 39 | * |
|
| 638 | * @param bool $outdated Whether the callsign is outdated |
||
| 639 | 39 | * @return self |
|
| 640 | */ |
||
| 641 | public function setOutdated($outdated) |
||
| 647 | |||
| 648 | /** |
||
| 649 | * Set the player's description |
||
| 650 | * @param string $description The description |
||
| 651 | */ |
||
| 652 | public function setDescription($description) |
||
| 656 | |||
| 657 | /** |
||
| 658 | * Set the player's timezone |
||
| 659 | * @param string $timezone The timezone |
||
| 660 | */ |
||
| 661 | public function setTimezone($timezone) |
||
| 665 | |||
| 666 | 18 | /** |
|
| 667 | * Set the player's team |
||
| 668 | 18 | * @param int $team The team's ID |
|
| 669 | 18 | */ |
|
| 670 | 18 | public function setTeam($team) |
|
| 674 | |||
| 675 | /** |
||
| 676 | * Set the player's status |
||
| 677 | * @param string $status The new status |
||
| 678 | */ |
||
| 679 | public function setStatus($status) |
||
| 683 | |||
| 684 | /** |
||
| 685 | * Set the player's admin notes |
||
| 686 | * @param string $admin_notes The new admin notes |
||
| 687 | * @return self |
||
| 688 | */ |
||
| 689 | public function setAdminNotes($admin_notes) |
||
| 693 | |||
| 694 | /** |
||
| 695 | * Set the player's country |
||
| 696 | * @param int $country The ID of the new country |
||
| 697 | * @return self |
||
| 698 | */ |
||
| 699 | public function setCountry($country) |
||
| 703 | |||
| 704 | /** |
||
| 705 | * Updates this player's last login |
||
| 706 | */ |
||
| 707 | public function updateLastLogin() |
||
| 711 | |||
| 712 | /** |
||
| 713 | 1 | * Get the player's username |
|
| 714 | * @return string The username |
||
| 715 | 1 | */ |
|
| 716 | public function getUsername() |
||
| 720 | |||
| 721 | /** |
||
| 722 | 1 | * Get the player's username, safe for use in your HTML |
|
| 723 | * @return string The username |
||
| 724 | 1 | */ |
|
| 725 | public function getEscapedUsername() |
||
| 729 | |||
| 730 | /** |
||
| 731 | * Alias for Player::setUsername() |
||
| 732 | * |
||
| 733 | * @param string $username The new username |
||
| 734 | * @return self |
||
| 735 | */ |
||
| 736 | public function setName($username) |
||
| 740 | |||
| 741 | /** |
||
| 742 | * Mark all the unread messages of a player as read |
||
| 743 | * |
||
| 744 | * @return void |
||
| 745 | */ |
||
| 746 | public function markMessagesAsRead() |
||
| 753 | |||
| 754 | /** |
||
| 755 | * Set the roles of a user |
||
| 756 | * |
||
| 757 | * @todo Is it worth making this faster? |
||
| 758 | * @param Role[] $roles The new roles of the user |
||
| 759 | * @return self |
||
| 760 | */ |
||
| 761 | public function setRoles($roles) |
||
| 784 | |||
| 785 | /** |
||
| 786 | * Give or remove a role to/form a player |
||
| 787 | * |
||
| 788 | * @param int $role_id The role ID to add or remove |
||
| 789 | * @param string $action Whether to "add" or "remove" a role for a player |
||
| 790 | 39 | * |
|
| 791 | * @return bool Whether the operation was successful or not |
||
| 792 | 39 | */ |
|
| 793 | private function modifyRole($role_id, $action) |
||
| 811 | |||
| 812 | /** |
||
| 813 | * Given a player's BZID, get a player object |
||
| 814 | * |
||
| 815 | 1 | * @param int $bzid The player's BZID |
|
| 816 | * @return Player |
||
| 817 | 1 | */ |
|
| 818 | public static function getFromBZID($bzid) |
||
| 822 | |||
| 823 | /** |
||
| 824 | * Get a single player by their username |
||
| 825 | * |
||
| 826 | 1 | * @param string $username The username to look for |
|
| 827 | * @return Player |
||
| 828 | 1 | */ |
|
| 829 | public static function getFromUsername($username) |
||
| 835 | |||
| 836 | /** |
||
| 837 | * Get all the players in the database that have an active status |
||
| 838 | * @return Player[] An array of player BZIDs |
||
| 839 | */ |
||
| 840 | public static function getPlayers() |
||
| 846 | |||
| 847 | /** |
||
| 848 | 1 | * Show the number of notifications the user hasn't read yet |
|
| 849 | * @return int |
||
| 850 | 1 | */ |
|
| 851 | public function countUnreadNotifications() |
||
| 855 | |||
| 856 | /** |
||
| 857 | 1 | * Count the number of matches a player has participated in |
|
| 858 | * @return int |
||
| 859 | 1 | */ |
|
| 860 | 1 | public function getMatchCount() |
|
| 871 | 2 | ||
| 872 | 2 | /** |
|
| 873 | * Get the (victory/total matches) ratio of the player |
||
| 874 | * @return float |
||
| 875 | */ |
||
| 876 | public function getMatchWinRatio() |
||
| 891 | |||
| 892 | /** |
||
| 893 | * Get the (total caps made by team/total matches) ratio of the player |
||
| 894 | * @return float |
||
| 895 | 39 | */ |
|
| 896 | public function getMatchAverageCaps() |
||
| 920 | |||
| 921 | /** |
||
| 922 | * Show the number of messages the user hasn't read yet |
||
| 923 | * @return int |
||
| 924 | */ |
||
| 925 | public function countUnreadMessages() |
||
| 931 | |||
| 932 | 39 | /** |
|
| 933 | * Get all of the members belonging to a team |
||
| 934 | 39 | * @param int $teamID The ID of the team to fetch the members of |
|
| 935 | 39 | * @return Player[] An array of Player objects of the team members |
|
| 936 | 39 | */ |
|
| 937 | public static function getTeamMembers($teamID) |
||
| 943 | 39 | ||
| 944 | 39 | /** |
|
| 945 | 39 | * {@inheritdoc} |
|
| 946 | 39 | */ |
|
| 947 | 39 | public static function getActiveStatuses() |
|
| 951 | |||
| 952 | 39 | /** |
|
| 953 | 39 | * {@inheritdoc} |
|
| 954 | 39 | */ |
|
| 955 | public static function getEagerColumns() |
||
| 959 | |||
| 960 | /** |
||
| 961 | * {@inheritdoc} |
||
| 962 | */ |
||
| 963 | public static function getLazyColumns() |
||
| 967 | |||
| 968 | /** |
||
| 969 | * Get a query builder for players |
||
| 970 | * @return QueryBuilder |
||
| 971 | */ |
||
| 972 | View Code Duplication | public static function getQueryBuilder() |
|
| 984 | |||
| 985 | 39 | /** |
|
| 986 | * Enter a new player to the database |
||
| 987 | 1 | * @param int $bzid The player's bzid |
|
| 988 | * @param string $username The player's username |
||
| 989 | * @param int $team The player's team |
||
| 990 | * @param string $status The player's status |
||
| 991 | * @param int $role_id The player's role when they are first created |
||
| 992 | * @param string $avatar The player's profile avatar |
||
| 993 | * @param string $description The player's profile description |
||
| 994 | * @param int $country The player's country |
||
| 995 | 38 | * @param string $timezone The player's timezone |
|
| 996 | 38 | * @param string|\TimeDate $joined The date the player joined |
|
| 997 | 38 | * @param string|\TimeDate $last_login The timestamp of the player's last login |
|
| 998 | 38 | * @return Player An object representing the player that was just entered |
|
| 999 | 38 | */ |
|
| 1000 | 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") |
||
| 1026 | |||
| 1027 | 39 | /** |
|
| 1028 | 39 | * Determine if a player exists in the database |
|
| 1029 | * @param int $bzid The player's bzid |
||
| 1030 | * @return bool Whether the player exists in the database |
||
| 1031 | */ |
||
| 1032 | public static function playerBZIDExists($bzid) |
||
| 1036 | |||
| 1037 | 1 | /** |
|
| 1038 | * Change a player's callsign and add it to the database if it does not |
||
| 1039 | 1 | * exist as a past callsign |
|
| 1040 | * |
||
| 1041 | * @param string $username The new username of the player |
||
| 1042 | * @return self |
||
| 1043 | */ |
||
| 1044 | public function setUsername($username) |
||
| 1075 | |||
| 1076 | 1 | /** |
|
| 1077 | * Alphabetical order function for use in usort (case-insensitive) |
||
| 1078 | 1 | * @return Closure The sort function |
|
| 1079 | */ |
||
| 1080 | public static function getAlphabeticalSort() |
||
| 1086 | |||
| 1087 | /** |
||
| 1088 | * {@inheritdoc} |
||
| 1089 | * @todo Add a constraint that does this automatically |
||
| 1090 | */ |
||
| 1091 | public function wipe() |
||
| 1097 | |||
| 1098 | /** |
||
| 1099 | * Find whether the player can delete a model |
||
| 1100 | * |
||
| 1101 | * @param PermissionModel $model The model that will be seen |
||
| 1102 | * @param bool $showDeleted Whether to show deleted models to admins |
||
| 1103 | * @return bool |
||
| 1104 | */ |
||
| 1105 | public function canSee($model, $showDeleted = false) |
||
| 1109 | |||
| 1110 | /** |
||
| 1111 | * Find whether the player can delete a model |
||
| 1112 | * |
||
| 1113 | * @param PermissionModel $model The model that will be deleted |
||
| 1114 | * @param bool $hard Whether to check for hard-delete perms, as opposed |
||
| 1115 | * to soft-delete ones |
||
| 1116 | * @return bool |
||
| 1117 | */ |
||
| 1118 | public function canDelete($model, $hard = false) |
||
| 1126 | |||
| 1127 | /** |
||
| 1128 | * Find whether the player can create a model |
||
| 1129 | * |
||
| 1130 | * @param string $modelName The PHP class identifier of the model type |
||
| 1131 | * @return bool |
||
| 1132 | */ |
||
| 1133 | public function canCreate($modelName) |
||
| 1137 | |||
| 1138 | /** |
||
| 1139 | * Find whether the player can edit a model |
||
| 1140 | * |
||
| 1141 | * @param PermissionModel $model The model which will be edited |
||
| 1142 | * @return bool |
||
| 1143 | */ |
||
| 1144 | public function canEdit($model) |
||
| 1148 | } |
||
| 1149 |
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..