README

Laravel ReviewRateable

ReviewRateable system for laravel 5

Installation

First, pull in the package through Composer.

composer require shamarkellman/reviewrateable

And then include the service provider within app/config/app.php.

'providers' => [
    ShamarKellman\ReviewRateable\ReviewRateableServiceProvider::class
];

At last you need to publish and run the migration.

php artisan vendor:publish --provider="ShamarKellman\ReviewRateable\ReviewRateableServiceProvider" && php artisan migrate

Setup a Model

<?php

namespace App;

use ShamarKellman\ReviewRateable\Contracts\ReviewRateable;
use ShamarKellman\ReviewRateable\Traits\ReviewRateable as ReviewRateableTrait;
use Illuminate\Database\Eloquent\Model;

class Post extends Model implements ReviewRateable
{
    use ReviewRateableTrait;
}

Create a rating

$user = User::first();
$post = Post::first();

$rating = $post->rating([
    'title' => 'Some title',
    'body' => 'Some body',
    'rating' => 5,
], $user);

dd($rating);

Update a rating

$rating = $post->updateRating(1, [
    'title' => 'new title',
    'body' => 'new body',
    'rating' => 3,
]);

Delete a rating:

$post->deleteRating(1);

Fetch the average rating:

$post->averageRating()

or

$post->averageRating(2) //round to 2 decimal place

Count total rating:

$post->countRating()

Fetch the rating percentage.

This is also how you enforce a maximum rating value.

$post->ratingPercent()

$post->ratingPercent(10)); // Ten star rating system
// Note: The value passed in is treated as the maximum allowed value.
// This defaults to 5 so it can be called without passing a value as well.