Match::getName() - Code Metrics - Inspection of "Optimize `matches` table" - allejo/bzion - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#161)

by Vladimir
created 2017-12-29 08:05 UTC
Match::getName() B

↳ Parent: Match
Complexity

Conditions	6
Paths	5
Size

Total Lines	32
Code Lines	21
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	15
CRAP Score	6
Importance

Changes
Metric	Value
dl	0
loc	32
ccs	15
cts	15
cp	1
rs	8.439
c	0
b	0
f	0
cc	6
eloc	21
nc	5
nop	0
crap	6
<?php
/**
 * This file contains functionality relating to the official matches played in the league
 *
 * @package    BZiON\Models
 * @license    https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
 */
use BZIon\Model\Column\Timestamp;

/**
 * A match played between two teams
 * @package    BZiON\Models
 */
class Match extends UrlModel implements NamedModel
{
    const OFFICIAL = "official";
    const SPECIAL  = "special";
    const FUN      = "fm";

    const TEAM_V_TEAM   = 0;
    const TEAM_V_MIXED  = 1;
    const MIXED_V_MIXED = 2;

    use Timestamp;

    /**
     * The ID of the first team of the match
     * @var int
     */
    protected $team_a;

    /**
     * The ID of the second team of the match
     * @var int
     */
    protected $team_b;

    /**
     * The color of the first team
     * @var string
     */
    protected $team_a_color;

    /**
     * The color of the second team
     * @var string
     */
    protected $team_b_color;

    /**
     * The match points (usually the number of flag captures) Team A scored
     * @var int
     */
    protected $team_a_points;

    /**
     * The match points Team B scored
     * @var int
     */
    protected $team_b_points;

    /**
     * The callsigns players used during this match.
     * @var string[]
     */
    protected $player_callsigns;

    /**
     * An associative array of IP addresses used by players during this match.
     * @var string[]
     */
    protected $player_ip_addresses;

    /**
     * The players who participated in Team A during this match.
     * @var Player[]
     */
    protected $team_a_players;

    /**
     * The players who participated in Team B during this match.
     * @var Player[]
     */
    protected $team_b_players;

    /**
     * The ELO score of Team A after the match
     * @var int
     */
    protected $team_a_elo_new;

    /**
     * The ELO score of Team B after the match
     * @var int
     */
    protected $team_b_elo_new;

    /**
     * The map ID used in the match if the league supports more than one map
     * @var int
     */
    protected $map;

    /**
     * The type of match that occurred. Valid options: official, fm, special
     *
     * @var string
     */
    protected $match_type;

    /**
     * A JSON string of events that happened during a match, such as captures and substitutions
     * @var string
     */
    protected $match_details;

    /**
     * The ID of the server where this match took place
     * @var int
     */
    protected $server;

    /**
     * The server location of there the match took place
     * @var string
     */
    protected $server_address;

    /**
     * The file name of the replay file of the match
     * @var string
     */
    protected $replay_file;

    /**
     * The value of the ELO score difference
     * @var int
     */
    protected $elo_diff;

    /**
     * The value of the player Elo difference
     * @var int
     */
    protected $player_elo_diff;

    /**
     * @var array
     */
    protected $player_elo_changelog;

    /**
     * The timestamp representing when the match information was last updated
     * @var TimeDate
     */
    protected $updated;

    /**
     * The duration of the match in minutes
     * @var int
     */
    protected $duration;

    /**
     * The ID of the person (i.e. referee) who last updated the match information
     * @var string
     */
    protected $entered_by;

    const DEFAULT_STATUS = 'entered';

    /**
     * The name of the database table used for queries
     */
    const TABLE = "matches";

    const CREATE_PERMISSION = Permission::ENTER_MATCH;
    const EDIT_PERMISSION = Permission::EDIT_MATCH;
    const SOFT_DELETE_PERMISSION = Permission::SOFT_DELETE_MATCH;
    const HARD_DELETE_PERMISSION = Permission::HARD_DELETE_MATCH;

    /**
     * {@inheritdoc}
     */
    protected function assignResult($match)
    {
        $this->team_a = $match['team_a'];
        $this->team_b = $match['team_b'];
        $this->team_a_color = $match['team_a_color'];
        $this->team_b_color = $match['team_b_color'];
        $this->team_a_points = $match['team_a_points'];
        $this->team_b_points = $match['team_b_points'];
        $this->team_a_elo_new = $match['team_a_elo_new'];
        $this->team_b_elo_new = $match['team_b_elo_new'];
        $this->map = $match['map'];
        $this->match_type = $match['match_type'];
        $this->match_details = $match['match_details'];
        $this->server_address = $match['server'];
        $this->replay_file = $match['replay_file'];
        $this->elo_diff = $match['elo_diff'];
        $this->player_elo_diff = $match['player_elo_diff'];
        $this->timestamp = TimeDate::fromMysql($match['timestamp']);
        $this->updated = TimeDate::fromMysql($match['updated']);
        $this->duration = $match['duration'];
        $this->entered_by = $match['entered_by'];
        $this->status = $match['status'];

        // For legacy support (e.g. Phinx migrations) we need to check if the key exists. Prior to migrations, it didn't
        // exist so Phinx migrations prior to 20170912201127_match_server_relationship will throw warnings.
        //
        // @todo Look for a better solution
        $this->server = isset($match['server_id']) ? $match['server_id'] : null;
    }

