ghanem / reportable
Reportable Polymorphic Eloquent Models for Laravel 6 & 7
Installs: 7 506
Dependents: 0
Suggesters: 0
Security: 0
Stars: 32
Watchers: 4
Forks: 8
Open Issues: 2
Requires
- php: >=7.2.0
- illuminate/support: ^6.0 | ^7.0 | ^8.0 | ^9.0
This package is auto-updated.
Last update: 2024-11-24 10:52:16 UTC
README
Laravel Reportable
This package will allow you to add a full report system into your Laravel application.
Installation
First, pull in the package through Composer.
composer require ghanem/reportable
And then include the service provider within app/config/app.php
.
'providers' => [ Ghanem\Reportable\ReportableServiceProvider::class ];
At last you need to publish and run the migration.
php artisan vendor:publish --provider="Ghanem\Reportable\ReportableServiceProvider"
and
php artisan migrate
Setup a Model
<?php namespace App; use Ghanem\Reportable\Contracts\Reportable; use Ghanem\Reportable\Traits\Reportable as ReportableTrait; use Illuminate\Database\Eloquent\Model; class Post extends Model implements Reportable { use ReportableTrait; }
Examples
The User Model reports the Post Model
<?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); }
Create a conclusion for a Report and add the User Model as "judge" (useful to later see who or what came to this conclusion)
$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);
Get the conclusion for the Report Model
$report->conclusion;
Get the judge for the Report Model (only available if there is a conclusion)
$report->judge(); // Just a shortcut for $report->conclusion->judge
Get an array with all Judges that have ever "judged" something
Report::allJudges();