ryangjchandler / laravel-comments
A dead-simple comments package for Laravel.
Installs: 10 658
Dependents: 0
Suggesters: 0
Security: 0
Stars: 215
Watchers: 3
Forks: 16
Open Issues: 2
Requires
- php: ^8.2
- illuminate/contracts: ^11.0
- illuminate/database: ^11.0
- spatie/laravel-package-tools: ^1.16.3
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.8
- nunomaduro/collision: ^8.0
- orchestra/testbench: ^9.0
- pestphp/pest: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpunit/phpunit: ^10.0
- spatie/laravel-ray: ^1.35
This package is auto-updated.
Last update: 2024-10-29 09:28:17 UTC
README
This package provides an incredibly simple comment system for your Laravel applications.
If you're looking for a package with UI components, I highly recommend using Spatie's
laravel-comments
package which comes with Livewire support out of the box.
Installation
You can install the package via Composer:
composer require ryangjchandler/laravel-comments
The package automatically registers migrations so there's no need to publish anything, just run them.
php artisan migrate
You can publish the config file with:
php artisan vendor:publish --tag="comments-config"
This is the contents of the published config file:
return [ 'model' => \RyanChandler\Comments\Models\Comment::class, 'user' => \App\Models\User::class, ];
Usage
Start by using the RyanChandler\Comments\Concerns\HasComments
trait on your model.
use RyanChandler\Comments\Concerns\HasComments; class Post extends Model { use HasComments; }
This trait adds a comments(): MorphMany
relationship on your model. It also adds a new comment()
method that can be used to quickly add a comment to your model.
$post = Post::first(); $post->comment('Hello, world!');
By default, the package will use the authenticated user's ID as the "commentor". You can customise this by providing a custom User
to the comment()
method.
$post->comment('Hello, world!', user: User::first());
The package also supports parent -> children
relationships for comments. This means that a comment can belongTo
another comment.
$post->comment('Thanks for commenting!', parent: Comment::find(2));
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.