diff --git a/README.md b/README.md index 3296d3c..fd1135c 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ php artisan vendor:publish --provider="BeyondCode\Comments\CommentsServiceProvid To let your models be able to receive comments, add the `HasComments` trait to the model classes. -``` php +```php namespace App\Models; use Illuminate\Database\Eloquent\Model; @@ -146,10 +146,36 @@ $comment = BeyondCode\Comments\Comment::first(); $comment->commentAsUser($user, "Hey there!"); ``` +#### Deleting Replies + +When you delete a comment, you may optionally want to delete all it's nested comments (replies). To do optionally enable this feature, set the `delete_replies_along_comments` config property in the `configs/comments.php` file to `true`. + +### Events + +When a new comment is added the `BeyondCode\Comments\Events\CommentAdded` event will be dispatched. +When a comment is deleted the `BeyondCode\Comments\Events\CommentDeleted` event will be dispatched. +you can listen to these event and do other things as your requirements call for. + +_App\Providers\EventServiceProvider_ + +```php +use BeyondCode\Comments\Events\CommentAdded; +use BeyondCode\Comments\Events\CommentDeleted; +use App\Listeners\InformAdmin; + +protected $listen = [ + CommentAdded::class => [ + InformAdmin::class, + ], + CommentDeleted::class => [ + InformAdmin::class, + ], +]; +``` ### Testing -``` bash +```bash composer test ``` @@ -167,8 +193,8 @@ If you discover any security related issues, please email marcel@beyondco.de ins ## Credits -- [Marcel Pociot](https://github.com/mpociot) -- [All Contributors](../../contributors) +- [Marcel Pociot](https://github.com/mpociot) +- [All Contributors](../../contributors) ## License diff --git a/config/config.php b/config/config.php index 1bfbdde..57cf44a 100644 --- a/config/config.php +++ b/config/config.php @@ -19,4 +19,4 @@ return [ * Determines if replies will be deleted when comments are deleted */ 'delete_replies_along_comments' => false, -]; \ No newline at end of file +]; diff --git a/src/Events/CommentAdded.php b/src/Events/CommentAdded.php index fbfd42b..a03c59a 100644 --- a/src/Events/CommentAdded.php +++ b/src/Events/CommentAdded.php @@ -19,4 +19,4 @@ class CommentAdded implements ShouldDispatchAfterCommit public Comment $comment, ) { } -} \ No newline at end of file +}