a2design/laravel-reviewable

Reviewable Polymorphic Eloquent Models for Laravel 5

Laravel Reviewable

Installation

Require this package, with Composer, in the root directory of your project., _(*1)

``` bash $ composer require faustbrian/laravel-reviewable, <sub>(*2)</sub>

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

``` php
'providers' => [
    BrianFaust\Reviewable\ReviewableServiceProvider::class
];

To get started, you'll need to publish the vendor assets and migrate:, <sub>(*3)</sub>

php artisan vendor:publish --provider="BrianFaust\Reviewable\ReviewableServiceProvider" && php artisan migrate

Usage

Setup a Model

``` php <?php, <sub>(*4)</sub>

namespace App;, <sub>(*5)</sub>

use BrianFaust\Reviewable\HasReviewsTrait; use BrianFaust\Reviewable\Interfaces\HasReviews; use Illuminate\Database\Eloquent\Model;, <sub>(*6)</sub>

class Post extends Model implements HasReviews { use HasReviewsTrait; }, <sub>(*7)</sub>

### Create a review
``` php
$user = User::first();
$post = Post::first();

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

dd($review);

Update a review

``` php $review = $post->updateReview(1, [ 'title' => 'new title', 'body' => 'new body', 'rating' => 3, ]);, <sub>(*8)</sub>

### Delete a review
``` php
$post->deleteReview(1);

Security

If you discover a security vulnerability within this package, please send an e-mail to Brian Faust at hello@brianfaust.de. All security vulnerabilities will be promptly addressed., <sub>(*9)</sub>

License

The The MIT License (MIT). Please check the LICENSE file for more details., <sub>(*10)</sub>