    /**
     * Get the name of the route that shows the object
     * @param  string $action The route's suffix
     * @return string
     */
    public static function getRouteName($action = 'show')
    {
        return "match_$action";
    }

    /**
     * Get a one word description of a match relative to a team (i.e. win, loss, or draw)
     *
     * @param int|string|TeamInterface $teamID The team ID we want the noun for
     *
     * @return string Either "win", "loss", or "draw" relative to the team
     */
    public function getMatchDescription($teamID)
    {
        if ($this->getScore($teamID) > $this->getOpponentScore($teamID)) {
            return "win";
        } elseif ($this->getScore($teamID) < $this->getOpponentScore($teamID)) {
            return "loss";
        }

        return "tie";
    }

    /**
     * Get a one letter description of a match relative to a team (i.e. W, L, or T)
     *
     * @param int|string|TeamInterface $teamID The team ID we want the noun for
     *
     * @return string Either "W", "L", or "T" relative to the team
     */
    public function getMatchLetter($teamID)
    {
        return strtoupper(substr($this->getMatchDescription($teamID), 0, 1));
    }

    /**
     * Get the score of a specific team
     *
     * @param int|string|TeamInterface $teamID The team we want the score for
     *
     * @return int The score that team received
     */
    public function getScore($teamID)

    {
        if ($teamID instanceof TeamInterface) {
            // Oh no! The caller gave us a Team model instead of an ID!
            $teamID = $teamID->getId();
        } elseif (is_string($teamID)) {
            // Make sure we're comparing lowercase strings
            $teamID = strtolower($teamID);
        }

        if ($this->getTeamA()->getId() == $teamID) {
            return $this->getTeamAPoints();
        }

        return $this->getTeamBPoints();
    }

    /**
     * Get the score of the opponent relative to a team
     *
     * @param int|string|TeamInterface $teamID The opponent of the team we want the score for
     *
     * @return int The score of the opponent
     */
    public function getOpponentScore($teamID)
    {
        return $this->getScore($this->getOpponent($teamID));
    }

    /**
     * Get the opponent of a match relative to a team ID
     *
     * @param int|string|TeamInterface $teamID The team who is known in a match
     *
     * @return TeamInterface The opponent team
     */
    public function getOpponent($teamID)

    {
        if ($teamID instanceof TeamInterface) {
            $teamID = $teamID->getId();
        } elseif (is_string($teamID)) {
            $teamID = strtolower($teamID);
        }

        if ($this->getTeamA()->getId() == $teamID) {
            return $this->getTeamB();
        }

        return $this->getTeamA();
    }

    /**
     * Get the timestamp of the last update of the match
     *
     * @return TimeDate The match's update timestamp
     */
    public function getUpdated()
    {
        return $this->updated->copy();
    }

    /**
     * Set the timestamp of the match
     *
     * @param  mixed $timestamp The match's new timestamp
     * @return $this
     */
    public function setTimestamp($timestamp)
    {
        $this->updateProperty($this->timestamp, "timestamp", TimeDate::from($timestamp));

        return $this;
    }

    /**
     * Get the first team involved in the match
     * @return TeamInterface Team A
     */
    public function getTeamA()
    {
        $team = Team::get($this->team_a);

        if ($this->match_type === self::OFFICIAL && $team->isValid()) {
            return $team;
        }

        return new ColorTeam($this->team_a_color);
    }

    /**
     * Get the second team involved in the match
     * @return TeamInterface Team B
     */
    public function getTeamB()
    {
        $team = Team::get($this->team_b);

        if ($this->match_type === self::OFFICIAL && $team->isValid()) {
            return $team;
        }

        return new ColorTeam($this->team_b_color);
    }

    /**
     * Get the color of Team A
     * @return string
     */
    public function getTeamAColor()
    {
        return $this->team_a_color;
    }

    /**
     * Get the color of Team B
     * @return string
     */
    public function getTeamBColor()
    {
        return $this->team_b_color;
    }

    /**
     * Get the IP address a player used during this match.
     *
     * @param Player|int $id
     *
     * @return string|null
     */
    public function getPlayerIpAddress($id)
    {
        $this->lazyLoadMatchParticipants();

        if ($id instanceof Player) {
            $id = $id->getId();
        }

        return __::get($this->player_ip_addresses, $id, null);
    }

    /**
     * Get the callsign a player used during this match.
     *
     * @param Player|int $id
     *
     * @return string|null
     */
    public function getPlayerCallsign($id)
    {
        $this->lazyLoadMatchParticipants();

        if ($id instanceof Player) {
            $id = $id->getId();
        }

        return __::get($this->player_callsigns, $id, null);
    }

    /**
     * Get the list of players on Team A who participated in this match
     * @return Player[] Returns null if there were no players recorded for this match
     */
    public function getTeamAPlayers()
    {
        $this->lazyLoadMatchParticipants();

        return $this->team_a_players;
    }

    /**
     * Get the list of players on Team B who participated in this match
     * @return Player[] Returns null if there were no players recorded for this match
     */
    public function getTeamBPlayers()
    {
        $this->lazyLoadMatchParticipants();

        return $this->team_b_players;
    }

