Download the PHP package alejandrotrevi/laravel-ankal without Composer
On this page you can find all versions of the php package alejandrotrevi/laravel-ankal. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download alejandrotrevi/laravel-ankal
More information about alejandrotrevi/laravel-ankal
Files in alejandrotrevi/laravel-ankal
Package laravel-ankal
Short Description Super simple statuses for your Laravel Models
License MIT
Homepage https://github.com/alejandrotrevi/laravel-ankal
Informations about the package laravel-ankal
Super simple statuses for your Laravel Models
Sometimes you only need a simple way to manage statuses.
Installation
You can install the package via composer:
Optionally, you can publish the migration included with the library. The included migration is a good place to add the necessary columns to your tables or perhaps remove some columns from existing tables.
Usage
Add the HasStatuses
trait to a model.
Add the necessary migrations to each of the tables on which you will use the statuses.
behind the scenes this basically adds 3 columns: status
, reason
and status_updated_at
.
Optionally you can set a default status for that table, you simply pass an additional argument to the statusColumns()
table modifier this additional argument is the default status the status
column will have when you create a new model.
Set a status
You can set a new status like this:
You can also provide a reason for the status modification.
Since the status exist on the same table you simply call the status as another property on your model.
Scopes
You have 2 scopes available for your models currentStatus
and exceptStatus
.
Without a given status:
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
This package is heavily inspired in the spatie/laravel-model-status package, this aims to be a simpler version of Spatie's solution, every credit should go to them :hugs:
- Alejandro
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
Why Ankal?
Ankal means "To be" in the Mayan language.