tobischulz / laravel-commentable
Commentable Polymorphic Eloquent Models for for Laravel
7.0.0
2024-02-12 13:02 UTC
Requires
- php: ^8.2
- illuminate/database: ^10.0
- illuminate/support: ^10.0
Requires (Dev)
- mockery/mockery: ^1.4
- orchestra/testbench: 8.2
- phpunit/phpunit: ^9.0
README
Installation
Require this package, with Composer, in the root directory of your project.
$ composer require artisanry/commentable
To get started, you'll need to publish the vendor assets and migrate:
php artisan vendor:publish --provider="Artisanry\Commentable\CommentableServiceProvider" && php artisan migrate
Usage
Setup a Model
<?php namespace App; use Artisanry\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@basecode.sh. All security vulnerabilities will be promptly addressed.
Credits
This project exists thanks to all the people who contribute.
License
Mozilla Public License Version 2.0 (MPL-2.0).