First, pull in the package through Composer.
composer require ghanem/rating
And then include the service provider within app/config/app.php
.
'providers' => [
Ghanem\Rating\RatingServiceProvider::class
];
At last you need to publish and run the migration.
php artisan vendor:publish --provider="Ghanem\Rating\RatingServiceProvider" && php artisan migrate
<?php
namespace App;
use Ghanem\Rating\Contracts\Rating;
use Ghanem\Rating\Traits\Ratingable as RatingTrait;
use Illuminate\Database\Eloquent\Model;
class Post extends Model implements Rating
{
use RatingTrait;
}
$user = User::first();
$post = Post::first();
$rating = $post->rating([
'rating' => 5
], $user);
dd($rating);
$rating = $post->updateRating(1, [
'rating' => 3
]);
$post->deleteRating(1);
$post->sumRating
// $post->sumRating() also works for this.
$post->avgRating
// $post->avgRating() also works for this.
This is also how you enforce a maximum rating value.
$post->ratingPercent
$post->ratingPercent(10)); // Ten star rating system
// Note: The value passed in is treated as the maximum allowed value.
// This defaults to 5 so it can be called without passing a value as well.