naoray/laravel-reviewable

Adds a reviewable feature to your app.

laravel-reviewable

, _(*1)

This package adds a reviewable feature to your app., _(*2)

Install

Laravel Version 5.7+

composer require naoray/laravel-reviewable, _(*3)

Laravel Version 5.6+

composer require naoray/laravel-reviewable:1.1.*, _(*4)

Laravel Version 5.5

composer require naoray/laravel-reviewable:1.0.*, _(*5)

publish config: php artisan vendor:publish --provider="Naoray\LaravelReviewable\LaravelReviewableServiceProvider", _(*6)

Usage

First, add the Naoray\LaravelReviewable\Traits\HasReviews trait to your model you want to add reviews to., _(*7)

use Naoray\LaravelReviewable\Traits\HasReviews;

class Post extends Model
{
    use HasReviews;

    // ...
}

Now you can create a review by:, _(*8)

// from reviewable entity
Post::first()->createReview(5, 'Example review text', $author);

// author is assumed to be logged in and executing this operation
Post::first()->createReview(10);

// with helper
review($post, 5, 'Example Text', $author);

and receive review scores by:, _(*9)

// summarizes all scores
Post::first()->score;

// gives the average of all scores
Post::first()->avg_score;

Using your own Review-Model

If you just want to change the global configuration to use your own Review-Model, just create a new Model and reference it in the reviewable.models.review config., _(*10)

If you do not want to change the global review Model you can take a look at this issue for an example configuration., _(*11)

Testing

Run the tests with:, _(*12)

bash vendor/bin/phpunit, _(*13)

Changelog

Please see CHANGELOG for more information what has changed recently., _(*14)

Contributing

Please see CONTRIBUTING for details., _(*15)

Security

If you discover any security-related issues, please email krishan.koenig@googlemail.com instead of using the issue tracker., _(*16)

License

The MIT License (MIT). Please see License File for more information., _(*17)