README

Comments是一个Laravel包。通过它，您可以轻松实现应用的原生评论功能。

概览

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

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

特性

• 查看评论
• 创建评论
• 删除评论
• 编辑评论
• 回复评论
• 授权规则
• 支持本地化
• 触发事件
• 路由、控制器、评论、迁移和视图定制
• 支持非整数ID
• 支持多个用户模型
• 解决了N+1查询问题
• 评论批准（可选）
• 访客评论（可选）
• 分页（可选）
• 软删除（可选）
• 支持自定义ID列 [新]

屏幕截图

这里有一些屏幕截图。

无评论 & 访客

无评论 & 登录用户

一条评论

一条评论编辑表单

来自不同用户的两条评论

教程和文章

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

屏幕录制

• 添加评论到您的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

使用方法

在您想要显示评论的视图中放置此代码并修改它

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

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

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

仅查看批准的评论

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

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

分页评论

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

不可能以其他方式完成，因为如果按所有评论（父级和子级）进行分页，您最终会遇到空白页面，因为评论组件首先循环父级评论，然后使用递归进行回复。

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

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

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

事件

此包会触发事件来通知您何时发生某些事情。

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

REST API

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

Route::post('comments', '\Laravelista\Comments\CommentController@store');
Route::delete('comments/{comment}', '\Laravelista\Comments\CommentController@destroy');
Route::put('comments/{comment}', '\Laravelista\Comments\CommentController@update');
Route::post('comments/{comment}', '\Laravelista\Comments\CommentController@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许可证授权。