https://github.com/matthewbdaly/laravel-comments
Comments package for Laravel
https://github.com/matthewbdaly/laravel-comments
comments laravel laravel-5-package php
Last synced: 4 months ago
JSON representation
Comments package for Laravel
- Host: GitHub
- URL: https://github.com/matthewbdaly/laravel-comments
- Owner: matthewbdaly
- License: mit
- Created: 2017-12-06T20:42:12.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-28T12:38:59.000Z (over 7 years ago)
- Last Synced: 2025-08-05T18:52:23.492Z (11 months ago)
- Topics: comments, laravel, laravel-5-package, php
- Language: PHP
- Size: 53.7 KB
- Stars: 8
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# laravel-comments
[](https://travis-ci.org/matthewbdaly/laravel-comments)
[](https://coveralls.io/github/matthewbdaly/laravel-comments?branch=master)
Simple comments system, loosely inspired by Django's comments system. Allows comments to be attached to an object, and allows for them to be flagged by users for moderator attention.
Installation
------------
```
composer require matthewbdaly/laravel-comments
```
You will also need to run `php artisan migrate` to set up the required database tables.
Usage
-----
To allow comments to be attached to an object, add the trait `Matthewbdaly\LaravelComments\Eloquent\Traits\Commentable` to it. The object will then have a `comments` polymorphic relation.
Views
-----
The package includes a view for submitting comments, named `comments::comments`, which can be included in another view as follows:
```php
@include('comments::comments', ['parent' => $post])
```
The value of `parent` must be an instance of the commentable object (eg, a blog post). The view also includes a form for flagging comments.
Obviously, if you prefer you can override this view with your own content.
The package also includes the following views:
* `comments::commentsubmitted`
* `comments::flagsubmitted`
These simply acknowledge receipt of the comment or flag, but are fairly basic and so you should feel free to replace them as you see fit.
Of course there's nothing stopping you creating your own routes and controllers for creating, viewing and flagging comments, and if you wish to build a REST API that allows for adding comments to objects you can just use these models directly:
* `Matthewbdaly\LaravelComments\Eloquent\Models\Comment`
* `Matthewbdaly\LaravelComments\Eloquent\Models\Comment\Flag`
I recommend that you use my repositories, which are as follows:
* `Matthewbdaly\LaravelComments\Contracts\Repositories\Comment`
* `Matthewbdaly\LaravelComments\Contracts\Repositories\Comment\Flag`
These use `matthewbdaly/laravel-repositories` and so implement caching on the decorated repository, making it simple to ensure your models get cached appropriately.
Events
------
You can set up listeners for the following events:
* `Matthewbdaly\LaravelComments\Events\CommentBeingReceived`
Fired before the comment is saved. The package does not validate comments out of the box, but you can use this to validate the comment using whatever method you wish (eg check it with Akismet, check for links), or process it before saving (eg run it through a Markdown parser).
* `Matthewbdaly\LaravelComments\Events\CommentReceived`
Fired when a new comment is submitted. This is useful for creating some sort of notification, such as an SMS, email, push notification etc.
* `Matthewbdaly\LaravelComments\Events\CommentBeingFlagged`
Fired before a comment flag is saved. Useful for processing the flag to amend it before saving it.
* `Matthewbdaly\LaravelComments\Events\CommentFlagged`
This event fires after a comment has been flagged for moderator attention. You can use this event to send whatever notification is most appropriate (eg, email, Slack, SMS).