Download the PHP package cjmellor/rating without Composer
On this page you can find all versions of the php package cjmellor/rating. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cjmellor/rating
More information about cjmellor/rating
Files in cjmellor/rating
Package rating
Short Description A Laravel package that allows for ratings to be added to a Model
License MIT
Homepage https://github.com/cjmellor/rating
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package rating
?style=for-the-badge&logo=laravel){kind=icon}
?style=for-the-badge&logo=livewire&labelColor=rgba(15,%2023,%2042,%201)&logoColor=rgba(251,%20112,%20169,%201)){kind=icon}
Imagine you have a Recipes Model and you want to have your Users' rate your culinary delights. This package allows you to achieve this.
Example
Add a CanBeRated trait to the Model you want to be ratable.
Now you can rate any Model.
Installation
You can install the package via composer:
You can publish and run the migrations with:
You can publish the config file with:
This is the contents of the published config file:
Usage
To rate a Model, you must add the CanBeRated trait to the Model in question.
Rate the Model
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
maxLengthis 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
Changelog
Please see CHANGELOG for more information on what has changed recently.
License
The MIT Licence (MIT). Please see Licence File for more information.
