laravelcity/laravel-comments

This is a package for managing comments

1.0.1 2018-10-21 10:29 UTC

Requires

• myclabs/php-enum: ^1.5

MIT

• saeid hooshyar

• comment
• cms
• comments
• laravel
• laravel-comments
• laravelcity

README

This is a package for managing comments.

Install laravel comments

STEP1:

Run below statements on your terminal :

composer require laravelcity/laravel-comments

STEP2:

add provider and facade in config/app.php

    providers => [
       ...
       Laravelcity\Comments\CommentsServiceProvider::class,
    ],


    aliases => [
       ...
       'Comments' => \Laravelcity\Comments\Facade\Comment::class,
    ]

STEP3:

php artisan vendor:publish --provider=Laravelcity\Comments\CommentsServiceProvider or php artisan vendor:publish

Now you can customize your config in file config/comments.php

STEP4:

    php artisan migrate

STEP5:

please add Laravelcity\Comments\Models\CanComment to user model :

    class User extends Authenticatable
    {
        use CanComment;
        .
        .
        .

STEP6:

please add Laravelcity\Comments\Models\Commentable to Any models that you want to launch for it comments system.

for example added commentable for post model :

    class Post extends Model
    {
        use Commentable;

how to use Comments

define comment method through dependency injection

    protected $comment;
    
     public function __construct()
     {
         $this->comment=Comment::start();
         
         //or
         
         $this->comment=Comment::start(CustomComment::class); //set custom model for comments
     }
    

insert comment

   auth()->user()->comment(
            $model, //for example => App\Models\Posts
            $request->get('content'),
            $request->get('parent'),
            $status // default is pending but change to 'accepted','rejected','pending'
    );
    

get comment

   public function show($id){
        $comment=$this->comment->find($id);
        .
        .
        .
    }
    

get all comments

   public function index(){
        //return all comments
        $comments=$this->comment->all();
        
        // or
      
        //return user comments
        $comments=auth()->user()->comments()->paginate();

        .
        .
        .
    }
    

update comment

    public function update($id){
        $comment=$this->comment->find($id);
        $comment->update(request()->only(['content']));
        .
        .
        .
    }

destroy comment

     public function destroy($id){
        $comment=$this->comment->find($id);
        $comment->delete();
        .
        .
        .
    }

actions to comments

   public function actions()
    {
        try {
            $this->comment->runActions();
            // enter code ..

        }catch (CommentException $e){
            return redirect()->back()->withErrors($e->getMessage());
        }
    }

$this->comment->runActions(); It has four operators

• destroy
• delete
• restore
• status

To run these methods, send the following parameters

• action

  This is a parameter to save selected operator. paramert is string and only => 'destroy','delete','restore','status'

• selection

  This is a parameter to save selected comments to execute operations on them parametr is array,for example => [2,5,8,9]

notes: for run status action must send status value with value input and with one of variables => 'accepted','rejected','pending'

set new model for Comments

must create new model and extend of Laravelcity\Comments\Models\Comments :

    use Laravelcity\Comments\Models\Comments;

    class CustomComment extends Comments
    {

        public function __construct(array $attributes = [])
        {
            parent::__construct($attributes);
        }

    }

and now use the following:

  public function __construct()
    {
        $this->comment=Comment::start(CustomComment::class); //set custom model for comment facade
    }

Note that you can create multiple categories with different models