    /**
     * Get the list of players for a team in a match
     * @param  Team|int|null The team or team ID
     * @return Player[]|null Returns null if there were no players recorded for this match
     */
    public function getPlayers($team = null)
    {
        if ($team instanceof TeamInterface) {
            $team = $team->getId();
        }

        if ($this->getTeamA()->isValid() && $team === $this->getTeamA()->getId()) {
            return $this->getTeamAPlayers();
        } elseif ($this->getTeamB()->isValid() && $team === $this->getTeamB()->getId()) {
            return $this->getTeamBPlayers();
        }

        return array_merge($this->getTeamAPlayers(), $this->getTeamBPlayers());
    }

    /**
     * Set the players of the match's teams
     *
     * @param int[] $teamAPlayers An array of player IDs
     * @param int[] $teamBPlayers An array of player IDs
     * @return self
     */
    public function setTeamPlayers($teamAPlayers = [], $teamBPlayers = [], $teamAIPs = [], $teamBIPs = [], $teamACallsigns = [], $teamBCallsigns = [])
    {
        $this->db->execute('DELETE FROM match_participation WHERE match_id = ?', [
            $this->getId(),
        ]);

        $matchParticipation = [];

        $this->matchParticipationEntryBuilder(
            $matchParticipation,
            ($this->getTeamA() instanceof Team) ? $this->team_a : null,
            0,
            $teamAPlayers,
            $teamAIPs,
            $teamACallsigns
        );
        $this->matchParticipationEntryBuilder(
            $matchParticipation,
            ($this->getTeamB() instanceof Team) ? $this->team_b : null,
            1,
            $teamBPlayers,
            $teamBIPs,
            $teamBCallsigns
        );

        $this->db->insertBatch('match_participation', $matchParticipation);

        return $this;
    }

    /**
     * Load player participation in this match from its respective tables.
     */
    private function lazyLoadMatchParticipants()
    {
        if ($this->team_a_players !== null || $this->team_b_players !== null) {
            return;
        }

        $participation = $this->db->query('SELECT * FROM match_participation WHERE match_id = ?', [
            $this->getId(),
        ]);

        $loyalty = __::groupBy($participation, 'team_loyalty');

        $this->team_a_players = Player::arrayIdToModel(array_column(__::get($loyalty, 0, []), 'user_id'));

        $this->team_b_players = Player::arrayIdToModel(array_column(__::get($loyalty, 1, []), 'user_id'));


        $this->player_callsigns = array_column($participation, 'callsign', 'user_id');
        $this->player_ip_addresses = array_column($participation, 'ip_address', 'user_id');
    }

    /**
     * Get the first team's points
     * @return int Team A's points
     */
    public function getTeamAPoints()
    {
        return $this->team_a_points;
    }

    /**
     * Get the second team's points
     * @return int Team B's points
     */
    public function getTeamBPoints()
    {
        return $this->team_b_points;
    }

    /**
     * Set the match team points
     *
     * @param  int $teamAPoints Team A's points
     * @param  int $teamBPoints Team B's points
     * @return self
     */
    public function setTeamPoints($teamAPoints, $teamBPoints)
    {
        $this->updateProperty($this->team_a_points, "team_a_points", $teamAPoints);
        $this->updateProperty($this->team_b_points, "team_b_points", $teamBPoints);

        return $this;
    }

    /**
     * Set the match team colors
     *
     * @param  ColorTeam|string $teamAColor The color of team A
     * @param  ColorTeam|string $teamBColor The color of team B
     * @return self
     */
    public function setTeamColors($teamAColor, $teamBColor)
    {
        if ($this->isOfficial()) {
            throw new \Exception("Cannot change team colors in an official match");
        }

        if ($teamAColor instanceof ColorTeam) {
            $teamAColor = $teamAColor->getId();
        }
        if ($teamBColor instanceof ColorTeam) {
            $teamBColor = $teamBColor->getId();
        }

        $this->updateProperty($this->team_a_color, "team_a_color", $teamAColor);
        $this->updateProperty($this->team_b_color, "team_b_color", $teamBColor);
    }

    /**
     * Get the ELO difference applied to each team's old ELO
     *
     * @param bool $absoluteValue Whether or not to get the absolute value of the Elo difference
     *
     * @return int The ELO difference
     */
    public function getEloDiff($absoluteValue = true)
    {
        return ($absoluteValue) ? abs($this->elo_diff) : $this->elo_diff;
    }

    /**
     * Get the Elo difference applied to players
     *
     * @param bool $absoluteValue Whether or not to get the absolute value of the Elo difference
     *
     * @return int The Elo difference for players
     */
    public function getPlayerEloDiff($absoluteValue = true)
    {
        return ($absoluteValue && $this->player_elo_diff !== null) ? abs($this->player_elo_diff) : $this->player_elo_diff;
    }

    /**
     * Get the changelog for the player Elos for this match and cache them
     */
    private function getPlayerEloChangelog()
    {
        if ($this->player_elo_changelog !== null) {
            return;
        }

        $results = $this->db->query('SELECT * FROM player_elo WHERE match_id = ?', $this->getId());

        foreach ($results as $result) {
            $this->player_elo_changelog[$result['user_id']] = [
                'before' => $result['elo_previous'],
                'after'  => $result['elo_new']
            ];
        }
    }

    /**
     * Get the Elo for the player before this match occurred
     *
     * @param Player $player
     *
     * @return null|int
     */
    public function getPlayerEloBefore(Player $player)

