keggermont/commentable

There is no license information available for the latest version (dev-master) of this package.

Commentable trait for laravel 5.5

dev-master 2018-05-13 09:25 UTC

Requires

• php: ^7.1
• illuminate/database: 5.5.* || 5.6.*
• illuminate/support: 5.5.* || 5.6.*

Requires (Dev)

• phpunit/phpunit: ^6.5

Unknown License

• keggermont

README

Installation

Use Composer :

$ composer require k-eggermont/laravel-commentable

Publish the vendor assets:

php artisan vendor:publish --provider="Keggermont\Commentable\CommentableServiceProvider" 
php artisan migrate

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

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

$object = MyModel::first();

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

dd($comment);

Update a comment

$idComment = 1;
$comment = $post->updateComment($idComment, [
    'title' => 'new title',
    'body' => 'new body',
]);

Delete a comment

// From trait :
$post->deleteComment(1);

// From object 'Comment'
$comment->delete();

License

MIT