blok / laravel-commentable
A comment helper package for Laravel 5
1.2.1
2022-05-25 10:43 UTC
Requires
- php: ^7.1|^7.2|^7.4|^8.0
- kalnoy/nestedset: ^4.1|^5.1|^6.0
This package is auto-updated.
Last update: 2024-11-25 16:49:47 UTC
README
Installation
Require this package, with Composer, in the root directory of your project.
$ composer require blok/laravel-commentable
To get started, you'll need to publish the vendor assets and migrate:
php artisan vendor:publish --provider="Blok\Commentable\CommentableServiceProvider" && php artisan migrate
Usage
Setup a Model
<?php
namespace App;
use Blok\Commentable\Traits\HasComments;
use Illuminate\Database\Eloquent\Model;
class Post extends Model
{
use HasComments;
}
Create a comment
$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)
$user = User::first();
$post = Post::first();
$parent = $post->comments->first();
$comment = $post->comment([
'title' => 'Some title',
'body' => 'Some body',
], $user, $parent);
dd($comment);
Update a comment
$comment = $post->updateComment(1, [
'title' => 'new title',
'body' => 'new body',
]);
Delete a comment
$post->deleteComment(1);
Count comments an entity has
$post = Post::first();
dd($post->commentCount());
Testing
$ phpunit
Security
If you discover a security vulnerability within this package, please send an e-mail to hello@brianfaust.me. All security vulnerabilities will be promptly addressed.