christianvizarra/laravel-commentable

Forked from DraperStudio - Commentable Polymorphic Eloquent Models for for Laravel 5

Laravel Commentable

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

Install

Via Composer, _(*2)

``` bash $ composer require christianvizarra/laravel-commentable, <sub>(*3)</sub>

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

``` php
'providers' => [
    DraperStudio\Commentable\ServiceProvider::class
];

At last you need to publish and run the migration., <sub>(*4)</sub>

php artisan vendor:publish --provider="DraperStudio\Commentable\ServiceProvider" && php artisan migrate

Usage

Setup a Model

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

/* * This file is part of Laravel :package_name. * * (c) DraperStudio hello@draperstudio.tech * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */, <sub>(*6)</sub>

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

use DraperStudio\Commentable\Contracts\Commentable; use DraperStudio\Commentable\Traits\Commentable as CommentableTrait; use Illuminate\Database\Eloquent\Model;, <sub>(*8)</sub>

class Post extends Model implements Commentable { use CommentableTrait; }, <sub>(*9)</sub>

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

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

dd($comment);

Create a comment as a child of another comment (e.g. an answer)

``` php $user = User::first(); $post = Post::first();, <sub>(*10)</sub>

$parent = $post->comments->first();, <sub>(*11)</sub>

$comment = $post->comment([ 'title' => 'Some title', 'body' => 'Some body', ], $user, $parent);, <sub>(*12)</sub>

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

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

Delete a comment

``` php $post->deleteComment(1);, <sub>(*14)</sub>

### Count comments an entity has
``` php
$post = Post::first();

dd($post->getCommentCount());

Change log

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

Testing

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

Contributing

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

Security

If you discover any security related issues, please email hello@draperstudio.tech instead of using the issue tracker., <sub>(*18)</sub>

Credits

• DraperStudio
• All Contributors

License

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

commentable

forked of draperstudio/laravel-commentable, <sub>(*20)</sub>