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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package laravel-ratings

Add rating to any model in laravel

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Contents

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

License

The MIT License (MIT). Please see License File for more information.


All versions of laravel-ratings with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1|^8.2|^8.3
illuminate/database Version ^10.0|^11.0
illuminate/support Version ^10.0|^11.0
livewire/livewire Version ^3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package centrex/laravel-ratings contains the following files

Loading the files please wait ....