Awesome Open Source
Awesome Open Source

Laravel Eloquent Rating

CI codecov StyleCI Latest Stable Version Total Downloads Monthly Downloads License

Laravel Eloquent Rating allows you to assign ratings to any model, just like any other review based on stars.

🤝 Supporting

Renoki Co. on GitHub aims on bringing a lot of open source projects and helpful projects to the world. Developing and maintaining projects everyday is a harsh work and tho, we love it.

If you are using your application in your day-to-day job, on presentation demos, hobby projects or even school projects, spread some kind words about our work or sponsor our work. Kind words will touch our chakras and vibe, while the sponsorships will keep the open source projects alive.

🚀 Installation

Install the package:

$ composer require rennokki/rating

Publish the config:

$ php artisan vendor:publish --provider="Rennokki\Rating\RatingServiceProvider" --tag="config"

Publish the migrations:

$ php artisan vendor:publish --provider="Rennokki\Rating\RatingServiceProvider" --tag="migrations"

Preparing the model

To allow a model to rate other models, it should use the CanRate trait and implement the Rater contract.

use Rennokki\Rating\Traits\CanRate;
use Rennokki\Rating\Contracts\Rater;

class User extends Model implements Rater
    use CanRate;

The other models that can be rated should use CanBeRated trait and Rateable contract.

use Rennokki\Rating\Traits\CanBeRated;
use Rennokki\Rating\Contracts\Rateable;

class User extends Model implements Rateable
    use CanBeRated;

If your model can both rate & be rated by other models, you should use Rate trait and Rating contract.

use Rennokki\Rating\Traits\Rate;
use Rennokki\Rating\Contracts\Rating;

class User extends Model implements Rating
    use Rate;


🙌 Usage

To rate other models, simply call rate() method:

$page = Page::find(1);

$user->rate($page, 10);
$user->hasRated($page); // true
$page->averageRating(User::class); // 10.0, as float

As a second argument to the rate() method, you can pass the rating score. It can either be string, integer or float.

To update a rating, you can call updateRatingFor() method:

$user->updateRatingFor($page, 9);
$page->averageRating(User::class); // 9.00, as float

As you have seen, you can call averageRating() within models that can be rated. The return value is the average arithmetic value of all ratings as float.

If we leave the argument empty, we will get 0.00 because no other Page model has rated the page so far. But since users have rated the page, we will calculate the average only from the User models, since only they have voted the page, strictly by passing the class name as the argument.

$page = Page::find(1);

$user1->rate($page, 10);
$user2->rate($page, 6);

$page->averageRating(); // 0.00
$page->averageRating(User::class); // 8.00, as float

While in our example, the User class can both rate and be rated, we can leave the argument empty if we reference to its class:

$user = User::find(1);

$user1->rate($user, 10);
$user2->rate($user, 6);

$user->averageRating(); // 8.00, as float
$user->averageRating(User::class); // 8.00, it is equivalent

The relationships are based on this too:

$page->raters()->get(); // Pages that have rated this page
$page->raters(User::class)->get(); // Users that have rated this page

$user->ratings()->get(); // Users that this user has rated
$user->ratings(Page::class)->get(); // Pages that this user has rated

🐛 Testing


🤝 Contributing

Please see CONTRIBUTING for details.

🔒 Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

ğŸŽ‰ Credits

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
php (15,678) 
laravel (1,520) 
model (105) 
eloquent (100) 
rating (44) 

Find Open Source By Browsing 7,000 Topics Across 59 Categories