zoparga/review-rateable

Laravel的评分系统

1.0.0 2021-01-11 15:59 UTC

This package is auto-updated.

Last update: 2024-09-12 00:24:24 UTC


README

首先,通过Composer引入该包。

composer require zoparga/reviewrateable

然后在app/config/app.php中包含服务提供者。(如果使用Laravel 5.5或更高版本,请跳过此步骤)

'providers' => [
    zoparga\ReviewRateable\ReviewRateableServiceProvider::class
];

最后,您需要发布并运行迁移。

php artisan vendor:publish --provider="zoparga\ReviewRateable\ReviewRateableServiceProvider" && php artisan migrate

设置模型

<?php

namespace App;

use zoparga\ReviewRateable\Contracts\ReviewRateable;
use zoparga\ReviewRateable\Traits\ReviewRateable as ReviewRateableTrait;
use Illuminate\Database\Eloquent\Model;

class Post extends Model implements ReviewRateable
{
    use ReviewRateableTrait;
}

创建评分

$user = User::first();
$post = Post::first();

$rating = $post->rating([
    'title' => 'Some title',
    'body' => 'Some body', //optional
    'anonymous' => 1, //optional
    'rating' => 5,
], $user);

dd($rating);

更新评分

$rating = $post->updateRating(1, [
    'title' => 'new title',
    'body' => 'new body', //optional
    'anonymous' => 1, //optional
    'rating' => 3,
]);

删除评分

$post->deleteRating(1);

获取平均评分

$post->averageRating()

$post->averageRating(2) //round to 2 decimal place

统计总评分

$post->countRating()

统计评分元数据(计数和平均值)

$post->ratingMeta()

$post->ratingMeta(2) //round to 2 decimal place

获取评分百分比。

这同样是如何强制执行最大评分值的。

$post->ratingPercent()

$post->ratingPercent(10)); // Ten star rating system
// Note: The value passed in is treated as the maximum allowed value.
// This defaults to 5 so it can be called without passing a value as well.