naoray/laravel-reviewable

Adds a reviewable feature to your laravel app.

laravel-reviewable

This package adds a reviewable feature to your app.

Install

Laravel Version 5.7+

composer require naoray/laravel-reviewable

Laravel Version 5.6+

composer require naoray/laravel-reviewable:1.1.*

Laravel Version 5.5

composer require naoray/laravel-reviewable:1.0.*

publish config: php artisan vendor:publish --provider="Naoray\LaravelReviewable\LaravelReviewableServiceProvider"

Usage

First, add the Naoray\LaravelReviewable\Traits\HasReviews trait to your model you want to add reviews to.

use Naoray\LaravelReviewable\Traits\HasReviews;

class Post extends Model
{
    use HasReviews;

    // ...
}

Now you can create a review by:

// 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:

// 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.

If you do not want to change the global review Model you can take a look at this issue for an example configuration.

Testing

Run the tests with:

vendor/bin/phpunit

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

License

The MIT License (MIT). Please see License File for more information.

laravel-reviewable's Issues

Update for Laravel 5.8 usage

• Update the dependencies and the codebase to work with Laravel 5.8
• make sure the tests still work

[How to] Use a different custom Review model for each reviewable

While playing around with the package, I found myself where I needed to use reviews for two different models. However, I also wanted to use a custom Review model for each of these reviewables.

The current implementation, through the config file only allows me to override the Review model globally. I figured out a way to do this individually for each reviewable and thought I'd share how I did it so others might be able to do the same.

On the reviewable model:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Naoray\LaravelReviewable\Traits\HasReviews;

class TravelTip extends Model
{
    use HasReviews;

    /**
     * Override HasReviews trait method to use appropriate model.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphMany
     */
    public function reviews()
    {
        return $this->morphMany(
            'App\TravelTipReview', // Replace this with your custom Review model
            'reviewable'
        );
    }

On your custom Review model:

<?php

namespace App;

use Naoray\LaravelReviewable\Models\Review;

class TravelTipReview extends Review
{
    /**
     * The table associated with the model.
     *
     * @var string
     */
    protected $table = 'reviews'; // Required for Laravel to avoid trying to resolve the table name from the model name

    // Add your custom properties and methods here

All that's left to do is call your custom Review model is controllers if needed!

Incorrect syntax for vendor:publish in readme

Hey there,

Great package! However it seems there may be a small error in the readme, spend about 15 minutes scratching my head about this one!

The readme should read php artisan vendor:publish --provider="Naoray\LaravelReviewable\LaravelReviewableServiceProvider". The double quotes were missing around the Service Provider's path, preventing the command from functioning correctly.

Additionally, you may want to specify the command is also required to publish the migration.

Thanks for the great package!

Add support for Laravel 6.0

• Go through the upgrade guide and change everything as suggested
• Make sure all tests are passing afterwards

unsinged should be unsigned

laravel-reviewable/database/migrations/create_reviews_table.php.stub

Line 20 in b4caaf5

$table->integer('author_id')->unsinged();

Great repo! Just a typo I've found. Should be "unsigned" :)