Download the PHP package centrex/laravel-ratings without Composer
On this page you can find all versions of the php package centrex/laravel-ratings. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download centrex/laravel-ratings
More information about centrex/laravel-ratings
Files in centrex/laravel-ratings
Package laravel-ratings
Short Description Add rating to any model in laravel
License MIT
Homepage https://github.com/centrex/laravel-ratings
Informations about the package laravel-ratings
Add rating to any model in laravel
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
Contents
- Installation
- Usage Examples
- Testing
- Changelog
- Contributing
- Credits
- License
Installation
You can install the package via composer:
You can publish the config file with:
This is the contents of the published config file:
Usage
Add a InterectsWithRating
trait to the Model you want to be ratable.
Now you can rate any Model.
Rate the Model
or
View Models' ratings
You can get an overall percentage of the amount of Users' who have rated a Model:
Imagine you want a five-star rating system, and you have a Model that has been rated a 3
and a 5
by two Users'
This will equate to 80%. A float is returned. Changing the maxLength
will recalculate the percentage.
You could then use this percentage for the score
attribute of the component.
Note
By default, the
maxLength
is determined by a config option. You can override this by passing a value to the method.
Unrating Models
By default, you can unrate a Model. If you don't want Users' to unrate Models, set the undo_rating
config option to true.
To unrate a Model, you can use the unrate
method:
The package comes with a bunch of Attributes that you can use. The results of these are based off a single Model been rated by two Users' with a 3
and 5
rating.
Livewire Component
To see the ratings in action, you can use the Livewire component. This allows you to show the ratings on the front-end statically and let the User's rate the Model by clicking on the stars.
Warning
You must have both Tailwind CSS and Font Awesome installed, though Font Awesome can be replaced with your own preferred icon set
Use the component
The component has customisable attributes, including:
If you have the config for unrating a Model set to true
, an icon shows that allows you to unrate the Model.
Testing
๐งน Keep a modern codebase with Pint:
โ Run refactors using Rector
โ๏ธ Run static analysis using PHPStan:
โ Run unit tests using PEST
๐ Run the entire test suite:
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
- centrex
- All Contributors
- cjmellor/rating
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-ratings with dependencies
illuminate/database Version ^10.0|^11.0|^12.0
illuminate/support Version ^10.0|^11.0|^12.0
livewire/livewire Version ^3.0