Wallogit.com
2017 © Pedro Peláez
Polymorphic voting for Eloquent models
, (*1)
Install the package using composer, (*2)
composer require natzim/eloquent-voteable
Add the service provider to the providers array in config/app.php, (*3)
'providers' => [
// ...
Natzim\EloquentVoteable\VoteableServiceProvider::class
]
Publish the migrations, (*4)
php artisan vendor:publish
Run the migrations, (*5)
php artsain migrate
In the code examples, $voter implements VoterInterface and $voteable implements VoteableInterface., (*6)
Voters are any model that can vote on voteables., (*7)
Voter models should implement VoterInterface and use Votes:, (*8)
use Natzim\EloquentVoteable\Contracts\VoterInterface;
use Natzim\EloquentVoteable\Traits\Votes;
class User extends Model implements VoterInterface
{
use Votes;
// ...
}
$voter->votes;
Returns: Collection, (*9)
$voter->vote($voteable, 1); // Upvote $voteable
NOTE: Vote weights must be between -127 and 127, as it is stored as a tinyInteger, (*10)
Returns: Vote, (*11)
$voter->upVote($voteable);
Returns: Vote, (*12)
$voter->downVote($voteable);
Returns: Vote, (*13)
$voter->cancelVote($voteable);
Returns: null, (*14)
$voter->getVote($voteable);
Returns: Vote, (*15)
Voteables are any model that can be voted on by voters., (*16)
Voteable classes should implement VoteableInterface and use Voteable:, (*17)
use Natzim\EloquentVoteable\Contracts\VoteableInterface;
use Natzim\EloquentVoteable\Traits\Voteable;
class Post extends Model implements VoteableInterface
{
use Voteable;
// ...
}
$voteable->score();
Returns: int, (*18)
$voteable->votes;
Returns: Collection, (*19)
$voteable->voteBy($voter, 1); // Upvote $voteable
NOTE: Vote weights must be between -127 and 127, as it is stored as a tinyInteger, (*20)
Returns: Vote, (*21)
$voteable->upVoteBy($voter);
Returns: Vote, (*22)
$voteable->downVoteBy($voter);
Returns: Vote, (*23)
$voteable->cancelVoteBy($voter);
Returns: null, (*24)
$voteable->getVoteBy($voter);
Returns: Vote, (*25)
Polymorphic voting for Eloquent models
MIT
voting vote
Polymorphic voting for Eloquent models
MIT
voting vote