Download the PHP package rennokki/rating without Composer
On this page you can find all versions of the php package rennokki/rating. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package rating
Laravel Eloquent Rating
Laravel Eloquent Rating allows you to assign ratings to any model, just like any other review based on stars.
🤝 Supporting
If you are using one or more Renoki Co. open-source packages in your production apps, in presentation demos, hobby projects, school projects or so, sponsor our work with Github Sponsors. 📦
🚀 Installation
Install the package:
Publish the config:
Publish the migrations:
Preparing the model
To allow a model to rate other models, it should use the CanRate
trait and implement the Rater
contract.
The other models that can be rated should use CanBeRated
trait and Rateable
contract.
If your model can both rate & be rated by other models, you should use Rate
trait and Rating
contract.
🙌 Usage
To rate other models, simply call rate()
method:
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:
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.
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:
The relationships are based on this too:
🐛 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
- Alex Renoki
- All Contributors