Download the PHP package snowpenguinstudios/laravel-model-status without Composer
On this page you can find all versions of the php package snowpenguinstudios/laravel-model-status. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download snowpenguinstudios/laravel-model-status
More information about snowpenguinstudios/laravel-model-status
Files in snowpenguinstudios/laravel-model-status
Package laravel-model-status
Short Description This Laravel package allows the ability to implement a status feature to any Laravel model. This utilizes the polymorphic relationships.
License MIT
Homepage https://github.com/snowpenguinstudios/laravel-model-status
Informations about the package laravel-model-status
Snow Penguin Studios - Laravel Model Status
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:
You can publish and run the migrations with:
You can publish the config file with:
This is the contents of the published config file:
Model Setup
Add status_id to the model table
Add HasStatus Trait to model
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:
Creating a new model-specific status:
Assigning Status To Model
OR
Getting a Models Available Statuses
Provides an array of all statuses (including the statues not assigned to a model) available for a model:
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):
The ability to sort by the Status Order
Default Order will be in ascending order:
Order by order field, ascending.
Order by order field, descending.
Order By a certain Model
OR
Getting Model Status Information
Getting the model's current status
Getting the model's status updates
Getting the model's latest status updates
Future Feature Listing
- Status Ordering
- Assigning Status to multiple Models
- UI Interface to provide CRUD functionality for Status Models
Testing
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
- Peter R Stanley
- All Contributors
License
The MIT License (MIT). Please see License File for more information.