    {
        $this->getPlayerEloChangelog();

        if (isset($this->player_elo_changelog[$player->getId()])) {
            return $this->player_elo_changelog[$player->getId()]['before'];
        }

        return null;
    }

    /**
     * Get the Elo for the player after this match occurred
     *
     * @param Player $player
     *
     * @return null|int
     */
    public function getPlayerEloAfter(Player $player)

    {
        $this->getPlayerEloChangelog();

        if (isset($this->player_elo_changelog[$player->getId()])) {
            return $this->player_elo_changelog[$player->getId()]['after'];
        }

        return null;
    }

    /**
     * Set the Elo difference applied to players
     *
     * @param int $diff
     */
    public function setPlayerEloDiff($diff)
    {
        $this->updateProperty($this->player_elo_diff, 'player_elo_diff', $diff);
    }

    /**
     * Get the first team's new ELO
     * @return int Team A's new ELO
     */
    public function getTeamAEloNew()
    {
        return $this->team_a_elo_new;
    }

    /**
     * Get the second team's new ELO
     * @return int Team B's new ELO
     */
    public function getTeamBEloNew()
    {
        return $this->team_b_elo_new;
    }

    /**
     * Get the first team's old ELO
     * @return int
     */
    public function getTeamAEloOld()
    {
        return $this->team_a_elo_new - $this->elo_diff;
    }

    /**
     * Get the second team's old ELO
     * @return int
     */
    public function getTeamBEloOld()
    {
        return $this->team_b_elo_new + $this->elo_diff;
    }

    /**
     * Get the team's new ELO
     * @param  Team $team The team whose new ELO to return
     * @return int|null   The new ELO, or null if the team provided has not
     *                    participated in the match
     */
    public function getTeamEloNew(Team $team)
    {
        if ($team->getId() == $this->team_a) {
            return $this->getTeamAEloNew();
        } elseif ($team->getId() == $this->team_b) {
            return $this->getTeamBEloNew();
        }

        return null;
    }

    /**
     * Get the team's old ELO
     * @param  Team $team The team whose old ELO to return
     * @return int|null   The old ELO, or null if the team provided has not
     *                    participated in the match
     */
    public function getTeamEloOld(Team $team)
    {
        if ($team->getId() == $this->team_a) {
            return $this->getTeamAEloOld();
        } elseif ($team->getId() == $this->team_b) {
            return $this->getTeamBEloOld();
        }

        return null;
    }

    /**
     * Get the map where the match was played on
     * @return Map Returns an invalid map if no map was found
     */
    public function getMap()
    {
        return Map::get($this->map);
    }

    /**
     * Set the map where the match was played
     * @param  int $map The ID of the map
     * @return self
     */
    public function setMap($map)
    {
        $this->updateProperty($this->map, "map", $map, "s");

        return $this;
    }

    /**
     * Get the type of official match this is. Whether it has just traditional teams or has mixed teams.
     *
     * Possible official match types:
     *   - Team vs Team
     *   - Team vs Mixed
     *   - Mixed vs Mixed
     *
     * @see Match::TEAM_V_TEAM
     * @see Match::TEAM_V_MIXED
     * @see Match::MIXED_V_MIXED
     *
     * @return int
     */
    public function getTeamMatchType()
    {
        if ($this->getTeamA()->supportsMatchCount() && $this->getTeamB()->supportsMatchCount()) {
            return self::TEAM_V_TEAM;
        } elseif ($this->getTeamA()->supportsMatchCount() xor $this->getTeamB()->supportsMatchCount()) {
            return self::TEAM_V_MIXED;
        }

        return self::MIXED_V_MIXED;
    }

    /**
     * Get the match type
     *
     * @return string 'official', 'fm', or 'special'
     */
    public function getMatchType()
    {
        return $this->match_type;
    }

    /**
     * Set the match type
     *
     * @param  string $matchType A valid match type; official, fm, special
     *
     * @return static
     */
    public function setMatchType($matchType)
    {
        return $this->updateProperty($this->match_type, "match_type", $matchType, 's');
    }

    /**
     * Get a JSON decoded array of events that occurred during the match
     * @return mixed|null Returns null if there were no events recorded for the match
     */
    public function getMatchDetails()
    {
        return json_decode($this->match_details);
    }

    /**
     * Get the server this match took place on
     *
     * @return Server
     */
    public function getServer()
    {
        return Server::get($this->server);
    }

    /**
     * Set the server this match took place on
     *
     * @param  int $serverID
     *
     * @return $this
     */
    public function setServer($serverID = null)
    {
        $this->updateProperty($this->server, 'server_id', $serverID);

        return $this;
    }

    /**
     * Get the server address of the server where this match took place
     *
     * @deprecated 0.10.0 Use Match::getServer() instead. Using this function is reserved for migrations/legacy support.
     *
     * @see 20170912201127_match_server_relationship.php
     *
     * @return string|null Returns null if there was no server address recorded
     */
    public function getServerAddress()
    {
        return $this->server_address;
    }

    /**
     * Get the name of the replay file for this specific map
     * @param  int    $length The length of the replay file name; it will be truncated
     * @return string Returns null if there was no replay file name recorded
     */
    public function getReplayFileName($length = 0)
    {
        if ($length > 0) {
            return substr($this->replay_file, 0, $length);
        }

        return $this->replay_file;
    }

