README

为您的 Laravel 应用程序添加评论和评分功能。

安装

您可以通过 composer 安装此包

composer require starfolksoftware/gauge

要安装此包，请运行以下命令

php artisan gauge:install

要禁用迁移，在服务提供者中添加以下内容

Gauge::ignoreMigrations();

要使用不同的 Review 模型

Gauge::useReviewModel('App\\Models\\CoolReviewModel');

要指定 Gauge 使用的用户模型

Gauge::useUserModel('App\\Models\\UserTestModel');

要指定评论表的名称

Gauge::useReviewsTableName('reviews_table');

要启用软删除支持

Gauge::supportsSoftDeletes();

要启用单条评论支持，即每个用户最多只能对一个模型进行一次评论

Gauge::supportsSingleReviews();

要启用团队支持

Gauge::supportsTeams();

要使模型可审查，添加以下 Reviewable 特性

use StarfolkSoftware\Gauge\Reviewable;

class Item extends Model
{
    // ...
    use Reviewable;
    // ...
}

要在可审查模型上创建评论

$branch->review($user, $rating, $comment)

要设置团队支持，将 TeamHasReviews 特性添加到团队模型中

use StarfolkSoftware\Gauge\TeamHasReviews;

class Team extends Model
{
    use TeamHasReviews;

    protected $table = 'teams';
}

要为团队创建评论

$team->reviews()->save([
    //...
]);

要获取团队的评论

$team->reviews

composer test

请参阅变更日志了解最近的变化。

请参阅贡献指南了解详情。

请参阅我们的安全策略了解如何报告安全漏洞。

MIT 许可证（MIT）。请参阅许可证文件了解更多信息。