beyondcode/laravel-comments

Since the BeyondCode\Comments\Comment class itself implements the HasComments trait, you can create replies by calling comment methods on an existing comment instance.

$comment = BeyondCode\Comments\Comment::first();
$comment->commentAsUser($user, "Hey there!");

Install the package using composer to add comment functionality to your Laravel application.

composer require beyondcode/laravel-comments

To enable comment functionality on an Eloquent model, add the BeyondCode\Comments\Traits\HasComments trait to your model class.

namespace App\Models;

use Illuminate\
Database\Eloquent\Model;
use BeyondCode\Comments\Traits\HasComments;

class Post extends Model
{
    use HasComments;
    ...
}

After installation, you must publish the migrations to create the necessary database tables and publish the configuration file to customize behavior.

1. Publish migrations:

php artisan vendor:publish --provider="BeyondCode\Comments\CommentsServiceProvider" --tag="migrations"

2. Run migrations:

php artisan migrate

3. Publish config:

php artisan vendor:publish --provider="BeyondCode\Comments\CommentsServiceProvider" --tag="config"

You can control whether comments need approval by implementing the BeyondCode\Comments\Contracts\Commentator interface on your User model. Implement the needsCommentApproval($model) method to return logic for approval:

• Return true: The comment will be marked as not approved.
• Return false: The comment will be marked as approved.

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; // Returns false to auto-approve
    }
}

To customize the package behavior, publish the configuration file to your application's config directory using the config tag:

php artisan vendor:publish --tag=config

This will create a config/comments.php file.

To create the necessary database schema for comments, publish the migration file using the migrations tag:

php artisan vendor:publish --tag=migrations

This will generate a new migration file in your database/migrations directory named with the current timestamp (e.g., YYYY_MM_DD_HHMMSS_create_comments_table.php).

Models using the HasComments trait can access their comments via the comments relationship. You can use the approved() scope to filter for only approved comments.

$post = Post::find(1);

// Retrieve all comments
$comments = $post->comments;

// Retrieve only approved comments
$approved = $post->comments()->approved()->get();

Use the comment method to create a comment from the current context, or commentAsUser to associate a comment with a specific user model.

• comment(string $content): Creates a comment with the provided text. Returns the newly created Comment instance.
• commentAsUser(Model $user, string $content): Creates a comment associated with the provided user model.

$post = Post::find(1);

// Create a standard comment
$comment = $post->comment('This is a comment from a user.');

// Create a comment on behalf of a specific user
$comment = $post->commentAsUser($user, 'This is a comment from someone else.');

By default, new comments are created with an is_approved flag set to false. To approve a comment, call the approve() method on the Comment model instance.

$post = Post::find(1);
$comment = $post->comments->first();

$comment->approve();