Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beyondcode/laravel-comments
Add comments to your Laravel application
https://github.com/beyondcode/laravel-comments
comments laravel
Last synced: 6 days ago
JSON representation
Add comments to your Laravel application
- Host: GitHub
- URL: https://github.com/beyondcode/laravel-comments
- Owner: beyondcode
- License: mit
- Created: 2018-09-03T11:22:42.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-13T16:03:38.000Z (8 months ago)
- Last Synced: 2024-03-14T17:19:05.077Z (8 months ago)
- Topics: comments, laravel
- Language: PHP
- Homepage: https://beyondco.de
- Size: 21.5 KB
- Stars: 485
- Watchers: 13
- Forks: 89
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Add comments to your Laravel application
[](https://packagist.org/packages/beyondcode/laravel-comments)
[](https://packagist.org/packages/beyondcode/laravel-comments)
Add the ability to associate comments to your Laravel Eloquent models. The comments can be approved and nested.
```php
$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:
```bash
composer require beyondcode/laravel-comments
```
The package will automatically register itself.
You can publish the migration with:
```bash
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:
```bash
php artisan migrate
```
You can publish the config-file with:
```bash
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.
```php
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.
```php
$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:
```php
$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:
```php
$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:
```php
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:
```php
$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:
```php
$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
```bash
composer test
```
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Marcel Pociot](https://github.com/mpociot)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.