42 lines
1.6 KiB
Markdown
42 lines
1.6 KiB
Markdown
|
## public Election::addCandidate
|
||
|
|
|
||
|
|
### Description
|
||
|
|
|
||
|
|
```php
|
||
|
|
public Election->addCandidate ( [CondorcetPHP\Condorcet\Candidate|string|null $candidate = null] ): CondorcetPHP\Condorcet\Candidate
|
||
|
|
```
|
||
|
|
|
||
|
|
Add one candidate to an election.
|
||
|
|
|
||
|
|
|
||
|
|
##### **candidate:** *```CondorcetPHP\Condorcet\Candidate|string|null```*
|
||
|
|
Alphanumeric string or CondorcetPHP\Condorcet\Candidate object. The whitespace of your candidate name will be trimmed. If null, this function will create a new candidate with an automatic name.
|
||
|
|
|
||
|
|
|
||
|
|
### Return value:
|
||
|
|
|
||
|
|
*(```CondorcetPHP\Condorcet\Candidate```)* The new candidate object (your or automatic one). Throws an exception on error (existing candidate...).
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Throws:
|
||
|
|
|
||
|
|
* ```CondorcetPHP\Condorcet\Throwable\CandidateExistsException```
|
||
|
|
* ```CondorcetPHP\Condorcet\Throwable\VotingHasStartedException```
|
||
|
|
|
||
|
|
---------------------------------------
|
||
|
|
|
||
|
|
### Related method(s)
|
||
|
|
|
||
|
|
* [Election::parseCandidates](../Election%20Class/public%20Election--parseCandidates.md)
|
||
|
|
* [Election::addCandidatesFromJson](../Election%20Class/public%20Election--addCandidatesFromJson.md)
|
||
|
|
* [Election::removeCandidate](../Election%20Class/public%20Election--removeCandidate.md)
|
||
|
|
* [Election::getCandidatesList](../Election%20Class/public%20Election--getCandidatesList.md)
|
||
|
|
* [Election::canAddCandidate](../Election%20Class/public%20Election--canAddCandidate.md)
|
||
|
|
|
||
|
|
---------------------------------------
|
||
|
|
|
||
|
|
### Examples and explanation
|
||
|
|
|
||
|
|
* **[Manual - Manage Candidate](https://github.com/julien-boudry/Condorcet/wiki/II-%23-A.-Create-an-Election-%23-2.-Create-Candidates)**
|