README

Laravel Reportable

此包允许您将完整的报告系统添加到您的 Laravel 应用程序中。

安装

首先，通过 Composer 引入此包。

composer require nicklace/reportable

然后，在 app/config/app.php 中包含服务提供者。

'providers' => [
    Nicklace\Reportable\ReportableServiceProvider::class
];

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

php artisan vendor:publish

并且

php artisan migrate

设置模型

<?php

namespace App;

use Nicklace\Reportable\Contracts\Reportable;
use Nicklace\Reportable\Traits\Reportable as ReportableTrait;
use Illuminate\Database\Eloquent\Model;

class Post extends Model implements Reportable
{
    use ReportableTrait;
}

示例

用户模型报告帖子模型

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;

use App\Post;
use Auth;

class PostController extends Controller
{
    public function makeReport()
    {
        $post = Post::find(1);
        $user = Auth::user();
        
        $post->report([
            'reason' => str_random(10),
            'meta' => ['some more optional data, can be notes or something'],
        ], $user);
    }

为报告创建一个结论，并将用户模型添加为“裁判”（有助于稍后了解谁或什么得出了这个结论）

$report->conclude([
    'conclusion' => 'Your report was valid. Thanks! We\'ve taken action and removed the entry.',
    'action_taken' => 'Record has been deleted.' // This is optional but can be useful to see what happend to the record
    'meta' => ['some more optional data, can be notes or something'],
], $user);

获取报告模型的结论

$report->conclusion;

获取报告模型的裁判（只有当存在结论时才可用）

$report->judge(); // Just a shortcut for $report->conclusion->judge

获取一个包含所有曾经“裁判”过某物的裁判的数组

Report::allJudges();