dfox288 / commentable
Commentable Polymorphic Eloquent Models for for Laravel. This is fork from artisanry/commentable as it's abandoned
10.0.0
2023-02-28 11:01 UTC
Requires
- php: ^8.1
- illuminate/database: ^5.8|^6.0|^7.0|^8.0|^9.0|^10.0
- illuminate/support: ^5.8|^6.0|^7.0|^8.0|^9.0|^10.0
- kalnoy/nestedset: ^6.0
Requires (Dev)
- graham-campbell/testbench: ^5.0
- mockery/mockery: ^1.0
- phpunit/phpunit: ^8.2
This package is not auto-updated.
Last update: 2025-02-25 20:26:38 UTC
README
Installation
Require this package, with Composer, in the root directory of your project.
$ composer require coliving/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).