Michaelc\Voting\STV\Candidate

Complexity

Total Complexity

7

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getId()	0	4	1
A	getVotes()	0	4	1
A	addVotes()	0	6	1
A	getState()	0	4	1
A	setState()	0	6	1
A	__toString()	0	4	1

<?php

namespace Michaelc\Voting\STV;

class Candidate
{
    const ELECTED = 1;
    const RUNNING = 2;
    const DEFEATED = 3;

    /**
     * Identifier for the candidate.
     *
     * @var int
     */
    protected $id;

    /**
     * Number of votes the candidate currently has.
     *
     * @var float
     */
    protected $votes;

    /**
     * State of the candidate (use class constants).
     *
     * @var int
     */
    protected $state;

    /**
     * Constructor.
     */
    public function __construct(int $id)
    {
        $this->id = $id;
        $this->votes = 0.0;
        $this->state = self::RUNNING;
    }

    /**
     * String representation of candidates.
     *
     * @return string
     */
    public function __toString()
    {
        return (string) $this->id;
    }

    /**
     * Gets the Identifier for the candidate.
     *
     * @return int
     */
    public function getId(): int
    {
        return $this->id;
    }

    /**
     * Gets the Number of votes the candidate currently has.
     *
     * @return float
     */
    public function getVotes(): float
    {
        return $this->votes;
    }

    /**
     * Adds votes to a candidate.
     *
     * @param float $votes Number of votes to add
     *
     * @return self
     */
    public function addVotes(float $votes)
    {
        $this->votes += $votes;

        return $this;
    }

    /**
     * Gets the State of the candidate (use class constants).
     *
     * @return int
     */
    public function getState(): int
    {
        return $this->state;
    }

    /**
     * Sets the State of the candidate (use class constants).
     *
     * @param int $state the state
     *
     * @return self
     */
    public function setState(int $state)
    {
        $this->state = $state;

        return $this;
    }
}