Michaelc\Voting\STV\Election

Complexity

Total Complexity

13

Size/Duplication

Total Lines	157
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

86.67%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getCandidate()	0	4	1
A	getCandidateCount()	0	4	1
A	getActiveCandidates()	0	4	1
A	getElectedCandidates()	0	4	1
A	getStateCandidates()	0	14	3
A	getActiveCandidateCount()	0	4	1
A	getWinnersCount()	0	4	1
A	getCandidates()	0	4	1
A	getBallots()	0	4	1
A	getNumBallots()	0	4	1

<?php

namespace Michaelc\Voting\STV;

use Michaelc\Voting\STV\Candidate;

class Election
{
    /**
     * Count of candidates in election
     *
     * @var int
     */
    protected $candidateCount;

    /**
     * Count of number of seats/winners
     *
     * @var int
     */
    protected $winnersCount;

    /**
     * Array of candidates competing in election
     *
     * @var array
     */
    protected $candidates;

    /**
     * Array of ballots cast in election
     *
     * @var array
     */
    protected $ballots;

    /**
     * Constructor
     *
     * @param int   $winnersCount Number of winners to allocate
     * @param array $candidates   Array of candidates competing
     * @param array $ballots      Array of all ballots cast in election
     */
    public function __construct(int $winnersCount, array $candidates, array $ballots)
    {
        $this->winnersCount = $winnersCount;
        $this->candidates = $candidates;
        $this->ballots = $ballots;
        $this->candidateCount = count($candidates);
    }

    /**
     * Get a specific candidate object by their ID
     *
     * @param  int    $id    ID of the candidate to get
     * @return \Michaelc\Voting\STV\Candidate
     */
    public function getCandidate(int $id): Candidate
    {
        return $this->candidates[$id];
    }

    /**
     * Get a count of candidates competing
     *
     * @return int
     */
    public function getCandidateCount(): int
    {
        return $this->candidateCount;
    }

    /**
     * Get an array of candidates still running (not elected or defeated)
     *
     * @return \Michaelc\Voting\STV\Candidate[]
     */
    public function getActiveCandidates(): array
    {
        return $this->getStateCandidates(Candidate::RUNNING);
    }

    /**
     * Get an array of candidates elected
     *
     * @return \Michaelc\Voting\STV\Candidate[]
     */
    public function getElectedCandidates(): array
    {
        return $this->getStateCandidates(Candidate::ELECTED);
    }

    /**
     * Get all candidates of a specific state
     *
     * @param  int    $state A candidate state (See Candidate constants)
     * @return \Michaelc\Voting\STV\Candidate[]
     */
    public function getStateCandidates(int $state): array
    {
        $candidates = [];

        foreach ($this->candidates as $candidateId => $candidate)
        {
            if ($candidate->getState() == $state)
            {
                $candidates[$candidateId] = $candidate;
            }
        }

        return $candidates;
    }

    /**
     * Get a count of candidates still running (not elected or defeated)
     *
     * @return int
     */
    public function getActiveCandidateCount(): int
    {
        return count($this->getActiveCandidates());
    }

    /**
     * Gets the value of winnersCount.
     *
     * @return int
     */
    public function getWinnersCount(): int
    {
        return $this->winnersCount;
    }

    /**
     * Gets the value of candidates.
     *
     * @return array
     */
    public function getCandidates(): array
    {
        return $this->candidates;
    }

    /**
     * Gets the value of ballots.
     *
     * @return array
     */
    public function getBallots(): array
    {
        return $this->ballots;
    }

    /**
     * Get the number of ballots
     *
     * @return int
     */
    public function getNumBallots(): int
    {
        return count($this->ballots);
    }
}