Download the PHP package datomatic/laravel-enum-collections without Composer
On this page you can find all versions of the php package datomatic/laravel-enum-collections. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download datomatic/laravel-enum-collections
More information about datomatic/laravel-enum-collections
Files in datomatic/laravel-enum-collections
Package laravel-enum-collections
Short Description A package to save a collection of Enums in a Eloquent field and interact with him
License MIT
Homepage https://github.com/datomatic/laravel-enum-collections
Informations about the package laravel-enum-collections
Laravel Enum Collections
A Laravel collection extension to store enums with a useful eloquent field cast and a helper trait.
Take your interaction with enums to the next level.
Compatible with PureEnum
, BackedEnum
and datomatic/laravel-enum-helper
package.
Installation
You can install the package via composer:
The main parts of the package are:
enumCollection
- Eloquent model casting
HasEnumCollections
trait
EnumCollection
EnumCollection
is an extension of base Laravel collection that expand his functionalities to add the compatibility with:
- enum object instance
- enum case name string
- enum case value (only for
BackedEnum
) - enum case (string) value (only for
IntBackedEnum
)
Creating an EnumCollection
You can make enum collection in 4 ways:
from
method throw an ValueError
Exception if an element in $data
is wrong, instead tryFrom
skips bad data without raise exceptions.
$data
can be a single element or a collection
, array
,... of elements.
If $data
contains only Enum elements you can also omit the EnumClass
(the collection take the EnumClass of the first element).
Contains method
toValues method
toValues
method serialize the collection content, if the element is a PureEnum
will be pass the name
of the case, otherwise the value
.
Casting
You can cast a field to be an EnumCollection
.
To use this casting option, you need to set the Eloquent Model properly.
1. Database Migration
2. Model set up
To set up your model you must:
- add a custom cast
AsLaravelEnumCollection::class
with the enumClass as attribute - add an optional
HasEnumCollections
trait to make query on enum collections fields
You can also cast more than one field if you need.
Set the enum collection field
You can set enum collection field passing a single element, a collection or an array of elements.
After the field will become an EnumCollection
.
Database saved data
A serialization of enumCollection is saved in the database, if the element is a PureEnum
will be saved the name
of the case, otherwise the value
.
EnumCollection
Thanks to casting you can interact with field_name
like a normal EnumCollection
with all functionalities showed before.
HasEnumCollections trait
If you include also the HasEnumCollections
into the model, you can query the models with the new where functions whereContains
, orWhereContains
, whereDoesntContain
and orWhereDoesntContain
.
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
- Alberto Peripolli
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-enum-collections with dependencies
spatie/laravel-package-tools Version ^1.13.0
illuminate/contracts Version ^9.0|^10.0|^11.0