    /**
     * Get the match duration
     * @return int The duration of the match in minutes
     */
    public function getDuration()
    {
        return $this->duration;
    }

    /**
     * Set the match duration
     *
     * @param  int  $duration The new duration of the match in minutes
     * @return self
     */
    public function setDuration($duration)
    {
        return $this->updateProperty($this->duration, "duration", $duration);
    }

    /**
     * Get the user who entered the match
     * @return Player
     */
    public function getEnteredBy()
    {
        return Player::get($this->entered_by);
    }

    /**
     * Get the loser of the match
     *
     * @return TeamInterface The team that was the loser or the team with the lower elo if the match was a draw
     */
    public function getLoser()
    {
        // Get the winner of the match
        $winner = $this->getWinner();

        // Get the team that wasn't the winner... Duh
        return $this->getOpponent($winner);
    }

    /**
     * Get the winner of a match
     *
     * @return TeamInterface The team that was the victor or the team with the lower elo if the match was a draw
     */
    public function getWinner()
    {
        // "As Mother Teresa once said, it's not enough if you win. Others must lose."
        //   -Stephen Colbert

        // Get the team that had its Elo increased or the team whose players had their Elo increased
        if ($this->elo_diff > 0 || $this->player_elo_diff > 0) {
            return $this->getTeamA();
        } elseif ($this->elo_diff < 0 || $this->player_elo_diff < 0) {
            return $this->getTeamB();
        } elseif ($this->team_a_points > $this->team_b_points) {
            // In case we're dealing with a match such an FM that doesn't have an ELO difference
            return $this->getTeamA();
        } elseif ($this->team_a_points < $this->team_b_points) {
            return $this->getTeamB();
        }

        // If the scores are the same, return Team A because well, fuck you that's why
        return $this->getTeamA();
    }

    /**
     * Determine whether the match was a draw
     * @return bool True if the match ended without any winning teams
     */
    public function isDraw()
    {
        return $this->team_a_points == $this->team_b_points;
    }

    /**
     * Find out whether the match involves a team
     *
     * @param  TeamInterface $team The team to check
     * @return bool
     */
    public function involvesTeam($team)
    {
        return $team->getId() == $this->getTeamA()->getId() || $team->getId() == $this->getTeamB()->getId();
    }

    /**
     * Find out if the match is played between official teams
     */
    public function isOfficial()
    {
        return self::OFFICIAL === $this->getMatchType();
    }

    /**
     * Reset the ELOs of the teams participating in the match
     *
     * @return self
     */
    public function resetTeamElos()
    {
        if ($this->match_type === self::OFFICIAL) {
            $this->getTeamA()->supportsMatchCount() && $this->getTeamA()->changeELO(-$this->elo_diff);

            $this->getTeamB()->supportsMatchCount() && $this->getTeamB()->changeELO(+$this->elo_diff);

        }

        return $this;
    }

    /**
     * Calculate the match's contribution to the team activity
     *
     * @return float
     */
    public function getActivity()
    {
        $daysPassed = $this->getTimestamp()->diffInSeconds();
        $daysPassed = $daysPassed / TimeDate::SECONDS_PER_MINUTE / TimeDate::MINUTES_PER_HOUR / TimeDate::HOURS_PER_DAY;

        $activity = 0.0116687059537612 * (pow(45 - $daysPassed, (1 / 6)) + atan(31.0 - $daysPassed) / 2.0);

        if (is_nan($activity) || $activity < 0.0) {
            return 0.0;
        }

        return $activity;
    }

