README

Provide the ability to models to be published.

Features

1. Publish / Unpublish a model.
2. Published models are not considered for any queries by default (adds a global scope).

Installation

composer require mathewparet/requires-publishing

Defining a field to hold publish status in migrations

// define a 'published_at' field of type dateTime and is nullable
$table->requiresPublishing();

or

// define a 'active_at' field of type dateTime and is nullable
$table->requiresPublishing('active_at');

Add the funtionality to your model

// ...
use mathewparet\RequiresPublishing\RequiresPublishing;
// ...
class User extends Authenticatable
{
    // ...
    use RequiresPublishing;
    // ...

    /**
     * To use custom field name for publishing, use the below line. If the below line isn't 
     * defined, the field is assumed to be 'published_at'.
     */
    const PUBLISHED_AT = 'active_at';
}

API referance

This package introduces the below methods:

Events

1. suspending
2. suspneded
3. unsuspending
4. unsuspended