Laravel Rateable
, (*1)
, (*2)
Provides a trait to allow rating of any Eloquent models within your app for Laravel versions 6 and higher., (*3)
Ratings could be fivestar style, or simple +1/-1 style., (*4)
Compatability
Laravel versions < 6.x should use the 1.x releases, (*5)
Laravel versions >= 6.x and < 8.x should use 2.x+ releases, (*6)
Laravel versions >= 8.x should use the 3.x releases, (*7)
Installation
You can install the package via composer:, (*8)
composer require willvincent/laravel-rateable
You can publish and run the migrations with:, (*9)
php artisan vendor:publish --provider="willvincent\Rateable\RateableServiceProvider" --tag="migrations"
php artisan migrate
As with most Laravel packages, if you're using Laravel 5.5 or later, the package will be auto-discovered (learn more if this is new to you)., (*10)
If you're using a version of Laravel before 5.5, you'll need to register the Rateable service provider. In your config/app.php add 'willvincent\Rateable\RateableServiceProvider' to the end of the $providers array., (*11)
'providers' => [
Illuminate\Foundation\Providers\ArtisanServiceProvider::class,
Illuminate\Auth\AuthServiceProvider::class,
...
willvincent\Rateable\RateableServiceProvider::class,
],
Usage
In order to mark a model as "rateable", import the Rateable trait., (*12)
<?php namespace App;
use willvincent\Rateable\Rateable;
use Illuminate\Database\Eloquent\Model;
class Post extends Model
{
use Rateable;
}
Now, your model has access to a few additional methods., (*13)
First, to add a rating to your model:, (*14)
$post = Post::first();
// Add a rating of 5, from the currently authenticated user
$post->rate(5);
dd(Post::first()->ratings);
Or perhaps you want to enforce that users can only rate each model one time,
and if they submit a new value, it will update their existing rating., (*15)
In that case, you'll want to use rateOnce() instead:, (*16)
$post = Post::first();
// Add a rating of 3, or change the user's existing rating _to_ 3.
$post->rateOnce(3);
dd(Post::first()->ratings);
````
Once a model has some ratings, you can fetch the average rating:
````php
$post = Post::first();
dd($post->averageRating);
// $post->averageRating() also works for this.
````
Also, you can fetch the rating percentage. This is also how you enforce a maximum rating value.
````php
$post = Post::first();
dd($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.
// $post->ratingPercent(5) -- Five star rating system totally equivilent to:
// $post->ratingPercent()
````
You can also fetch the sum or average of ratings for the given rateable item the current (authorized) has voted/rated.
````php
$post = Post::first();
// These values depend on the user being logged in,
// they use the Auth facade to fetch the current user's id.
dd($post->userAverageRating);
dd($post->userSumRating);
````
Want to know how many ratings a model has?
```php
dd($post->timesRated());
// Or if you specifically want the number of unique users that have rated the model:
dd($post->usersRated());
Testing
bash
composer test, (*17)
Changelog
Please see CHANGELOG for more information on what has changed recently., (*18)
Contributing
Please see CONTRIBUTING for details., (*19)
Credits
License
The MIT License (MIT). Please see License File for more information., (*20)
Wallogit.com
