Skip to content

Commit 985fa07

Browse files
author
daydevelops
committed
update readme, changelog, docblocks
1 parent eddbc4e commit 985fa07

3 files changed

Lines changed: 17 additions & 1 deletion

File tree

changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
All notable changes to `Vote` will be documented in this file.
44

5+
## Version 1.1.0
6+
7+
### Added
8+
- Voters can now be banned or unbanned from voting
9+
510
## Version 1.0
611

712
### Added

readme.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,17 @@ $voter->addWeight($change); // signed int $change is added to the users current
148148
$voter->canVote($votable_item);
149149
```
150150

151+
**Is the Voter Banned from Voting?**
152+
```
153+
$voter->isBanned();
154+
```
155+
156+
**Ban or Unban the Voter**
157+
```
158+
$voter->ban();
159+
$voter->unban();
160+
```
161+
151162

152163
## Events
153164

src/Models/Voter.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class Voter extends Model
1717
* update the voters vote weight by adding a positive or negative change
1818
*
1919
* @param int $change
20-
* @return Voter $voter
20+
* @return bool
2121
*/
2222
public function addVoteWeight($change)
2323
{

0 commit comments

Comments
 (0)