hootlex/laravel-moderation

A simple Content Moderation System for Laravel 5.* that allows you to Approve or Reject resources like posts, comments, users, etc.

Laravel Moderation

A simple Moderation System for Laravel 5.* that allows you to Approve or Reject resources like posts, comments, users, etc., _(*1)

Keep your application pure by preventing offensive, irrelevant, or insulting content., _(*2)

Possible Use Case

1. User creates a resource (a post, a comment or any Eloquent Model).
2. The resource is pending and invisible in website (ex. Post::all() returns only approved posts).

3. Moderator decides if the resource will be approved, rejected or postponed., _(*3)

   1. Approved: Resource is now public and queryable.
   2. Rejected: Resource will be excluded from all queries. Rejected resources will be returned only if you scope a query to include them. (scope: withRejected)
   3. Postponed: Resource will be excluded from all queries until Moderator decides to approve it.

4. You application is clean., _(*4)

Installation

First, install the package through Composer., _(*5)

composer require hootlex/laravel-moderation

If you are using Laravel < 5.5, you need to add Hootlex\Moderation\ModerationServiceProvider to your config/app.php providers array:, _(*6)

'providers' => [
    ...
    Hootlex\Moderation\ModerationServiceProvider::class,
    ...
];

Lastly you publish the config file., _(*7)

php artisan vendor:publish --provider="Hootlex\Moderation\ModerationServiceProvider" --tag=config

Prepare Model

To enable moderation for a model, use the Hootlex\Moderation\Moderatable trait on the model and add the status, moderated_by and moderated_at columns to your model's table., _(*8)

use Hootlex\Moderation\Moderatable;
class Post extends Model
{
    use Moderatable;
    ...
}

Create a migration to add the new columns. (You can use custom names for the moderation columns), _(*9)

Example Migration:, _(*10)

class AddModerationColumnsToPostsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('posts', function (Blueprint $table) {
            $table->smallInteger('status')->default(0);
            $table->dateTime('moderated_at')->nullable();
            //To track who moderated the Model, add 'moderated_by' and set the column name in the config file.
            //$table->integer('moderated_by')->nullable()->unsigned();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('posts', function(Blueprint $table)
        {
            $table->dropColumn('status');
            $table->dropColumn('moderated_at');
            //$table->dropColumn('moderated_by');
        });
    }
}

You are ready to go!, _(*11)

Usage

Note: In next examples I will use Post model to demonstrate how the query builder works. You can Moderate any Eloquent Model, even User., _(*12)

Moderate Models

You can moderate a model Instance:, _(*13)

$post->markApproved();

$post->markRejected();

$post->markPostponed();

$post->markPending();

or by referencing it's id, _(*14)

Post::approve($post->id);

Post::reject($post->id);

Post::postpone($post->id);

or by making a query., _(*15)

Post::where('title', 'Horse')->approve();

Post::where('title', 'Horse')->reject();

Post::where('title', 'Horse')->postpone();

Query Models

By default only Approved models will be returned on queries. To change this behavior check the configuration., _(*16)

To query the Approved Posts, run your queries as always.

//it will return all Approved Posts (strict mode)
Post::all();

// when not in strict mode
Post::approved()->get();

//it will return Approved Posts where title is Horse
Post::where('title', 'Horse')->get();

Query pending or rejected models.

//it will return all Pending Posts
Post::pending()->get();

//it will return all Rejected Posts
Post::rejected()->get();

//it will return all Postponed Posts
Post::postponed()->get();

//it will return Approved and Pending Posts
Post::withPending()->get();

//it will return Approved and Rejected Posts
Post::withRejected()->get();

//it will return Approved and Postponed Posts
Post::withPostponed()->get();

Query ALL models

//it will return all Posts
Post::withAnyStatus()->get();

//it will return all Posts where title is Horse
Post::withAnyStatus()->where('title', 'Horse')->get();

Model Status

To check the status of a model there are 3 helper methods which return a boolean value., _(*17)

//check if a model is pending
$post->isPending();

//check if a model is approved
$post->isApproved();

//check if a model is rejected
$post->isRejected();

//check if a model is rejected
$post->isPostponed();

Strict Moderation

Strict Moderation means that only Approved resource will be queried. To query Pending resources along with Approved you have to disable Strict Moderation. See how you can do this in the configuration., _(*18)

Configuration

Global Configuration

To configuration Moderation package globally you have to edit config/moderation.php. Inside moderation.php you can configure the following:, _(*19)

1. status_column represents the default column 'status' in the database.
2. moderated_at_column represents the default column 'moderated_at' in the database.
3. moderated_by_column represents the default column 'moderated_by' in the database.
4. strict represents Strict Moderation.

Model Configuration

Inside your Model you can define some variables to overwrite Global Settings., _(*20)

To overwrite status column define:, _(*21)

const MODERATION_STATUS = 'moderation_status';

To overwrite moderated_at column define:, _(*22)

const MODERATED_AT = 'mod_at';

To overwrite moderated_by column define:, _(*23)

const MODERATED_BY = 'mod_by';

To enable or disable Strict Moderation:, _(*24)

public static $strictModeration = true;