44 lines
1.3 KiB
Markdown
44 lines
1.3 KiB
Markdown
|
## public Election::removeCandidates
|
||
|
|
|
||
|
|
### Description
|
||
|
|
|
||
|
|
```php
|
||
|
|
public Election->removeCandidates ( CondorcetPHP\Condorcet\Candidate|array|string $candidates_input ): array
|
||
|
|
```
|
||
|
|
|
||
|
|
Remove candidates from an election.
|
||
|
|
|
||
|
|
*Please note: You can't remove candidates after the first vote. An exception will be thrown.*
|
||
|
|
|
||
|
|
|
||
|
|
##### **candidates_input:** *```CondorcetPHP\Condorcet\Candidate|array|string```*
|
||
|
|
* String matching candidate name
|
||
|
|
* CondorcetPHP\Condorcet\Candidate object
|
||
|
|
* Array populated by CondorcetPHP\Condorcet\Candidate
|
||
|
|
* Array populated by string matching candidate name.
|
||
|
|
|
||
|
|
|
||
|
|
### Return value:
|
||
|
|
|
||
|
|
*(```array```)* List of removed CondorcetPHP\Condorcet\Candidate object.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Throws:
|
||
|
|
|
||
|
|
* ```CondorcetPHP\Condorcet\Throwable\CandidateDoesNotExistException```
|
||
|
|
* ```CondorcetPHP\Condorcet\Throwable\VotingHasStartedException```
|
||
|
|
|
||
|
|
---------------------------------------
|
||
|
|
|
||
|
|
### Related method(s)
|
||
|
|
|
||
|
|
* [Election::addCandidate](../Election%20Class/public%20Election--addCandidate.md)
|
||
|
|
* [Election::getCandidatesList](../Election%20Class/public%20Election--getCandidatesList.md)
|
||
|
|
|
||
|
|
---------------------------------------
|
||
|
|
|
||
|
|
### Examples and explanation
|
||
|
|
|
||
|
|
* **[Manual - Manage Candidate](https://github.com/julien-boudry/Condorcet/wiki/II-%23-A.-Create-an-Election-%23-2.-Create-Candidates)**
|