README

This Laravel package allows the ability to implement a status feature to any Laravel model. This utilizes the polymorphic relationships. The package features includes:

Setting and updating status on any model with a status_id field.
Store status change history as status updates.
Ability to assign statuses to be available to specific models. A status can be available for all models or one model.

Installation

You can install the package via composer:

composer require snowpenguinstudios/laravel-model-status

You can publish and run the migrations with:

php artisan vendor:publish --provider="SnowPenguinStudios\LaravelModelStatus\LaravelModelStatusServiceProvider" --tag="laravel-model-status-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --provider="SnowPenguinStudios\LaravelModelStatus\LaravelModelStatusServiceProvider" --tag="laravel-model-status-config"

This is the contents of the published config file:

return [
];

Model Setup

Add status_id to the model table

Schema::table('table-name', function (Blueprint $table) {
    $table->foreignId('status_id');
});

Add HasStatus Trait to model

use SnowPenguinStudios\LaravelModelStatus\Traits\HasStatus;

class ModelName extends Model {
    use HasStatus;
    
    ...
}

Usage

Working With The Status Model

The following attributes are allowed to be set for mass assignment: model, name, description, is_default, is_active and order.

Creating a global status:

use SnowPenguinStudios\LaravelModelStatus\Models\Status;
$status = Status::create([
    'name' => 'New',
    'is_active' => true
]);

Creating a new model-specific status:

use SnowPenguinStudios\LaravelModelStatus\Models\Status;
$status = Status::create([
    'name' => 'New',
    'model' => ModelName::class,
    'is_active' => true
]);

Assigning Status To Model

...
$model->status_id = $status->id;
... 
$model->save();

// This will work for create() as well...
$model->update([
    ...
    'status_id' => $status->id,
    ...
]);

Getting a Models Available Statuses

Provides an array of all statuses (including the statues not assigned to a model) available for a model:

$availableStatuses = DataModdel::availableStatuses();

Provides the default status for a model (note that if a Model specific and non-model specific status has a default, the model specific will be default):

$defaultStatus = DataModdel::defaultStatus();

The ability to sort by the Status Order

Default Order will be in ascending order:

$orderedStatuses = Status::order()->get();

Order by order field, ascending.

$orderedStatuses = Status::order('asc')->get();

Order by order field, descending.

$orderedStatuses = Status::order('desc')->get();

Order By a certain Model

    $orderedStatuses = Status::where('model', DataModel::class)->order()->get();

    $orderedAscStatuses = DataModel::availableStatuses('asc');
    $orderedDescStatuses = DataModel::availableStatuses('desc');

Getting Model Status Information

Getting the model's current status

$model->status;
// Returns the status model object

Getting the model's status updates

$model->status_updates;
// Returns a Collection of status update model

Getting the model's latest status updates

$model->latestStatusUpdate();
// Returns the latest, in sequence, status update model object.

Future Feature Listing

Status Ordering
Assigning Status to multiple Models
UI Interface to provide CRUD functionality for Status Models

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

snowpenguinstudios / laravel-model-status

Maintainers

Details