README

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

概述

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

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

特性

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

屏幕截图

这里有一些屏幕截图。

无评论 & 访客

无评论 & 登录

一条评论

一条评论编辑表单

来自不同用户的两条评论

教程 & 文章

我计划扩展这一章节，增加更多教程和文章。如果你写了一些关于这个包的内容，请告诉我，这样我可以更新这一章节。

屏幕录像带

• 向你的 Laravel 应用程序添加评论 by Andre Madarang。

安装

从命令行

composer require IslamRumon/comments

运行迁移

我们需要创建评论表。

php artisan migrate

向你的用户模型添加 Commenter 特性

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

use IslamRumon\Comments\Commenter;

class User extends Authenticatable
{
    use Notifiable, Commenter;
}

向模型添加 Commentable 特性

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

use IslamRumon\Comments\Commentable;

class Product extends Model
{
    use Commentable;
}

发布配置 & 配置（可选）

发布配置文件（可选）

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

发布视图（定制）

默认 UI 是为 Bootstrap 4 制作的，但你可以随意更改它。

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

发布迁移（定制）

你可以发布迁移以允许你更好地控制你的表

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

发布翻译（定制）

该包目前仅支持英文，但我愿意接受其他语言的 PR。

php artisan vendor:publish --provider="IslamRumon\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
])

事件

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

• IslamRumon\Comments\Events\CommentCreated
• IslamRumon\Comments\Events\CommentUpdated
• IslamRumon\Comments\Events\CommentDeleted

REST API

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

Route::post('comments', '\IslamRumon\Comments\CommentController@store')->name('comments.store');
Route::delete('comments/{comment}', '\IslamRumon\Comments\CommentController@destroy')->name('comments.destroy');
Route::put('comments/{comment}', '\IslamRumon\Comments\CommentController@update')->name('comments.update');
Route::post('comments/{comment}', '\IslamRumon\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做出贡献！贡献指南可在此处找到。

行为准则

为了确保开源社区对所有人均友好，请阅读并遵守行为准则。

许可证

Comments是开源软件，根据MIT许可证授权。