Download the PHP package spatie/laravel-model-flags without Composer
On this page you can find all versions of the php package spatie/laravel-model-flags. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spatie/laravel-model-flags
More information about spatie/laravel-model-flags
Files in spatie/laravel-model-flags
Package laravel-model-flags
Short Description Add flags to Eloquent models
License MIT
Homepage https://github.com/spatie/laravel-model-flags
Informations about the package laravel-model-flags
Add flags to Eloquent models
This package offers a trait that allows you to add flags to an Eloquent model. These can be used to quickly save the state of a process, update, migration, etc... to a model, without having to add an additional column using migrations.
It also provides scopes to quickly query all models with a certain flag.
Though there are other usages, the primary use case of this package is to easily build idempotent (aka restartable) pieces of code. For example, when writing an Artisan command that sends a mail to each user. Using flags, you can make sure that when the command is cancelled (or fails) half-way through, in the second invocation, a mail will only be sent to users that haven't received one yet.
No matter how many times you would execute this command, users would only get the mail once.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via Composer:
Behind the scenes, the flags and the relation to a model will be stored in the flags
table.
To create that flags
table, you must publish and run the migrations once with:
Optionally, you can publish the config file with:
This is the contents of the published config file:
Usage
To add flaggable behaviour to a model, simply make it use the Spatie\ModelFlags\Models\Concerns\HasFlags
trait
These functions will become available.
A flag can only exist once for a model. When flagging a model with the same flag again, the updated_at
attribute of the flag will be updated.
You can get the date of the last time a flag was used on a model.
You'll also get these scopes:
To remove a flag from all models in one go, you can delete the flag using the Spatie\ModelFlags\Models\Flag
model.
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
- Freek Van der Herten
- All Contributors
And a special thanks to Caneco for the logo ✨
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-model-flags with dependencies
spatie/laravel-package-tools Version ^1.13.6
illuminate/contracts Version ^9.0|^10.0|^11.0