README

Comments 是一个 Laravel 包。使用它，您可以轻松地为您的应用程序实现原生评论。

概述

此包可用于对您应用程序中的任何模型进行评论。

所有评论都存储在一个表中，该表具有内容的多态关系和发表评论的用户的单态关系。

功能

• 查看评论
• 创建评论
• 删除评论
• 编辑评论
• 回复评论
• 授权规则
• 支持多语言
• 触发事件
• 路由、控制器、评论、迁移与视图自定义
• 支持非整数 ID
• 支持多个用户模型
• 解决 N+1 查询问题
• 评论审批（可选）
• 访客评论（可选）
• 分页（可选）
• 软删除（可选）
• 与自定义 ID 列协同工作
• 可选地加载包迁移 [NEW]
• 配置最大缩进级别 [NEW]

截图

这里有一些截图。

无评论 & 访客

无评论 & 登录用户

一条评论

一条评论编辑表单

来自不同用户的两条评论

教程与文章

我计划扩展这一章节，添加更多教程和文章。如果您为此包写了些什么，请让我知道，这样我可以更新这一章节。

屏幕录像

• 添加评论到您的 Laravel 应用程序 由 Andre Madarang。

安装

从命令行

composer require laravelista/comments

运行迁移

我们需要创建评论表。

php artisan migrate

将 Commenter 特性添加到您的 User 模型中

将 Commenter 特性添加到您的 User 模型中，这样您就可以检索用户的评论

use Laravelista\Comments\Commenter;

class User extends Authenticatable
{
    use Notifiable, Commenter;
}

将 Commentable 特性添加到模型中

将 Commentable 特性添加到您希望启用评论的模型中

use Laravelista\Comments\Commentable;

class Product extends Model
{
    use Commentable;
}

发布配置 & 配置（可选）

发布配置文件（可选）

php artisan vendor:publish --provider="Laravelista\Comments\ServiceProvider" --tag=config

发布视图（自定义）

默认 UI 为 Bootstrap 4，但您可以随意更改。

php artisan vendor:publish --provider="Laravelista\Comments\ServiceProvider" --tag=views

发布迁移（自定义）

您可以将迁移发布出来，以便您有更多控制权

php artisan vendor:publish --provider="Laravelista\Comments\ServiceProvider" --tag=migrations

发布翻译（自定义）

该包目前仅支持英文，但我欢迎其他语言的 PR。

php artisan vendor:publish --provider="Laravelista\Comments\ServiceProvider" --tag=translations

用法

在您想要显示评论的视图中，放置此代码并对其进行修改

@comments(['model' => $book])

在上面的示例中，我们将 commentable_type 设置为书籍的类。我们还将 commentable_id 设置为书籍的 id，这样我们就可以知道评论与哪本书相关。幕后，该包会检测是否有任何当前登录的用户。

如果您打开包含上述代码的视图页面，您应该看到一个可用的评论表单。

仅查看已批准的评论

要查看仅批准的评论，请使用此代码

@comments([
    'model' => $book,
    'approved' => true
])

分页评论

分页仅按顶级评论进行分页，这意味着如果您指定每页评论数为1，并且其中一条评论有100条回复，它将显示该评论及其所有回复。

无法以其他方式实现，因为如果按所有评论（父级和子级）进行分页，您将得到空白页面，因为评论组件首先循环父级评论，然后对回复使用递归。

要使用分页，请使用此代码

@comments([
    'model' => $user,
    'perPage' => 2
])

将 2 替换为您想要的任何数字。

配置最大缩进级别

默认情况下，回复可以缩进到三级。之后，它们将在该级别“合并”。

- 0
    - 1
        - 2
            - 3

您可以这样配置最大缩进级别

@comments([
    'model' => $user,
    'maxIndentationLevel' => 1
])

事件

此包会触发事件，以便您知道何时发生某些事情。

• Laravelista\Comments\Events\CommentCreated
• Laravelista\Comments\Events\CommentUpdated
• Laravelista\Comments\Events\CommentDeleted

REST API

要更改控制器或路由，请参阅配置文件。

Route::post('comments', '\Laravelista\Comments\CommentController@store')->name('comments.store');
Route::delete('comments/{comment}', '\Laravelista\Comments\CommentController@destroy')->name('comments.destroy');
Route::put('comments/{comment}', '\Laravelista\Comments\CommentController@update')->name('comments.update');
Route::post('comments/{comment}', '\Laravelista\Comments\CommentController@reply')->name('comments.reply');

POST /comments

请求数据

'commentable_type' => 'required|string',
'commentable_id' => 'required|string|min:1',
'message' => 'required|string'

PUT /comments/{comment}

• {comment} - 评论ID。

请求数据

'message' => 'required|string'

POST /comments/{comment}

• {comment} - 评论ID。

请求数据

'message' => 'required|string'

从旧版本升级（故障排除）

在创建问题之前，请阅读此文档。

赞助商和资助者

我要感谢以下赞助商和资助者，感谢他们支持我的开源之旅。如果您有兴趣成为赞助商或资助者，请访问资助者页面。

贡献

感谢您考虑为评论贡献！贡献指南可在此处找到。

行为准则

为了确保开源社区对所有人均持欢迎态度，请查阅并遵守行为准则。

许可

Comments 是基于MIT 许可的开源软件。