admsys/laravel-comments

Sistema de comentarios simple para aplicaciones Laravel

v1.0.1 2023-08-19 23:50 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Este paquete proporciona un sistema de comentarios simple para aplicaciones Laravel.

Installation

You can install the package via composer:

composer require admsys/laravel-comments

You can publish and run the migrations with:

php artisan vendor:publish --tag="comments-migrations"
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' => \Admsys\Comments\Models\Comment::class,
    'user' => \App\Models\User::class,

];

Usage

Start by using the Admsys\Comments\Concerns\HasComments trait on your model.

use Admsys\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.