cybercog / laravel-eloquent-flag
Laravel Eloquent boolean & timestamp flagged attributes behavior.
Fund package maintenance!
paypal.me/antonkomarev
Installs: 12 608
Dependents: 0
Suggesters: 0
Security: 0
Stars: 133
Watchers: 7
Forks: 21
Open Issues: 8
Requires
- php: ^8.0
- illuminate/database: ^9.0|^10.0|^11.0
Requires (Dev)
- mockery/mockery: ^1.0
- orchestra/testbench: ^7.0|^8.0|^9.0
- phpunit/phpunit: ^9.6|^10.5
This package is auto-updated.
Last update: 2024-10-09 19:01:40 UTC
README
Introduction
Eloquent boolean & timestamp flagged attributes behavior. Enhance Eloquent Models with commonly used state flags like Active
, Published
, Approved
and others in a minutes!
Contents
- Features
- Available flags list
- How it works
- Installation
- Usage
- Changelog
- Upgrading
- Contributing
- Testing
- Security
- Contributors
- Alternatives
- License
- About CyberCog
Features
- Designed to work with Laravel Eloquent models.
- Each model can have many flags.
- Each flag adds global query scopes to models.
- 2 logical groups of flags:
Classic
,Inverse
. - 2 types of flags:
Boolean
,Timestamp
. - Flag fields auto-casting to
bool
&DateTime
. - Following PHP Standard Recommendations:
- Covered with unit tests.
Available flags list
Any entity can has more than one flag at the same time. If flags can't work for the same entity simultaneously they are listed in Conflict
column.
How it works
Eloquent Flag is an easy way to add flagged attributes to eloquent models. All flags has their own trait which adds global scopes to desired entity.
There are 2 types of flags:
Boolean
flags are the common ones. Stored in database asBOOLEAN
orTINYINT(1)
value.Timestamp
flags represented in database as nullableTIMESTAMP
column. Useful when you need to know when action was performed.
All flags separated on 2 logical groups:
Classic
flags displays only entities withtrue
ortimestamp
flag value by default.Inverse
flags displays only entities withfalse
ornull
flag value by default.
Omitted entities could be retrieved by using special global scope methods, unique for each flag.
Example: If your
Article
model hasPublishedAt
flag thenArticle::get()
will return you only published records. When you need to get only unpublished records you could callArticle::onlyUnpublished()->get()
andArticle::withUnpublished()->get()
will return you published and unpublished articles as well.
Helper traits will automatically cast flag attributes to a DateTime
/ Carbon
instance or bool
for you.
Installation
Pull in the package through Composer.
composer require cybercog/laravel-eloquent-flag
Usage
Usage examples described in Wiki
Changelog
Please see CHANGELOG for more information on what has changed recently.
Upgrading
Please see UPGRADING for detailed upgrade instructions.
Contributing
Please see CONTRIBUTING for details.
Testing
Run the tests with:
vendor/bin/phpunit
Security
If you discover any security related issues, please email open@cybercog.su instead of using the issue tracker.
Contributors
Eloquent Flag contributors list
Alternatives
Feel free to add more alternatives as Pull Request.
License
Laravel Eloquent Flag
package is open-sourced software licensed under the MIT license by Anton Komarev.Clock
image licensed under Creative Commons 3.0 by Rudez Studio.
About CyberCog
CyberCog is a Social Unity of enthusiasts. Research the best solutions in product & software development is our passion.