Match::setServerAddress() - Code Metrics - Inspection of "Add support for editing and deleting arbitrary mat..." - allejo/bzion - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( bce3ff...b78e58 )

by Konstantinos
created 2016-02-20 00:53 UTC
Match::setServerAddress() A

↳ Parent: Match
Complexity

Conditions	1
Paths	1
Size

Total Lines	7
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Metric	Value
dl	0
loc	7
ccs	0
cts	4
cp	0
rs	9.4285
cc	1
eloc	4
nc	1
nop	2
crap	2
<?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
 */

/**
 * A match played between two teams
 * @package    BZiON\Models
 */
class Match extends PermissionModel implements NamedModel
{
    /**
     * 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 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 BZIDs of players part of Team A who participated in the match, separated by commas
     * @var string
     */
    protected $team_a_players;

    /**
     * The BZIDs of players part of Team B who participated in the match, separated by commas
     * @var string
     */
    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;

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

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

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

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

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

    /**
     * The timestamp representing when the match was played
     * @var TimeDate
     */
    protected $timestamp;

    /**
     * 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;

    /**
     * The status of the match. Can be 'entered', 'disabled', 'deleted' or 'reported'
     * @var string
     */
    protected $status;

    /**
     * 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_points = $match['team_a_points'];
        $this->team_b_points = $match['team_b_points'];
        $this->team_a_players = $match['team_a_players'];
        $this->team_b_players = $match['team_b_players'];
        $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_details = $match['match_details'];
        $this->port = $match['port'];
        $this->server = $match['server'];
        $this->replay_file = $match['replay_file'];
        $this->elo_diff = $match['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'];
    }

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

    /**
     * Get a one word description of a match relative to a team (i.e. win, loss, or draw)
     *
     * @param int $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 $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|Team $teamID The team we want the score for
     *
     * @return int The score that team received
     */
    public function getScore($teamID)

    {
        if ($teamID instanceof Team) {
            // Oh no! The caller gave us a Team model instead of an ID!
            $teamID = $teamID->getId();
        }

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

        return $this->getTeamBPoints();
    }

    /**
     * Get the score of the opponent relative to a team
     *
     * @param int $teamID The opponent of the team we want the score for
     *
     * @return int The score of the opponent
     */
    public function getOpponentScore($teamID)

    {
        if ($teamID instanceof Team) {
            $teamID = $teamID->getId();
        }

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

        return $this->getTeamBPoints();
    }

    /**
     * Get the opponent of a match relative to a team ID
     *
     * @param int $teamID The team who is known in a match
     *
     * @return Team The opponent team
     */
    public function getOpponent($teamID)
    {
        if ($this->getTeamA()->getId() == $teamID) {
            return $this->getTeamB();
        }

        return $this->getTeamA();
    }

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

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

