starfolksoftware / gauge
Gauge is a simple Laravel package that makes your models reviewable
Requires
- php: ^8.1
- spatie/laravel-package-tools: ^1.13.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^6.0|^7.0
- nunomaduro/larastan: ^2.0.1
- orchestra/testbench: ^7.0|^8.0
- pestphp/pest: ^1.21
- pestphp/pest-plugin-laravel: ^1.1
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpunit/phpunit: ^9.5
README
Add reviews and ratings capabilities to your Laravel applications.
Installation
You can install the package via composer:
composer require starfolksoftware/gauge
To install the package, run the following command:
php artisan gauge:install
Configurations
To disable migrations, add the following in the service provider:
Gauge::ignoreMigrations();
To use a different Review
model:
Gauge::useReviewModel('App\\Models\\CoolReviewModel');
To specify the user model to be used with Gauge:
Gauge::useUserModel('App\\Models\\UserTestModel');
To specify the reviews table name,
Gauge::useReviewsTableName('reviews_table');
To turn on support for soft deletiong,
Gauge::supportsSoftDeletes();
To turn on support or single reviews, that is, each user can only review a model at most once:
Gauge::supportsSingleReviews();
To turn on support for teams
Gauge::supportsTeams();
Usage
To make a model reviewable, add the Reviewable
trait as in the following:
use StarfolkSoftware\Gauge\Reviewable; class Item extends Model { // ... use Reviewable; // ... }
To create a review on a reviewable model,
$branch->review($user, $rating, $comment)
To setup the team support, add the TeamHasReviews
trait to the team model,
use StarfolkSoftware\Gauge\TeamHasReviews; class Team extends Model { use TeamHasReviews; protected $table = 'teams'; }
To create a review for a team,
$team->reviews()->save([ //... ]);
To fetch reviews of a team,
$team->reviews
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.