allejo /
bzion
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 Match 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 Match, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 14 | class Match extends UrlModel implements NamedModel |
||
| 15 | { |
||
| 16 | const OFFICIAL = "official"; |
||
| 17 | const SPECIAL = "special"; |
||
| 18 | const FUN = "fm"; |
||
| 19 | |||
| 20 | use Timestamp; |
||
| 21 | |||
| 22 | /** |
||
| 23 | * The ID of the first team of the match |
||
| 24 | * @var int |
||
| 25 | */ |
||
| 26 | protected $team_a; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * The ID of the second team of the match |
||
| 30 | * @var int |
||
| 31 | */ |
||
| 32 | protected $team_b; |
||
| 33 | |||
| 34 | /** |
||
| 35 | * The color of the first team |
||
| 36 | * @var string |
||
| 37 | */ |
||
| 38 | protected $team_a_color; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * The color of the second team |
||
| 42 | * @var string |
||
| 43 | */ |
||
| 44 | protected $team_b_color; |
||
| 45 | |||
| 46 | /** |
||
| 47 | * The match points (usually the number of flag captures) Team A scored |
||
| 48 | * @var int |
||
| 49 | */ |
||
| 50 | protected $team_a_points; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * The match points Team B scored |
||
| 54 | * @var int |
||
| 55 | */ |
||
| 56 | protected $team_b_points; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * The BZIDs of players part of Team A who participated in the match, separated by commas |
||
| 60 | * @var string |
||
| 61 | */ |
||
| 62 | protected $team_a_players; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * The BZIDs of players part of Team B who participated in the match, separated by commas |
||
| 66 | * @var string |
||
| 67 | */ |
||
| 68 | protected $team_b_players; |
||
| 69 | |||
| 70 | /** |
||
| 71 | * The ELO score of Team A after the match |
||
| 72 | * @var int |
||
| 73 | */ |
||
| 74 | protected $team_a_elo_new; |
||
| 75 | |||
| 76 | /** |
||
| 77 | * The ELO score of Team B after the match |
||
| 78 | * @var int |
||
| 79 | */ |
||
| 80 | protected $team_b_elo_new; |
||
| 81 | |||
| 82 | /** |
||
| 83 | * The map ID used in the match if the league supports more than one map |
||
| 84 | * @var int |
||
| 85 | */ |
||
| 86 | protected $map; |
||
| 87 | |||
| 88 | /** |
||
| 89 | * The type of match that occurred. Valid options: official, fm, special |
||
| 90 | * |
||
| 91 | * @var string |
||
| 92 | */ |
||
| 93 | protected $match_type; |
||
| 94 | |||
| 95 | /** |
||
| 96 | * A JSON string of events that happened during a match, such as captures and substitutions |
||
| 97 | * @var string |
||
| 98 | */ |
||
| 99 | protected $match_details; |
||
| 100 | |||
| 101 | /** |
||
| 102 | * The server location of there the match took place |
||
| 103 | * @var string |
||
| 104 | */ |
||
| 105 | protected $server; |
||
| 106 | |||
| 107 | /** |
||
| 108 | * The file name of the replay file of the match |
||
| 109 | * @var string |
||
| 110 | */ |
||
| 111 | protected $replay_file; |
||
| 112 | |||
| 113 | /** |
||
| 114 | * The absolute value of the ELO score difference |
||
| 115 | * @var int |
||
| 116 | */ |
||
| 117 | protected $elo_diff; |
||
| 118 | |||
| 119 | /** |
||
| 120 | * The timestamp representing when the match information was last updated |
||
| 121 | * @var TimeDate |
||
| 122 | */ |
||
| 123 | protected $updated; |
||
| 124 | |||
| 125 | /** |
||
| 126 | * The duration of the match in minutes |
||
| 127 | * @var int |
||
| 128 | */ |
||
| 129 | protected $duration; |
||
| 130 | |||
| 131 | /** |
||
| 132 | * The ID of the person (i.e. referee) who last updated the match information |
||
| 133 | * @var string |
||
| 134 | */ |
||
| 135 | protected $entered_by; |
||
| 136 | |||
| 137 | /** |
||
| 138 | * The status of the match. Can be 'entered', 'disabled', 'deleted' or 'reported' |
||
| 139 | * @var string |
||
| 140 | */ |
||
| 141 | protected $status; |
||
| 142 | |||
| 143 | /** |
||
| 144 | * The name of the database table used for queries |
||
| 145 | */ |
||
| 146 | const TABLE = "matches"; |
||
| 147 | |||
| 148 | const CREATE_PERMISSION = Permission::ENTER_MATCH; |
||
| 149 | const EDIT_PERMISSION = Permission::EDIT_MATCH; |
||
| 150 | const SOFT_DELETE_PERMISSION = Permission::SOFT_DELETE_MATCH; |
||
| 151 | const HARD_DELETE_PERMISSION = Permission::HARD_DELETE_MATCH; |
||
| 152 | |||
| 153 | /** |
||
| 154 | * {@inheritdoc} |
||
| 155 | */ |
||
| 156 | protected function assignResult($match) |
||
| 180 | |||
| 181 | /** |
||
| 182 | * Get the name of the route that shows the object |
||
| 183 | * @param string $action The route's suffix |
||
| 184 | * @return string |
||
| 185 | */ |
||
| 186 | public static function getRouteName($action = 'show') |
||
| 190 | |||
| 191 | /** |
||
| 192 | * Get a one word description of a match relative to a team (i.e. win, loss, or draw) |
||
| 193 | * |
||
| 194 | * @param int|string|TeamInterface $teamID The team ID we want the noun for |
||
| 195 | * |
||
| 196 | * @return string Either "win", "loss", or "draw" relative to the team |
||
| 197 | */ |
||
| 198 | public function getMatchDescription($teamID) |
||
| 208 | |||
| 209 | /** |
||
| 210 | * Get a one letter description of a match relative to a team (i.e. W, L, or T) |
||
| 211 | * |
||
| 212 | * @param int|string|TeamInterface $teamID The team ID we want the noun for |
||
| 213 | * |
||
| 214 | * @return string Either "W", "L", or "T" relative to the team |
||
| 215 | */ |
||
| 216 | public function getMatchLetter($teamID) |
||
| 220 | |||
| 221 | /** |
||
| 222 | * Get the score of a specific team |
||
| 223 | * |
||
| 224 | * @param int|string|TeamInterface $teamID The team we want the score for |
||
| 225 | * |
||
| 226 | * @return int The score that team received |
||
| 227 | */ |
||
| 228 | View Code Duplication | public function getScore($teamID) |
|
| 244 | |||
| 245 | /** |
||
| 246 | * Get the score of the opponent relative to a team |
||
| 247 | * |
||
| 248 | * @param int|string|TeamInterface $teamID The opponent of the team we want the score for |
||
| 249 | * |
||
| 250 | * @return int The score of the opponent |
||
| 251 | */ |
||
| 252 | public function getOpponentScore($teamID) |
||
| 256 | |||
| 257 | /** |
||
| 258 | * Get the opponent of a match relative to a team ID |
||
| 259 | * |
||
| 260 | * @param int|string|TeamInterface $teamID The team who is known in a match |
||
| 261 | * |
||
| 262 | * @return TeamInterface The opponent team |
||
| 263 | */ |
||
| 264 | View Code Duplication | public function getOpponent($teamID) |
|
| 278 | |||
| 279 | /** |
||
| 280 | * Get the timestamp of the last update of the match |
||
| 281 | * |
||
| 282 | * @return TimeDate The match's update timestamp |
||
| 283 | */ |
||
| 284 | public function getUpdated() |
||
| 288 | |||
| 289 | /** |
||
| 290 | * Set the timestamp of the match |
||
| 291 | * |
||
| 292 | * @param mixed $timestamp The match's new timestamp |
||
| 293 | * @return $this |
||
| 294 | */ |
||
| 295 | public function setTimestamp($timestamp) |
||
| 301 | |||
| 302 | /** |
||
| 303 | * Get the first team involved in the match |
||
| 304 | * @return TeamInterface Team A |
||
| 305 | */ |
||
| 306 | public function getTeamA() |
||
| 316 | |||
| 317 | /** |
||
| 318 | * Get the second team involved in the match |
||
| 319 | * @return TeamInterface Team B |
||
| 320 | */ |
||
| 321 | public function getTeamB() |
||
| 331 | |||
| 332 | /** |
||
| 333 | * Get the color of Team A |
||
| 334 | * @return string |
||
| 335 | */ |
||
| 336 | public function getTeamAColor() |
||
| 340 | |||
| 341 | /** |
||
| 342 | * Get the color of Team B |
||
| 343 | * @return string |
||
| 344 | */ |
||
| 345 | public function getTeamBColor() |
||
| 349 | |||
| 350 | /** |
||
| 351 | * Get the list of players on Team A who participated in this match |
||
| 352 | * @return Player[]|null Returns null if there were no players recorded for this match |
||
| 353 | */ |
||
| 354 | public function getTeamAPlayers() |
||
| 358 | |||
| 359 | /** |
||
| 360 | * Get the list of players on Team B who participated in this match |
||
| 361 | * @return Player[]|null Returns null if there were no players recorded for this match |
||
| 362 | */ |
||
| 363 | public function getTeamBPlayers() |
||
| 367 | |||
| 368 | /** |
||
| 369 | * Get the list of players for a team in a match |
||
| 370 | * @param Team|int|null The team or team ID |
||
| 371 | * @return Player[]|null Returns null if there were no players recorded for this match |
||
| 372 | */ |
||
| 373 | public function getPlayers($team = null) |
||
| 387 | |||
| 388 | /** |
||
| 389 | * Set the players of the match's teams |
||
| 390 | * |
||
| 391 | * @param int[] $teamAPlayers An array of player IDs |
||
| 392 | * @param int[] $teamBPlayers An array of player IDs |
||
| 393 | * @return self |
||
| 394 | */ |
||
| 395 | public function setTeamPlayers($teamAPlayers = array(), $teamBPlayers = array()) |
||
| 402 | |||
| 403 | /** |
||
| 404 | * Get an array of players based on a string representation |
||
| 405 | * @param string $playerString |
||
| 406 | * @return Player[]|null Returns null if there were no players recorded for this match |
||
| 407 | */ |
||
| 408 | private function parsePlayers($playerString) |
||
| 416 | |||
| 417 | /** |
||
| 418 | * Get the first team's points |
||
| 419 | * @return int Team A's points |
||
| 420 | */ |
||
| 421 | public function getTeamAPoints() |
||
| 425 | |||
| 426 | /** |
||
| 427 | * Get the second team's points |
||
| 428 | * @return int Team B's points |
||
| 429 | */ |
||
| 430 | public function getTeamBPoints() |
||
| 434 | |||
| 435 | /** |
||
| 436 | * Set the match team points |
||
| 437 | * |
||
| 438 | * @param int $teamAPoints Team A's points |
||
| 439 | * @param int $teamBPoints Team B's points |
||
| 440 | * @return self |
||
| 441 | */ |
||
| 442 | public function setTeamPoints($teamAPoints, $teamBPoints) |
||
| 449 | |||
| 450 | /** |
||
| 451 | * Set the match team colors |
||
| 452 | * |
||
| 453 | * @param ColorTeam|string $teamAColor The color of team A |
||
| 454 | * @param ColorTeam|string $teamBColor The color of team B |
||
| 455 | * @return self |
||
| 456 | */ |
||
| 457 | public function setTeamColors($teamAColor, $teamBColor) |
||
| 473 | |||
| 474 | /** |
||
| 475 | * Get the ELO difference applied to each team's old ELO |
||
| 476 | * @return int The ELO difference |
||
| 477 | */ |
||
| 478 | public function getEloDiff() |
||
| 482 | |||
| 483 | /** |
||
| 484 | * Get the first team's new ELO |
||
| 485 | * @return int Team A's new ELO |
||
| 486 | */ |
||
| 487 | public function getTeamAEloNew() |
||
| 491 | |||
| 492 | /** |
||
| 493 | * Get the second team's new ELO |
||
| 494 | * @return int Team B's new ELO |
||
| 495 | */ |
||
| 496 | public function getTeamBEloNew() |
||
| 500 | |||
| 501 | /** |
||
| 502 | * Get the first team's old ELO |
||
| 503 | * @return int |
||
| 504 | */ |
||
| 505 | public function getTeamAEloOld() |
||
| 509 | |||
| 510 | /** |
||
| 511 | * Get the second team's old ELO |
||
| 512 | * @return int |
||
| 513 | */ |
||
| 514 | public function getTeamBEloOld() |
||
| 518 | |||
| 519 | /** |
||
| 520 | * Get the team's new ELO |
||
| 521 | * @param Team $team The team whose new ELO to return |
||
| 522 | * @return int|null The new ELO, or null if the team provided has not |
||
| 523 | * participated in the match |
||
| 524 | */ |
||
| 525 | public function getTeamEloNew(Team $team) |
||
| 535 | |||
| 536 | /** |
||
| 537 | * Get the team's old ELO |
||
| 538 | * @param Team $team The team whose old ELO to return |
||
| 539 | * @return int|null The old ELO, or null if the team provided has not |
||
| 540 | * participated in the match |
||
| 541 | */ |
||
| 542 | public function getTeamEloOld(Team $team) |
||
| 552 | |||
| 553 | /** |
||
| 554 | * Get the map where the match was played on |
||
| 555 | * @return Map Returns an invalid map if no map was found |
||
| 556 | */ |
||
| 557 | public function getMap() |
||
| 561 | |||
| 562 | /** |
||
| 563 | * Set the map where the match was played |
||
| 564 | * @param int $map The ID of the map |
||
| 565 | * @return self |
||
| 566 | */ |
||
| 567 | public function setMap($map) |
||
| 571 | |||
| 572 | /** |
||
| 573 | * Get the match type |
||
| 574 | * |
||
| 575 | * @return string 'official', 'fm', or 'special' |
||
| 576 | */ |
||
| 577 | public function getMatchType() |
||
| 581 | |||
| 582 | /** |
||
| 583 | * Set the match type |
||
| 584 | * |
||
| 585 | * @param string $matchType A valid match type; official, fm, special |
||
| 586 | * |
||
| 587 | * @return static |
||
| 588 | */ |
||
| 589 | public function setMatchType($matchType) |
||
| 593 | |||
| 594 | /** |
||
| 595 | * Get a JSON decoded array of events that occurred during the match |
||
| 596 | * @return mixed|null Returns null if there were no events recorded for the match |
||
| 597 | */ |
||
| 598 | public function getMatchDetails() |
||
| 602 | |||
| 603 | /** |
||
| 604 | * Get the server address of the server where this match took place |
||
| 605 | * @return string|null Returns null if there was no server address recorded |
||
| 606 | */ |
||
| 607 | public function getServerAddress() |
||
| 611 | |||
| 612 | /** |
||
| 613 | * Set the server address of the server where this match took place |
||
| 614 | * |
||
| 615 | * @param string|null $server The server hostname |
||
| 616 | * @param int|null $port The server port |
||
| 617 | * @return self |
||
| 618 | */ |
||
| 619 | public function setServerAddress($server = null) |
||
| 625 | |||
| 626 | /** |
||
| 627 | * Get the name of the replay file for this specific map |
||
| 628 | * @param int $length The length of the replay file name; it will be truncated |
||
| 629 | * @return string Returns null if there was no replay file name recorded |
||
| 630 | */ |
||
| 631 | public function getReplayFileName($length = 0) |
||
| 639 | |||
| 640 | /** |
||
| 641 | * Get the match duration |
||
| 642 | * @return int The duration of the match in minutes |
||
| 643 | */ |
||
| 644 | public function getDuration() |
||
| 648 | |||
| 649 | /** |
||
| 650 | * Set the match duration |
||
| 651 | * |
||
| 652 | * @param int $duration The new duration of the match in minutes |
||
| 653 | * @return self |
||
| 654 | */ |
||
| 655 | public function setDuration($duration) |
||
| 659 | |||
| 660 | /** |
||
| 661 | * Get the user who entered the match |
||
| 662 | * @return Player |
||
| 663 | */ |
||
| 664 | public function getEnteredBy() |
||
| 668 | |||
| 669 | /** |
||
| 670 | * Get the loser of the match |
||
| 671 | * |
||
| 672 | * @return TeamInterface The team that was the loser or the team with the lower elo if the match was a draw |
||
| 673 | */ |
||
| 674 | public function getLoser() |
||
| 682 | |||
| 683 | /** |
||
| 684 | * Get the winner of a match |
||
| 685 | * |
||
| 686 | * @return TeamInterface The team that was the victor or the team with the lower elo if the match was a draw |
||
| 687 | */ |
||
| 688 | public function getWinner() |
||
| 705 | |||
| 706 | /** |
||
| 707 | * Determine whether the match was a draw |
||
| 708 | * @return bool True if the match ended without any winning teams |
||
| 709 | */ |
||
| 710 | public function isDraw() |
||
| 714 | |||
| 715 | /** |
||
| 716 | * Find out whether the match involves a team |
||
| 717 | * |
||
| 718 | * @param TeamInterface $team The team to check |
||
| 719 | * @return bool |
||
| 720 | */ |
||
| 721 | public function involvesTeam($team) |
||
| 725 | |||
| 726 | /** |
||
| 727 | * Find out if the match is played between official teams |
||
| 728 | */ |
||
| 729 | public function isOfficial() |
||
| 733 | |||
| 734 | /** |
||
| 735 | * Reset the ELOs of the teams participating in the match |
||
| 736 | * |
||
| 737 | * @return self |
||
| 738 | */ |
||
| 739 | public function resetELOs() |
||
| 748 | |||
| 749 | /** |
||
| 750 | * Calculate the match's contribution to the team activity |
||
| 751 | * |
||
| 752 | * @return float |
||
| 753 | */ |
||
| 754 | public function getActivity() |
||
| 767 | |||
| 768 | /** |
||
| 769 | * Enter a new match to the database |
||
| 770 | * @param int $a Team A's ID |
||
| 771 | * @param int $b Team B's ID |
||
| 772 | * @param int $a_points Team A's match points |
||
| 773 | * @param int $b_points Team B's match points |
||
| 774 | * @param int $duration The match duration in minutes |
||
| 775 | * @param int|null $entered_by The ID of the player reporting the match |
||
| 776 | * @param string|DateTime $timestamp When the match was played |
||
| 777 | * @param int[] $a_players The IDs of the first team's players |
||
| 778 | * @param int[] $b_players The IDs of the second team's players |
||
| 779 | * @param string|null $server The address of the server where the match was played |
||
| 780 | * @param int|null $port The port of the server where the match was played |
||
| 781 | * @param string $replayFile The name of the replay file of the match |
||
| 782 | * @param int $map The ID of the map where the match was played, only for rotational leagues |
||
| 783 | * @param string $matchType The type of match (e.g. official, fm, special) |
||
| 784 | * @param string $a_color Team A's color |
||
| 785 | * @param string $b_color Team b's color |
||
| 786 | * @return Match An object representing the match that was just entered |
||
| 787 | */ |
||
| 788 | public static function enterMatch( |
||
| 878 | |||
| 879 | /** |
||
| 880 | * Calculate the ELO score difference |
||
| 881 | * |
||
| 882 | * Computes the ELO score difference on each team after a match, based on |
||
| 883 | * GU League's rules. |
||
| 884 | * |
||
| 885 | * @param int $a_elo Team A's current ELO score |
||
| 886 | * @param int $b_elo Team B's current ELO score |
||
| 887 | * @param int $a_points Team A's match points |
||
| 888 | * @param int $b_points Team B's match points |
||
| 889 | * @param int $duration The match duration in minutes |
||
| 890 | * @return int The ELO score difference |
||
| 891 | */ |
||
| 892 | public static function calculateEloDiff($a_elo, $b_elo, $a_points, $b_points, $duration) |
||
| 915 | |||
| 916 | /** |
||
| 917 | * Find if a match's stored ELO is correct |
||
| 918 | */ |
||
| 919 | public function isEloCorrect() |
||
| 929 | |||
| 930 | /** |
||
| 931 | * Recalculate the match's elo and adjust the team ELO values |
||
| 932 | */ |
||
| 933 | public function recalculateElo() |
||
| 958 | |||
| 959 | /** |
||
| 960 | * Get all the matches in the database |
||
| 961 | */ |
||
| 962 | public static function getMatches() |
||
| 966 | |||
| 967 | /** |
||
| 968 | * Get a query builder for matches |
||
| 969 | * @return MatchQueryBuilder |
||
| 970 | */ |
||
| 971 | public static function getQueryBuilder() |
||
| 986 | |||
| 987 | /** |
||
| 988 | * {@inheritdoc} |
||
| 989 | */ |
||
| 990 | public function delete() |
||
| 996 | |||
| 997 | /** |
||
| 998 | * {@inheritdoc} |
||
| 999 | */ |
||
| 1000 | public static function getActiveStatuses() |
||
| 1004 | |||
| 1005 | /** |
||
| 1006 | * {@inheritdoc} |
||
| 1007 | */ |
||
| 1008 | public function getName() |
||
| 1032 | |||
| 1033 | /** |
||
| 1034 | * Get the average ELO for an array of players |
||
| 1035 | * |
||
| 1036 | * @param int[] $players |
||
| 1037 | * |
||
| 1038 | * @return float|int |
||
| 1039 | */ |
||
| 1040 | private static function getAveragePlayerElo($players) |
||
| 1048 | |||
| 1049 | /** |
||
| 1050 | * Update the match count of the teams participating in the match |
||
| 1051 | * |
||
| 1052 | * @param bool $decrement Whether to decrement instead of incrementing the match count |
||
| 1053 | */ |
||
| 1054 | private function updateMatchCount($decrement = false) |
||
| 1070 | } |
||
| 1071 |
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.