keggermont/commentable

Commentable trait for laravel 5.5

Laravel Commentable Trait

Installation

Use Composer :, _(*1)

``` bash $ composer require k-eggermont/laravel-commentable, <sub>(*2)</sub>

Publish the vendor assets:

php artisan vendor:publish --provider="Keggermont\Commentable\CommentableServiceProvider" php artisan migrate, <sub>(*3)</sub>

## Configuration

You can configure the package on /config/laravel-commentable.php

## Usage

### Api

By default, the api is accessible at /api/comments/. You have 3 routes :
* GET /api/comments/{type}/{id} : Get comments
* POST /api/comments/create/{type}/{id} : Create a new comment (data required : title and body)
* DELETE /api/comments/{comment_id} : Delete a comment (if you are the owner, OR if you are an admin (User->is_admin = true))


### Include trait for your model
``` php
<?php

namespace App;

use Keggermont\Commentable\Traits\Commentable;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
    use Commentable;
}

Configure the config/laravel-commentable.php

<?php
$allowType = [
"comment" => \Keggermont\Commentable\Models\Comment::class,
"mymodel" => App\MyModel::class
]

Create a comment from controller / model

``` php $object = MyModel::first();, <sub>(*4)</sub>

$comment = $post->createComment([ 'title' => 'Some title', 'body' => 'Some body', ], Auth::user());, <sub>(*5)</sub>

dd($comment);, <sub>(*6)</sub>

### Update a comment
``` php
$idComment = 1;
$comment = $post->updateComment($idComment, [
    'title' => 'new title',
    'body' => 'new body',
]);

Delete a comment

``` php // From trait : $post->deleteComment(1);, <sub>(*7)</sub>

// From object 'Comment' $comment->delete(); ```, <sub>(*8)</sub>

License

MIT, <sub>(*9)</sub>