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,

$item->review($user, $rating, $comment);

To retrieve the reviews of a model,

$item->reviews;

To get the average rating for a model,

$item->averageRating();

To get the total number of reviews for a model,

$item->reviewCount();

To check if a model has been reviewed by a specific user,

$item->hasReviewByUser($user);

To get all reviews for a model by a specific user,

$item->reviewsByUser($user);

To delete all reviews for a model,

$item->deleteAllReviews();

To get reviews with a specific rating,

$item->reviewsWithRating($rating);

To get the highest rating given to a model,

$item->highestRating();

To get the lowest rating given to a model,

$item->lowestRating();

To get the latest review for a model,

$item->latestReview();

To get the oldest review for a model,

$item->oldestReview();

To calculate the distribution of ratings,

$item->ratingDistribution();

To get all approved reviews for a model,

$item->approvedReviews();

To get the total number of approved reviews,

$item->approvedReviewCount();

To get the average rating for approved reviews,

$item->averageApprovedRating();

To approve a specific review by ID,

$item->approveReview($reviewId);

To approve all reviews for a model,

$item->approveAllReviews();

To get reviews awaiting approval,

$item->pendingReviews();

To get the total number of pending reviews,

$item->pendingReviewCount();

To check if a model has approved reviews,

$item->hasApprovedReviews();

To check if a model has pending reviews,

$item->hasPendingReviews();

To mark a review as unapproved,

$item->unapproveReview($reviewId);

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.

starfolksoftware / gauge

Maintainers

Details