Laravel Comment

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

Just another comment system for laravel projects., _(*2)

Version Compatibility

Laravel	Laravel Comment
5.0.x	0.1.x
5.1.x	0.1.x
5.2.x	0.1.x
5.3.x	0.2.x
5.4.x	0.3.x
5.5.x	0.4.x

Install

Via Composer, _(*3)

``` bash $ composer require actuallymab/laravel-comment, _(*4)

Laravel 5.5 uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.

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 & Migrate comments table. ``` bash $ php artisan vendor:publish $ php artisan migrate, _(*5)


Add `CanComment` trait to your User model.
``` php
use Actuallymab\LaravelComment\CanComment;

Add Commentable trait to your commentable model(s). ``` php use Actuallymab\LaravelComment\Commentable;, _(*6)


If you want to have your own Comment Model create a new one and extend my Comment model.
``` php
class Comment extends Actuallymab\LaravelComment\Comment
{
  ...
}

Comment package comes with several modes., _(*7)

1- If you want to Users can rate your model(s) with comment set canBeRated to true in your Commentable model. ``` php class Product extends Model { use Commentable;, _(*8)

protected $canBeRated = true;, _(*9)

... }, _(*10)


2- If you want to approve comments for your commentable models, you must set `mustBeApproved` to true in your `Commentable` model.
``` php
class Product extends Model {
  use Commentable;

  protected $mustBeApproved = true;

  ...
}

3- You don't want to approve comments for all users (think this as you really want to approve your own comments?). So add your User model an isAdmin method and return it true if user is admin., _(*11)

``` php class User extends Model { use CanComment;, _(*12)

protected $fillable = [ 'isAdmin', .... ];, _(*13)

public function isAdmin() { return $this->isAdmin; }, _(*14)

... }, _(*15)


## Usage

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

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

// approve it -- if you are admin or you don't use mustBeApproved option, it is not necessary
$product->comments[0]->approve();

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

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