Election::getBallots() - Code Metrics - michaelcullum/voting-lib - Measure and Improve Code Quality continuously with Scrutinizer

Election::getBallots() A
last analyzed 2016-08-20 15:40 UTC

↳ Parent: Election

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php

namespace Michaelc\Voting\STV;

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 array $candidates   Array of candidates competing
     * @param array $ballots      Array of all ballots cast in election
     * @param int   $winnersCount Number of winners to allocate
     */
    public function __construct(array $candidates, array $ballots, int $winnersCount = 2)
    {
        $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);
    }

    public function getActiveCandidateIds(): array
    {
        $ids = [];

        $candidates = $this->getActiveCandidates();

        foreach ($candidates as $candidate) {
            $ids[] = $candidate->getId();
        }

        return $ids;
    }

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

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

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

    /**
     * Get an array of candidate ids.
     *
     * @return int[]
     */
    public function getCandidateIds(): array
    {
        $candidateIds = [];

        foreach ($this->candidates as $candidate) {
            $candidateIds[] = $candidate->getId();
        }

        return $candidateIds;
    }

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

    /**
     * Get status of all candidates.
     *
     * @return array
     */
    public function getCandidatesStatus(): array
    {
        $candidates = [];

        foreach ($this->getElectedCandidates() as $candidate) {
            $candidates['elected'][] = $candidate->getId();
        }

        foreach ($this->getActiveCandidates() as $candidate) {
            $candidates['active'][] = [$candidate->getId(), $candidate->getVotes()];
        }

        foreach ($this->getDefeatedCandidates() as $candidate) {
            $candidates['defeated'][] = $candidate->getId();
        }

        return $candidates;
    }
}


1		<?php
2
3		namespace Michaelc\Voting\STV;
4
5		class Election
6		{
7		/**
8		* Count of candidates in election.
9		*
10		* @var int
11		*/
12		protected $candidateCount;
13
14		/**
15		* Count of number of seats/winners.
16		*
17		* @var int
18		*/
19		protected $winnersCount;
20
21		/**
22		* Array of candidates competing in election.
23		*
24		* @var array
25		*/
26		protected $candidates;
27
28		/**
29		* Array of ballots cast in election.
30		*
31		* @var array
32		*/
33		protected $ballots;
34
35		/**
36		* Constructor.
37		*
38		* @param array $candidates Array of candidates competing
39		* @param array $ballots Array of all ballots cast in election
40		* @param int $winnersCount Number of winners to allocate
41		*/
42	6	public function __construct(array $candidates, array $ballots, int $winnersCount = 2)
43		{
44	6	$this->winnersCount = $winnersCount;
45	6	$this->candidates = $candidates;
46	6	$this->ballots = $ballots;
47	6	$this->candidateCount = count($candidates);
48	6	}
49
50		/**
51		* Get a specific candidate object by their ID.
52		*
53		* @param int $id ID of the candidate to get
54		*
55		* @return \Michaelc\Voting\STV\Candidate
56		*/
57	2	public function getCandidate(int $id): Candidate
58		{
59	2	return $this->candidates[$id];
60		}
61
62		/**
63		* Get a count of candidates competing.
64		*
65		* @return int
66		*/
67	4	public function getCandidateCount(): int
68		{
69	4	return $this->candidateCount;
70		}
71
72		/**
73		* Get an array of candidates still running (not elected or defeated).
74		*
75		* @return \Michaelc\Voting\STV\Candidate[]
76		*/
77	3	public function getActiveCandidates(): array
78		{
79	3	return $this->getStateCandidates(Candidate::RUNNING);
80		}
81
82	2	public function getActiveCandidateIds(): array
83		{
84	2	$ids = [];
85
86	2	$candidates = $this->getActiveCandidates();
87
88	2	foreach ($candidates as $candidate) {
89	2	$ids[] = $candidate->getId();
90		}
91
92	2	return $ids;
93		}
94
95		/**
96		* Get an array of candidates elected.
97		*
98		* @return \Michaelc\Voting\STV\Candidate[]
99		*/
100	2	public function getElectedCandidates(): array
101		{
102	2	return $this->getStateCandidates(Candidate::ELECTED);
103		}
104
105		/**
106		* Get an array of candidates defeated.
107		*
108		* @return \Michaelc\Voting\STV\Candidate[]
109		*/
110	2	public function getDefeatedCandidates(): array
111		{
112	2	return $this->getStateCandidates(Candidate::DEFEATED);
113		}
114
115		/**
116		* Get all candidates of a specific state.
117		*
118		* @param int $state A candidate state (See Candidate constants)
119		*
120		* @return \Michaelc\Voting\STV\Candidate[]
121		*/
122	3	public function getStateCandidates(int $state): array
123		{
124	3	$candidates = [];
125
126	3	foreach ($this->candidates as $candidateId => $candidate) {
127	3	if ($candidate->getState() == $state) {
128	3	$candidates[$candidateId] = $candidate;
129		}
130		}
131
132	3	return $candidates;
133		}
134
135		/**
136		* Get a count of candidates still running (not elected or defeated).
137		*
138		* @return int
139		*/
140	2	public function getActiveCandidateCount(): int
141		{
142	2	return count($this->getActiveCandidates());
143		}
144
145		/**
146		* Get an array of candidate ids.
147		*
148		* @return int[]
149		*/
150	3	public function getCandidateIds(): array
151		{
152	3	$candidateIds = [];
153
154	3	foreach ($this->candidates as $candidate) {
155	3	$candidateIds[] = $candidate->getId();
156		}
157
158	3	return $candidateIds;
159		}
160
161		/**
162		* Gets the value of winnersCount.
163		*
164		* @return int
165		*/
166	4	public function getWinnersCount(): int
167		{
168	4	return $this->winnersCount;
169		}
170
171		/**
172		* Gets the value of candidates.
173		*
174		* @return array
175		*/
176	3	public function getCandidates(): array
177		{
178	3	return $this->candidates;
179		}
180
181		/**
182		* Gets the value of ballots.
183		*
184		* @return array
185		*/
186	3	public function getBallots(): array
187		{
188	3	return $this->ballots;
189		}
190
191		/**
192		* Get the number of ballots.
193		*
194		* @return int
195		*/
196	3	public function getNumBallots(): int
197		{
198	3	return count($this->ballots);
199		}
200
201		/**
202		* Get status of all candidates.
203		*
204		* @return array
205		*/
206	1	public function getCandidatesStatus(): array
207		{
208	1	$candidates = [];
209
210	1	foreach ($this->getElectedCandidates() as $candidate) {
211	1	$candidates['elected'][] = $candidate->getId();
212		}
213
214	1	foreach ($this->getActiveCandidates() as $candidate) {
215	1	$candidates['active'][] = [$candidate->getId(), $candidate->getVotes()];
216		}
217
218	1	foreach ($this->getDefeatedCandidates() as $candidate) {
219	1	$candidates['defeated'][] = $candidate->getId();
220		}
221
222	1	return $candidates;
223		}
224		}
225

michaelcullum / voting-lib

Election::getBallots() A last analyzed 2016-08-20 15:40 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Election::getBallots() A
last analyzed 2016-08-20 15:40 UTC