README.md

Laravel Comments Module

This is RESTful APIs

1. Installation

Install via composer - edit your composer.json to require the package.

"require": {
    // ...
    "php-soft/laravel-comments": "dev-master",
}

Then run composer update in your terminal to pull it in. Once this has finished, you will need to add the service provider to the providers array in your app.php config as follows:

'providers' => [
    // ...
    PhpSoft\ArrayView\Providers\ArrayViewServiceProvider::class,
    PhpSoft\Comments\Providers\CommentServiceProvider::class,
]

2. Migration and Seeding

Now generate the migration:

$ php artisan ps-comments:migrate

It will generate the migration files. You may now run it with the artisan migrate command:

$ php artisan migrate

You will want to publish the config using the following command:

$ php artisan vendor:publish --provider="PhpSoft\Comments\Providers\CommentServiceProvider"

3. Usage

Add routes in app/Http/routes.php

Route::group(['middleware'=>'auth'], function() {

    Route::get('/comments/{url}', '\PhpSoft\Comments\Controllers\CommentController@index')->where('url', '.*');
    Route::post('/comments/{url}', '\PhpSoft\Comments\Controllers\CommentController@store')->where('url', '.*');
    Route::patch('/comments/{id}', '\PhpSoft\Comments\Controllers\CommentController@update');
    Route::delete('/comments/{id}', '\PhpSoft\Comments\Controllers\CommentController@destroy');
});

You can remove middlewares if your application don't require check authenticate and permission!

3. Get comment's user

Sometimes you need to get users' information while viewing other comments. You can easily use it by:

$user = $comment->users();