        return $this;
    }

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

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

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

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

    /**
     * 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 = array(), $teamBPlayers = array())
    {
        $this->updateProperty($this->team_a_players, "team_a_players", implode(',', $teamAPlayers), "s");
        $this->updateProperty($this->team_b_players, "team_b_players", implode(',', $teamBPlayers), "s");

        return $this;
    }

    /**
     * Get an array of players based on a string representation
     * @param string $playerString
     * @return Player[]|null Returns null if there were no players recorded for this match
     */
    private static function parsePlayers($playerString)
    {
        if ($playerString == null) {
            return null;
        }

        return Player::arrayIdToModel(explode(",", $playerString));
    }

    /**
     * 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, "i");
        $this->updateProperty($this->team_b_points, "team_b_points", $teamBPoints, "i");

        return $this;
    }

    /**
     * Get the ELO difference applied to each team's old ELO
     * @return int The ELO difference
     */
    public function getEloDiff()
    {
        return abs($this->elo_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 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");
    }

    /**
     * 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 address of the server where this match took place
     * @return string|null Returns null if there was no server address recorded
     */
    public function getServerAddress()
    {
        if ($this->port == null || $this->server == null) {
            return null;
        }

        return $this->server . ":" . $this->port;
    }

    /**
     * Set the server address of the server where this match took place
     *
     * @param  string|null $server The server hostname
     * @param  int|null    $port   The server port
     * @return self
     */
    public function setServerAddress($server = null, $port = 5154)
    {
        $this->updateProperty($this->server, "server", $server, "s");
        $this->updateProperty($this->port, "port", $port, "i");

        return $this;
    }

    /**
     * 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, "i");
    }

    /**
     * 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 Team 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->getId());
    }

    /**
     * Get the winner of a match
     *
     * @return Team The team that was the victor or the team with the lower elo if the match was a draw
     */
    public function getWinner()
    {
        // Get the team that had its ELO increased
        if ($this->elo_diff > 0) {
            return $this->getTeamA();
        } elseif ($this->elo_diff < 0) {
            return $this->getTeamB();
        }

        // If the ELOs 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;
    }

    /**
     * Reset the ELOs of the teams participating in the match
     *
     * @return self
     */
    public function resetELOs()
    {
        $this->getTeamA()->changeELO(-$this->elo_diff);
        $this->getTeamB()->changeELO(+$this->elo_diff);
    }

    /**
     * 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  int|null        $port       The port 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
     * @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, $port = null,
        $replayFile = null, $map = null
    ) {
        $team_a = Team::get($a);
        $team_b = Team::get($b);
        $a_elo = $team_a->getElo();
        $b_elo = $team_b->getElo();

        $diff = self::calculateEloDiff($a_elo, $b_elo, $a_points, $b_points, $duration);

        // Update team ELOs
        $team_a->changeElo($diff);
        $team_b->changeElo(-$diff);

        $match = self::create(array(
            'team_a'         => $a,
            'team_b'         => $b,
            'team_a_points'  => $a_points,
            'team_b_points'  => $b_points,
            'team_a_players' => implode(',', $a_players),
            'team_b_players' => implode(',', $b_players),
            'team_a_elo_new' => $team_a->getElo(),
            'team_b_elo_new' => $team_b->getElo(),
            'elo_diff'       => $diff,
            'timestamp'      => TimeDate::from($timestamp)->toMysql(),
            'duration'       => $duration,
            'entered_by'     => $entered_by,
            'server'         => $server,
            'port'           => $port,
            'replay_file'    => $replayFile,
            'map'            => $map,
            'status'         => 'entered'
        ), 'iiiissiiisiisisis', 'updated');

        $match->updateMatchCount();

        return $match;
    }

    /**
     * Calculate the ELO score difference
     *
     * Computes the absolute value of 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()
        );
    }

    /**
     * Recalculate the match's elo and adjust the team ELO values
     */
    public function recalculateElo()
    {
        $a = $this->getTeamA();
        $b = $this->getTeamB();

        $elo = $this->calculateEloDiff(
            $a->getElo(),
            $b->getElo(),
            $this->getTeamAPoints(),
            $this->getTeamBPoints(),
            $this->getDuration()
        );

        $this->updateProperty($this->elo_diff, "elo_diff", $elo, "i");

        $a->changeElo($elo);
        $b->changeElo(-$elo);

        $this->updateProperty($this->team_a_elo_new, "team_a_elo_new", $a->getElo(), "i");
        $this->updateProperty($this->team_b_elo_new, "team_b_elo_new", $b->getElo(), "i");
    }

    /**
     * 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',
                'status'           => 'status'
            ),
        ));
    }

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

        return parent::delete();
    }

    /**
     * {@inheritdoc}
     */
    public static function getActiveStatuses()
    {
        return array('entered');
    }

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return sprintf("(+/- %d) %s [%d] vs [%d] %s",
            $this->getEloDiff(),
            $this->getWinner()->getName(),
            $this->getScore($this->getWinner()),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $this->getScore($this->getLoser()),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
            $this->getLoser()->getName()
        );
    }

    /**
     * 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)
    {
        $diff = ($decrement) ? -1 : 1;

        if ($this->isDraw()) {
            $this->getTeamA()->changeMatchCount($diff, 'draw');
            $this->getTeamB()->changeMatchCount($diff, 'draw');
        } else {
            $this->getWinner()->changeMatchCount($diff, 'win');
            $this->getLoser()->changeMatchCount($diff, 'loss');
        }
    }
}

allejo / bzion

Push — master ( bce3ff...b78e58 )

Match::setServerAddress() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like
