beyondcode / laravel-comments
Add comments to your Laravel application
Installs: 331 260
Dependents: 3
Suggesters: 0
Security: 0
Stars: 543
Watchers: 13
Forks: 90
Open Issues: 0
Requires
- php: ^7.2.5|^8.0
- illuminate/support: ~5.6.0|~5.7.0|~5.8.0|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
Requires (Dev)
- orchestra/testbench: ^3.6|^5.0|^6.0|^7.0|^8.0
- phpunit/phpunit: ^7.0|^8.0|9.2.*|^9.5.10
This package is auto-updated.
Last update: 2024-10-11 16:48:38 UTC
README
Add the ability to associate comments to your Laravel Eloquent models. The comments can be approved and nested.
$post = Post::find(1); $post->comment('This is a comment'); $post->commentAsUser($user, 'This is a comment from someone else');
Installation
You can install the package via composer:
composer require beyondcode/laravel-comments
The package will automatically register itself.
You can publish the migration with:
php artisan vendor:publish --provider="BeyondCode\Comments\CommentsServiceProvider" --tag="migrations"
After the migration has been published you can create the media-table by running the migrations:
php artisan migrate
You can publish the config-file with:
php artisan vendor:publish --provider="BeyondCode\Comments\CommentsServiceProvider" --tag="config"
Usage
Registering Models
To let your models be able to receive comments, add the HasComments
trait to the model classes.
namespace App\Models; use Illuminate\Database\Eloquent\Model; use BeyondCode\Comments\Traits\HasComments; class Post extends Model { use HasComments; ... }
Creating Comments
To create a comment on your commentable models, you can use the comment
method. It receives the string of the comment that you want to store.
$post = Post::find(1); $comment = $post->comment('This is a comment from a user.');
The comment method returns the newly created comment class.
Sometimes you also might want to create comments on behalf of other users. You can do this using the commentAsUser
method and pass in your user model that should get associated
with this comment:
$post = Post::find(1); $comment = $post->commentAsUser($yourUser, 'This is a comment from someone else.');
Approving Comments
By default, all comments that you create are not approved - this is just a boolean flag called is_approved
that you can use in your views/controllers to filter out comments that you might not yet want to display.
To approve a single comment, you may use the approve
method on the Comment model like this:
$post = Post::find(1); $comment = $post->comments->first(); $comment->approve();
Auto Approve Comments
If you want to automatically approve a comment for a specific user (and optionally model) you can let your User model implement the following interface and method:
namespace App\Models; use BeyondCode\Comments\Contracts\Commentator; use Illuminate\Foundation\Auth\User as Authenticatable; class User extends Authenticatable implements Commentator { /** * Check if a comment for a specific model needs to be approved. * @param mixed $model * @return bool */ public function needsCommentApproval($model): bool { return false; } }
The needsCommentApproval
method received the model instance that you want to add a comment to and you can either return true
to mark the comment as not approved, or return false
to mark the comment as approved.
Retrieving Comments
The models that use the HasComments
trait have access to it's comments using the comments
relation:
$post = Post::find(1); // Retrieve all comments $comments = $post->comments; // Retrieve only approved comments $approved = $post->comments()->approved()->get();
Nesting Comments
BeyondCode\Comments\Comment
itself implements the HasComments
trait, so you can comment on a comment and therefore nest them:
$comment = BeyondCode\Comments\Comment::first(); $comment->commentAsUser($user, "Hey there!");
Deleting Replies
When you delete a comment, you may optionally want to delete all its nested comments (replies). To optionally enable this feature, set the delete_replies_along_comments
config property in the config/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.
Testing
composer test
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email marcel@beyondco.de instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.