    /**
     * Calculate the Elo differences for players and teams for a given match.
     *
     * @param  Team $a
     * @param  Team $b
     * @param  int  $a_points
     * @param  int  $b_points
     * @param  int[]|Player[] $a_players
     * @param  int[]|Player[] $b_players
     * @param  int  $duration
     *
     * @throws InvalidArgumentException When a "Mixed" team is entered without a player roster
     *
     * @return array
     */
    private static function calculateElos($a, $b, $a_points, $b_points, $a_players, $b_players, $duration)
    {
        // Get the type of official match
        $matchType = Match::MIXED_V_MIXED;
<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

        if ($a->supportsMatchCount() && $b->supportsMatchCount()) {
            $matchType = Match::TEAM_V_TEAM;
<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}
        } elseif ($a->supportsMatchCount() xor $b->supportsMatchCount()) {
            $matchType = Match::TEAM_V_MIXED;
<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}
        }

        if ($matchType == Match::TEAM_V_MIXED &&
<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}
            ((!$a->isValid() && empty($a_players)) || (!$b->isValid() && empty($b_players)))) {
            throw new InvalidArgumentException('A Mixed team must have a player roster to calculate the Elo for team Elo differences');
        }

        //
        // Handle Player Elo Diff Calculations
        //

        // By default, we won't have a player Elo difference since we won't force matches to have a roster
        $playerEloDiff = null;

        $a_players_elo = 1200;
        $b_players_elo = 1200;

        // Only bother to calculate a player Elo diff if we have players reported for both teams
        if (!empty($a_players) && !empty($b_players)) {
            $a_players_elo = self::getAveragePlayerElo($a_players);
            $b_players_elo = self::getAveragePlayerElo($b_players);

            $playerEloDiff = self::calculateEloDiff($a_players_elo, $b_players_elo, $a_points, $b_points, $duration);
        }

        //
        // Handle Team Elo Diff Calculations
        //

        // By default, we'll assume a Mixed vs Mixed official match where Elos do not change for teams
        $teamEloDiff = null;

        // Work with calculations for team Elos to handle the following situations:
        //   - Team vs Team  :: Use team Elos for calculations
        //   - Team vs Mixed :: Use team Elo and the player average Elo for the "Mixed" team
        if ($matchType == Match::TEAM_V_TEAM) {
<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}
            $teamEloDiff = self::calculateEloDiff($a->getElo(), $b->getElo(), $a_points, $b_points, $duration);
        } elseif ($matchType == Match::TEAM_V_MIXED) {
<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}
            $a_team_elo = ($a->supportsMatchCount()) ? $a->getElo() : $a_players_elo;
            $b_team_elo = ($b->supportsMatchCount()) ? $b->getElo() : $b_players_elo;

            $teamEloDiff = self::calculateEloDiff($a_team_elo, $b_team_elo, $a_points, $b_points, $duration);
        }

        return [
            'match_type' => $matchType,
            'team_elo'   => $teamEloDiff,
            'player_elo' => $playerEloDiff
        ];
    }

    /**
     * Enter a new match to the database
     * @param  int             $a          Team A's ID
     * @param  int             $b          Team B's ID
     * @param  int             $a_points   Team A's match points
     * @param  int             $b_points   Team B's match points
     * @param  int             $duration   The match duration in minutes
     * @param  int|null        $entered_by The ID of the player reporting the match
     * @param  string|DateTime $timestamp  When the match was played
     * @param  int[]           $a_players  The IDs of the first team's players
     * @param  int[]           $b_players  The IDs of the second team's players
     * @param  string|null     $server     The address of the server where the match was played
     * @param  string          $replayFile The name of the replay file of the match
     * @param  int             $map        The ID of the map where the match was played, only for rotational leagues
     * @param  string          $matchType  The type of match (e.g. official, fm, special)
     * @param  string          $a_color    Team A's color
     * @param  string          $b_color    Team b's color
     * @param  string[]        $a_ipAddresses The IP addresses of players on Team A. The order of this array should
     *                                        match the order of $a_players
     * @param  string[]        $b_ipAddresses The IP addresses of players on Team B. The order of this array should
     *                                        match the order of $b_players
     * @param  string[]        $a_callsigns   The callsigns of players on Team A. The order of this array should match
     *                                        the order of $a_players
     * @param  string[]        $b_callsigns   The callsigns of players on Team B. The order of this array should match
     *                                        the order of $b_players
     *
     * @throws \Exception               When no testing environment has been configured for the database.
     * @throws InvalidArgumentException When a ColorTeam is selected for an official match and no players are defined
     *                                  for that team
     *
     * @return Match           An object representing the match that was just entered
     */
    public static function enterMatch(
        $a, $b, $a_points, $b_points, $duration, $entered_by, $timestamp = "now",
        $a_players = array(), $b_players = array(), $server = null, $replayFile = null,
        $map = null, $matchType = "official", $a_color = null, $b_color = null,
        $a_ipAddresses = array(), $b_ipAddresses = array(), $a_callsigns = array(), $b_callsigns = array()
    ) {
        $matchData = array(
            'team_a_color'   => strtolower($a_color),
            'team_b_color'   => strtolower($b_color),
            'team_a_points'  => $a_points,
            'team_b_points'  => $b_points,
            'timestamp'      => TimeDate::from($timestamp)->toMysql(),
            'duration'       => $duration,
            'entered_by'     => $entered_by,
            'server'         => $server,
            'replay_file'    => $replayFile,
            'map'            => $map,
            'status'         => 'entered',
            'match_type'     => $matchType
        );

        // (P)layer Elo Diff and (T)eam Elo Diff; respectively
        $tEloDiff = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        if ($matchType === self::OFFICIAL) {
            $team_a = Team::get($a);
            $team_b = Team::get($b);

            $eloCalcs = self::calculateElos($team_a, $team_b, $a_points, $b_points, $a_players, $b_players, $duration);

            $matchData['elo_diff'] = $tEloDiff = $eloCalcs['team_elo'];
            $matchData['player_elo_diff'] = $eloCalcs['player_elo'];

            // Update team ELOs
            if ($team_a->isValid()) {
                $team_a->adjustElo($tEloDiff);

                $matchData['team_a'] = $a;
                $matchData['team_a_elo_new'] = $team_a->getElo();
            }
            if ($team_b->isValid()) {
                $team_b->adjustElo(-$tEloDiff);

                $matchData['team_b'] = $b;
                $matchData['team_b_elo_new'] = $team_b->getElo();
            }
        }

        $match = self::create($matchData, 'updated');
        $match->setTeamPlayers(
            $a_players, $b_players,
            $a_ipAddresses, $b_ipAddresses,
            $a_callsigns, $b_callsigns
        );
        $match->updateMatchCount();
        $match->updatePlayerElo();

        return $match;
    }

    /**
     * Calculate the ELO score difference
     *
     * Computes the ELO score difference on each team after a match, based on
     * GU League's rules.
     *
     * @param  int $a_elo    Team A's current ELO score
     * @param  int $b_elo    Team B's current ELO score
     * @param  int $a_points Team A's match points
     * @param  int $b_points Team B's match points
     * @param  int $duration The match duration in minutes
     * @return int The ELO score difference
     */
    public static function calculateEloDiff($a_elo, $b_elo, $a_points, $b_points, $duration)
    {
        $prob = 1.0 / (1 + pow(10, (($b_elo - $a_elo) / 400.0)));
        if ($a_points > $b_points) {
            $diff = 50 * (1 - $prob);
        } elseif ($a_points == $b_points) {
            $diff = 50 * (0.5 - $prob);
        } else {
            $diff = 50 * (0 - $prob);
        }

        // Apply ELO modifiers from `config.yml`
        $durations = Service::getParameter('bzion.league.duration');
        $diff *= (isset($durations[$duration])) ? $durations[$duration] : 1;

        if (abs($diff) < 1 && $diff != 0) {
            // ELOs such as 0.75 should round up to 1...
            return ($diff > 0) ? 1 : -1;
        }

        // ...everything else is rounded down (-3.7 becomes -3 and 48.1 becomes 48)
        return intval($diff);
    }

    /**
     * Find if a match's stored ELO is correct
     */
    public function isEloCorrect()
    {
        return $this->elo_diff === $this->calculateEloDiff(
            $this->getTeamAEloOld(),
            $this->getTeamBEloOld(),
            $this->getTeamAPoints(),
            $this->getTeamBPoints(),
            $this->getDuration()
        );
    }

    /**
     * Remove Elo recordings for players participating in this match
     */
    public function resetPlayerElos()
    {
        $this->db->execute('DELETE FROM player_elo WHERE match_id = ?', [$this->getId()]);
    }

    /**
     * Recalculate the match's elo and adjust the team ELO values
     */
    public function recalculateElo()
    {
        if ($this->match_type !== self::OFFICIAL) {
            return;
        }

        $a = $this->getTeamA();
        $b = $this->getTeamB();

        $this->resetPlayerElos();

        foreach ($this->getPlayers() as $player) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $player->invalidateMatchFromCache($this);
        }

        $eloCalcs = self::calculateElos(
            $a, $b,

            $this->getTeamAPoints(), $this->getTeamBPoints(),
            $this->getTeamAPlayers(), $this->getTeamBPlayers(),
            $this->getDuration()
        );

        $elo = $eloCalcs['team_elo'];

        $this->updateProperty($this->elo_diff, 'elo_diff', $elo);
        $this->updateProperty($this->player_elo_diff, 'player_elo_diff', $eloCalcs['player_elo']);

        if ($a->supportsMatchCount()) {
            $a->adjustElo($elo);
            $this->updateProperty($this->team_a_elo_new, 'team_a_elo_new', $a->getElo());
        }

        if ($b->supportsMatchCount()) {
            $b->adjustElo(-$elo);
            $this->updateProperty($this->team_b_elo_new, 'team_b_elo_new', $b->getElo());
        }

        $this->updatePlayerElo();
    }

    /**
     * Get all the matches in the database
     */
    public static function getMatches()
    {
        return self::getQueryBuilder()->active()->getModels();
    }

    /**
     * Get a query builder for matches
     * @return MatchQueryBuilder
     */
    public static function getQueryBuilder()
    {
        return new MatchQueryBuilder('Match', array(
            'columns' => array(
                'firstTeam'        => 'team_a',
                'secondTeam'       => 'team_b',
                'firstTeamPoints'  => 'team_a_points',
                'secondTeamPoints' => 'team_b_points',
                'time'             => 'timestamp',
                'map'              => 'map',
                'server'           => 'server_id',
                'type'             => 'match_type',
                'status'           => 'status'
            ),
        ));
    }

    /**
     * {@inheritdoc}
     */
    public function delete()
    {
        $this->updateMatchCount(true);

        parent::delete();
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        $description = '';

        switch ($this->getMatchType()) {
            case self::OFFICIAL:
                // Only show Elo diff if both teams are actual teams
                if ($this->getTeamA()->supportsMatchCount() && $this->getTeamB()->supportsMatchCount()) {
                    $description = "(+/- {$this->getEloDiff()})";
                }
                break;

            case self::FUN:
                $description = 'Fun Match:';
                break;

            case self::SPECIAL:
                $description = 'Special Match:';
                break;

            default:
                break;
        }

        return trim(sprintf('%s %s [%d] vs [%d] %s',
            $description,
            $this->getWinner()->getName(),
            $this->getScore($this->getWinner()),
            $this->getScore($this->getLoser()),
            $this->getLoser()->getName()
        ));
    }

    /**
     * Recalculates match history for all teams and matches
     *
     * Recalculation is done as follows:
     * 1. A match is chosen as a starting point - it's stored old team ELOs are
     *    considered correct
     * 2. Team ELOs are reset to their values at the starting point
     * 3. Each match that occurred since the first specified match has its ELO
     *    recalculated based on the current team values, and the new match data
     *    and team ELOs are stored in the database
     *
     * @param Match $match The first match
     *
     * @throws Exception
     */
    public static function recalculateMatchesSince(Match $match)
    {
        try {
            // Commented out to prevent ridiculously large recalculations
            //set_time_limit(0);

            $query = Match::getQueryBuilder()
<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}
                ->where('status')->notEquals('deleted')
                ->where('type')->equals(Match::OFFICIAL)
<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}
                ->where('time')->isAfter($match->getTimestamp(), $inclusive = true)
                ->sortBy('time');

            /** @var Match[] $matches */
            $matches = $query->getModels($fast = true);

            // Send the total count to client-side javascript
            echo count($matches) . "\n";

            // Start a transaction so tables are locked and we don't stay with
            // messed up data if something goes wrong
            Database::getInstance()->startTransaction();

            $teamsReset = [];

            // Reset match teams, in case the selected match is deleted and does
            // not show up in the list of matches to recalculate
            if ($match->getTeamA()->supportsMatchCount()) {
                $match->getTeamA()->setElo($match->getTeamAEloOld());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                $teamsReset[ $match->getTeamA()->getId() ] = true;
            }
            if ($match->getTeamB()->supportsMatchCount()) {
                $match->getTeamB()->setElo($match->getTeamBEloOld());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                $teamsReset[ $match->getTeamB()->getId() ] = true;
            }

            foreach ($matches as $i => &$match) {
                // Reset teams' ELOs if they haven't been reset already
                if ($match->getTeamA()->supportsMatchCount() && !isset($teamsReset[ $match->getTeamA()->getId() ])) {

                    $teamsReset[ $match->getTeamA()->getId() ] = true;
                    $match->getTeamA()->setElo($match->getTeamAEloOld());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                }
                if ($match->getTeamB()->supportsMatchCount() && !isset($teamsReset[ $match->getTeamB()->getId() ])) {

                    $teamsReset[ $match->getTeamB()->getId() ] = true;
                    $match->getTeamB()->setElo($match->getTeamBEloOld());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                }

                $match->recalculateElo();

                // Send an update to the client-side javascript, so that a
                // progress bar can be updated
                echo "m";
            }
        } catch (Exception $e) {
            Database::getInstance()->rollback();
            Database::getInstance()->finishTransaction();
            throw $e;
        }

        Database::getInstance()->finishTransaction();

        echo "\n\nCalculation successful\n";
    }

    /**
     * Get the average ELO for an array of players
     *
     * @param int[]|Player[] $players
     *
     * @return float|int
     */
    private static function getAveragePlayerElo($players)
    {
        $getElo = function ($n) {
            if ($n instanceof Player) {
                return $n->getElo();
            }

            return Player::get($n)->getElo();
        };

        return array_sum(array_map($getElo, $players)) / count($players);
    }

    /**
     * Update the match count of the teams participating in the match
     *
     * @param bool $decrement Whether to decrement instead of incrementing the match count
     */
    private function updateMatchCount($decrement = false)
    {
        if ($this->match_type !== self::OFFICIAL) {
            return;
        }

        $diff = ($decrement) ? -1 : 1;

        if ($this->isDraw()) {
            $this->getTeamA()->supportsMatchCount() && $this->getTeamA()->changeMatchCount($diff, 'draw');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $this->getTeamB()->supportsMatchCount() && $this->getTeamB()->changeMatchCount($diff, 'draw');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        } else {
            $this->getWinner()->supportsMatchCount() && $this->getWinner()->changeMatchCount($diff, 'win');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $this->getLoser()->supportsMatchCount()  && $this->getLoser()->changeMatchCount($diff, 'loss');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
    }

    /**
     * Update the Elos for the participating players in a match
     */
    private function updatePlayerElo()
    {
        if ($this->match_type !== self::OFFICIAL || $this->getPlayerEloDiff() === null) {
            return;
        }

        $eloDiff = $this->getPlayerEloDiff(false);

        foreach ($this->getTeamAPlayers() as $player) {
            $player->adjustElo($eloDiff, $this);
            $player->setLastMatch($this->getId());
        }

        foreach ($this->getTeamBPlayers() as $player) {
            $player->adjustElo(-$eloDiff, $this);
            $player->setLastMatch($this->getId());
        }
    }

    /**
     * Build an array of match participation records for a given match.
     *
     * @param array    $storage     The referenced array that'll be storing all of the created references.
     * @param int|null $teamID      The ID of the Team this player played for, or NULL if players didn't play for a team
     * @param int      $teamLoyalty Representation for team color: 0 for "Team A" or 1 for "Team B"
     * @param int[]    $playerIDs   The BZiON player IDs that played for this team
     * @param string[] $ipAddresses The IP addresses for the recorded players, the order must match the order of $playerIDs
     * @param string[] $callsigns   The callsigns for the recorded players, the order must match the order of $playerIDs
     */
    private function matchParticipationEntryBuilder(array &$storage, $teamID, $teamLoyalty, array $playerIDs, array $ipAddresses = [], array $callsigns = [])
    {
        foreach ($playerIDs as $index => $playerID) {
            if (empty($playerID)) {
                continue;
            }

            $workspace = [
                'match_id' => $this->getId(),
                'user_id' => $playerID,
                'team_id' => $teamID,
                'callsign' => __::get($callsigns, $index, null),
                'ip_address' => __::get($ipAddresses, $index, null),
                'team_loyalty' => $teamLoyalty,
            ];

            $storage[] = $workspace;
        }
    }
}

Pull Request — master (#161)

Match::getName() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

allejo / bzion

Pull Request — master (#161)

Match::getName() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
