actuallymab/laravel-comment

Just another comment system for laravel projects.

Laravel Comment

![Software License][ico-license] ![Total Downloads][ico-downloads] , _(*1)

Just another comment system for your awesome Laravel project., _(*2)

Version Compatibility

For >5.5 you can use ^1.0.0 version., _(*3)

Install

Via Composer, _(*4)

``` bash $ composer require actuallymab/laravel-comment, <sub>(*5)</sub>

If you don't use auto-discovery, or using Laravel version < 5.5 Add service provider to your app.php file

``` php
\Actuallymab\LaravelComment\LaravelCommentServiceProvider::class

Publish configurations and migrations, then migrate comments table., <sub>(*6)</sub>

``` bash $ php artisan vendor:publish $ php artisan migrate, <sub>(*7)</sub>

Add `CanComment` trait to your User model.

``` php
use Actuallymab\LaravelComment\CanComment;

class User extends Model
{
    use CanComment;

    // ...   
}

Add Commentable interface and HasComments trait to your commentable model(s)., <sub>(*8)</sub>

``` php use Actuallymab\LaravelComment\Contracts\Commentable; use Actuallymab\LaravelComment\HasComments;, <sub>(*9)</sub>

class Product extends Model implements Commentable { use HasComments;, <sub>(*10)</sub>

// ...   

}, <sub>(*11)</sub>

If you want to have your own Comment Model create a new one and extend my Comment model.

``` php
use Actuallymab\LaravelComment\Models\Comment as LaravelComment;

class Comment extends LaravelComment
{
    // ...
}

and dont forget to update the model name in the config/comment.php file., <sub>(*12)</sub>

Comment package comes with several modes., <sub>(*13)</sub>

1- If you want to users can rate your commentable models;, <sub>(*14)</sub>

``` php class Product extends Model implements Commentable { use HasComments;, <sub>(*15)</sub>

public function canBeRated(): bool
{
    return true; // default false
}

//...

}, <sub>(*16)</sub>

2- If you want to approve comments for your commentable models;

``` php
class Product extends Model implements Commentable 
{
    use HasComments;

    public function mustBeApproved(): bool
    {
        return true; // default false
    }

    // ...
}

3- Sometimes you don't want to approve comments for all users;, <sub>(*17)</sub>

``` php class User extends Model { use CanComment;, <sub>(*18)</sub>

protected $fillable = [
    'isAdmin',
    // ..
];

public function canCommentWithoutApprove(): bool
{
    return $this->isAdmin;
}

// ..

}, <sub>(*19)</sub>

## Usage

``` php
$user = App\User::first();
$product = App\Product::first();

// $user->comment(Commentable $model, $comment = '', $rate = 0);
$user->comment($product, 'Lorem ipsum ..', 3);

// approve it -- if the user model `canCommentWithoutApprove()` or you don't use `mustBeApproved()`, it is not necessary
$product->comments[0]->approve();

// get avg rating -- it calculates approved average rate.
$product->averageRate();

// get total comments count -- it calculates approved comments count.
$product->totalCommentsCount();

Tip: You might want to look at the tests/CommentTest.php file to check all potential usages., <sub>(*20)</sub>

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*21)</sub>

Testing

bash $ composer test, <sub>(*22)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*23)</sub>

Security

If you discover any security related issues, please email mehmet.aydin.bahadir@gmail.com instead of using the issue tracker., <sub>(*24)</sub>

Credits

• Mehmet Aydın Bahadır
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*25)</sub>