1
0
This repository has been archived on 2023-11-30. You can view files and clone it, but cannot push or open issues or pull requests.
dtux__serveur-vote-lalis/include/condorcet/Documentation/Vote Class/public Vote--removeCandidate.md

31 lines
633 B
Markdown
Raw Normal View History

2022-09-21 12:39:11 +02:00
## public Vote::removeCandidate
### Description
```php
public Vote->removeCandidate ( CondorcetPHP\Condorcet\Candidate|string $candidate ): bool
```
Remove candidate from ranking. Set a new ranking and archive the old ranking.
##### **candidate:** *```CondorcetPHP\Condorcet\Candidate|string```*
Candidate object or string.
### Return value:
*(```bool```)* True on success.
### Throws:
* ```CondorcetPHP\Condorcet\Throwable\CandidateDoesNotExistException```
---------------------------------------
### Related method(s)
* [Vote::setRanking](../Vote%20Class/public%20Vote--setRanking.md)