|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Michaelc\Voting\STV; |
|
4
|
|
|
|
|
5
|
|
|
use Michaelc\Voting\STV\Candidate; |
|
6
|
|
|
|
|
7
|
|
|
class Election |
|
8
|
|
|
{ |
|
9
|
|
|
/** |
|
10
|
|
|
* Count of candidates in election |
|
11
|
|
|
* |
|
12
|
|
|
* @var int |
|
13
|
|
|
*/ |
|
14
|
|
|
protected $candidateCount; |
|
15
|
|
|
|
|
16
|
|
|
/** |
|
17
|
|
|
* Count of number of seats/winners |
|
18
|
|
|
* |
|
19
|
|
|
* @var int |
|
20
|
|
|
*/ |
|
21
|
|
|
protected $winnersCount; |
|
22
|
|
|
|
|
23
|
|
|
/** |
|
24
|
|
|
* Array of candidates competing in election |
|
25
|
|
|
* |
|
26
|
|
|
* @var array |
|
27
|
|
|
*/ |
|
28
|
|
|
protected $candidates; |
|
29
|
|
|
|
|
30
|
|
|
/** |
|
31
|
|
|
* Array of ballots cast in election |
|
32
|
|
|
* |
|
33
|
|
|
* @var array |
|
34
|
|
|
*/ |
|
35
|
|
|
protected $ballots; |
|
36
|
|
|
|
|
37
|
|
|
/** |
|
38
|
|
|
* Constructor |
|
39
|
|
|
* |
|
40
|
|
|
* @param int $winnersCount Number of winners to allocate |
|
41
|
|
|
* @param array $candidates Array of candidates competing |
|
42
|
|
|
* @param array $ballots Array of all ballots cast in election |
|
43
|
|
|
*/ |
|
44
|
2 |
|
public function __construct(int $winnersCount, array $candidates, array $ballots) |
|
45
|
|
|
{ |
|
46
|
2 |
|
$this->winnersCount = $winnersCount; |
|
47
|
2 |
|
$this->candidates = $candidates; |
|
48
|
2 |
|
$this->ballots = $ballots; |
|
49
|
2 |
|
$this->candidateCount = count($candidates); |
|
50
|
2 |
|
} |
|
51
|
|
|
|
|
52
|
|
|
/** |
|
53
|
|
|
* Get a specific candidate object by their ID |
|
54
|
|
|
* |
|
55
|
|
|
* @param int $id ID of the candidate to get |
|
56
|
|
|
* @return \Michaelc\Voting\STV\Candidate |
|
57
|
|
|
*/ |
|
58
|
1 |
|
public function getCandidate(int $id): Candidate |
|
59
|
|
|
{ |
|
60
|
1 |
|
return $this->candidates[$id]; |
|
61
|
|
|
} |
|
62
|
|
|
|
|
63
|
|
|
/** |
|
64
|
|
|
* Get a count of candidates competing |
|
65
|
|
|
* |
|
66
|
|
|
* @return int |
|
67
|
|
|
*/ |
|
68
|
1 |
|
public function getCandidateCount(): int |
|
69
|
|
|
{ |
|
70
|
1 |
|
return $this->candidateCount; |
|
71
|
|
|
} |
|
72
|
|
|
|
|
73
|
|
|
/** |
|
74
|
|
|
* Get an array of candidates still running (not elected or defeated) |
|
75
|
|
|
* |
|
76
|
|
|
* @return \Michaelc\Voting\STV\Candidate[] |
|
77
|
|
|
*/ |
|
78
|
1 |
|
public function getActiveCandidates(): array |
|
79
|
|
|
{ |
|
80
|
1 |
|
return $this->getStateCandidates(Candidate::RUNNING); |
|
81
|
|
|
} |
|
82
|
|
|
|
|
83
|
|
|
/** |
|
84
|
|
|
* Get an array of candidates elected |
|
85
|
|
|
* |
|
86
|
|
|
* @return \Michaelc\Voting\STV\Candidate[] |
|
87
|
|
|
*/ |
|
88
|
|
|
public function getElectedCandidates(): array |
|
89
|
|
|
{ |
|
90
|
|
|
return $this->getStateCandidates(Candidate::ELECTED); |
|
91
|
|
|
} |
|
92
|
|
|
|
|
93
|
|
|
/** |
|
94
|
|
|
* Get all candidates of a specific state |
|
95
|
|
|
* |
|
96
|
|
|
* @param int $state A candidate state (See Candidate constants) |
|
97
|
|
|
* @return \Michaelc\Voting\STV\Candidate[] |
|
98
|
|
|
*/ |
|
99
|
1 |
|
public function getStateCandidates(int $state): array |
|
100
|
|
|
{ |
|
101
|
1 |
|
$candidates = []; |
|
102
|
|
|
|
|
103
|
1 |
|
foreach ($this->candidates as $candidateId => $candidate) |
|
104
|
|
|
{ |
|
105
|
1 |
|
if ($candidate->getState() == $state) |
|
106
|
|
|
{ |
|
107
|
1 |
|
$candidates[$candidateId] = $candidate; |
|
108
|
|
|
} |
|
109
|
|
|
} |
|
110
|
|
|
|
|
111
|
1 |
|
return $candidates; |
|
112
|
|
|
} |
|
113
|
|
|
|
|
114
|
|
|
/** |
|
115
|
|
|
* Get a count of candidates still running (not elected or defeated) |
|
116
|
|
|
* |
|
117
|
|
|
* @return int |
|
118
|
|
|
*/ |
|
119
|
1 |
|
public function getActiveCandidateCount(): int |
|
120
|
|
|
{ |
|
121
|
1 |
|
return count($this->getActiveCandidates()); |
|
122
|
|
|
} |
|
123
|
|
|
|
|
124
|
|
|
/** |
|
125
|
|
|
* Gets the value of winnersCount. |
|
126
|
|
|
* |
|
127
|
|
|
* @return int |
|
128
|
|
|
*/ |
|
129
|
2 |
|
public function getWinnersCount(): int |
|
130
|
|
|
{ |
|
131
|
2 |
|
return $this->winnersCount; |
|
132
|
|
|
} |
|
133
|
|
|
|
|
134
|
|
|
/** |
|
135
|
|
|
* Gets the value of candidates. |
|
136
|
|
|
* |
|
137
|
|
|
* @return array |
|
138
|
|
|
*/ |
|
139
|
|
|
public function getCandidates(): array |
|
140
|
|
|
{ |
|
141
|
|
|
return $this->candidates; |
|
142
|
|
|
} |
|
143
|
|
|
|
|
144
|
|
|
/** |
|
145
|
|
|
* Gets the value of ballots. |
|
146
|
|
|
* |
|
147
|
|
|
* @return array |
|
148
|
|
|
*/ |
|
149
|
1 |
|
public function getBallots(): array |
|
150
|
|
|
{ |
|
151
|
1 |
|
return $this->ballots; |
|
152
|
|
|
} |
|
153
|
|
|
|
|
154
|
|
|
/** |
|
155
|
|
|
* Get the number of ballots |
|
156
|
|
|
* |
|
157
|
|
|
* @return int |
|
158
|
|
|
*/ |
|
159
|
2 |
|
public function getNumBallots(): int |
|
160
|
|
|
{ |
|
161
|
2 |
|
return count($this->ballots); |
|
162
|
|
|
} |
|
163
|
|
|
} |
|
164
|
|
|
|
michaelcullum /
voting-system
