PHP code example of overtrue / laravel-vote
1. Go to this page and download the library: Download overtrue/laravel-vote library . Choose the download type require .
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
overtrue / laravel-vote example snippets
use Illuminate\Notifications\Notifiable;
use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Overtrue\LaravelVote\Traits\Voter;
class User extends Authenticatable
{
use Voter;
<...>
}
use Illuminate\Database\Eloquent\Model;
use Overtrue\LaravelVote\Traits\Votable;
class Idea extends Model
{
use Votable;
<...>
}
$user = User::find(1);
$idea = Idea::find(2);
$user->vote($idea, 1); // upvote
$user->vote($idea, -1); // downvote
$user->upvote($idea);
$user->downvote($idea);
// with custom number of votes
$user->upvote($idea, 3);
$user->downvote($idea, 3);
// cancel vote
$user->cancelVote($idea);
// get my voted items
$user->getVotedItems(Idea::class) // Illuminate\Database\Eloquent\Builder
// state
$user->hasVoted($idea);
$idea->hasBeenVotedBy($user);
foreach($idea->voters as $user) {
// echo $user->name;
}
$votedItemsQuery = $user->getVotedItems();
// filter votable_type
$votedIdeasQuery = $user->getVotedItems(Idea::class);
// fetch results
$votedIdeas = $user->getVoteItems(Idea::class)->get();
$votedIdeas = $user->getVoteItems(Idea::class)->paginate();
$votedIdeas = $user->getVoteItems(Idea::class)->where('title', 'Laravel-Vote')->get();
// all
$user->votes()->count();
// filter votable_type
$user->votes()->ofType(Idea::class)->count();
// voters count
$idea->voters()->count();
// for Voter models:
$users = User::withCount('votes')->get();
// or
$users = User::withCount('upvotes')->get();
// or
$users = User::withCount('downvotes')->get();
// or
$users = User::withCount(['votes', 'upvotes', 'downvotes'])->get();
foreach($users as $user) {
echo $user->votes_count;
echo $user->upvotes_count;
echo $user->downvotes_count;
}
// for Votable models:
$ideas = Idea::withCount('voters')->get();
// or
$ideas = Idea::withCount('upvoters')->get();
$ideas = Idea::withCount('downvoters')->get();
// or
$ideas = Idea::withCount(['voters', 'upvoters', 'downvoters'])->get();
foreach($ideas as $idea) {
echo $idea->voters_count;
echo $idea->upvoters_count;
echo $idea->downvoters_count;
}
$user1->upvote($idea); // 1 (up)
$user2->upvote($idea); // 2 (up)
$user3->upvote($idea); // 3 (up)
$user4->downvote($idea); // -1 (down)
// sum(votes)
$idea->totalVotes(); // 2(3 - 1)
// sum(votes) where votes > 0
$idea->totalUpvotes(); // 3
// abs(sum(votes)) where votes < 0
$idea->totalDownvotes(); // 1
// appends aggregations attributes
$idea->appendsVotesAttributes();
$idea->toArray();
// result
[
"id" => 1
"title" => "Add socialite login support."
"created_at" => "2021-05-20T03:26:16.000000Z"
"updated_at" => "2021-05-20T03:26:16.000000Z"
// these aggregations attributes will be appends.
"total_votes" => 2
"total_upvotes" => 3
"total_downvotes" => 1
],
$idea = Idea::find(1);
$user->attachVoteStatus($idea);
// result
[
"id" => 1
"title" => "Add socialite login support."
"created_at" => "2021-05-20T03:26:16.000000Z"
"updated_at" => "2021-05-20T03:26:16.000000Z"
"has_voted" => true
"has_upvoted" => true
"has_downvoted" => false
],
$ideas = Idea::oldest('id')->get();
$user->attachVoteStatus($ideas);
$ideas = $ideas->toArray();
// result
[
[
"id" => 1
"title" => "Add socialite login support."
"created_at" => "2021-05-20T03:26:16.000000Z"
"updated_at" => "2021-05-20T03:26:16.000000Z"
"has_voted" => true
"has_upvoted" => true
"has_downvoted" => false
],
[
"id" => 2
"title" => "Add php8 support."
"created_at" => "2021-05-20T03:26:16.000000Z"
"updated_at" => "2021-05-20T03:26:16.000000Z"
"has_voted" => true
"has_upvoted" => false
"has_downvoted" => true
],
[
"id" => 3
"title" => "Add qrcode support."
"created_at" => "2021-05-20T03:26:16.000000Z"
"updated_at" => "2021-05-20T03:26:16.000000Z"
"has_voted" => false
"has_upvoted" => false
"has_downvoted" => false
],
]
$ideas = Idea::paginate(20);
$user->attachVoteStatus($ideas->getCollection());
// Voter
use Tests\Idea;$users = User::with('votes')->get();
foreach($users as $user) {
$user->hasVoted($idea);
}
// Votable
$ideas = Idea::with('voters')->get();
foreach($ideas as $idea) {
$idea->hasBeenVotedBy($user);
}
// Votable votes
$ideas = Idea::withTotalVotes() // total_votes
->withTotalUpvotes() // total_upvotes
->withTotalDownvotes() // total_downvotes
->get();
// same as
// withVotesAttributes() = withTotalVotes() + withTotalUpvotes() + withTotalDownvotes()
$ideas = Idea::withVotesAttributes()->get();
// result
[
[
"id" => 1
"title" => "Add socialite login support."
"created_at" => "2021-05-19T07:01:10.000000Z"
"updated_at" => "2021-05-19T07:01:10.000000Z"
"total_votes" => 2
"total_upvotes" => 3
"total_downvotes" => 1
],
[
"id" => 2
"title" => "Add PHP8 support."
"created_at" => "2021-05-20T07:01:10.000000Z"
"updated_at" => "2021-05-20T07:01:10.000000Z"
"total_votes" => 1
"total_upvotes" => 2
"total_downvotes" => 1
]
]
shell
php artisan vendor:publish
bash
php artisan migrate