Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/artkonekt/enum-eloquent
Enum attribute casting for Eloquent models
https://github.com/artkonekt/enum-eloquent
eloquent-models enum laravel laravel5-package
Last synced: 2 days ago
JSON representation
Enum attribute casting for Eloquent models
- Host: GitHub
- URL: https://github.com/artkonekt/enum-eloquent
- Owner: artkonekt
- License: mit
- Created: 2017-10-05T14:32:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-12T15:05:53.000Z (10 months ago)
- Last Synced: 2025-01-07T04:39:56.693Z (9 days ago)
- Topics: eloquent-models, enum, laravel, laravel5-package
- Language: PHP
- Size: 103 KB
- Stars: 62
- Watchers: 6
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# Konekt Enum Eloquent Bindings
[](https://github.com/artkonekt/enum-eloquent/actions?query=workflow%3Atests)
[](https://packagist.org/packages/konekt/enum-eloquent)
[](https://packagist.org/packages/konekt/enum-eloquent)
[](https://styleci.io/repos/105900484)
[](LICENSE)
This package provides support for auto casting [konekt enum](https://konekt.dev/enum) fields in [Eloquent models](https://laravel.com/docs/9.x/eloquent-mutators).
> Supported Konekt Enum versions are 2.x, 3.x and 4.x with Eloquent (Laravel) 8 - 11
[Changelog](Changelog.md)
## Installation
`composer require konekt/enum-eloquent`
## Usage
1. Add the `CastsEnums` trait to your model
2. Define the attributes to be casted via the `protected $enums` property on the model
### Example
**The Enum:**
```php
namespace App;
use Konekt\Enum\Enum;
class OrderStatus extends Enum
{
const __DEFAULT = self::PENDING;
// const __default = self::PENDING; // usage of default in v2.x
const PENDING = 'pending';
const CANCELLED = 'cancelled';
const COMPLETED = 'completed';
}
```
**The Model:**
```php
namespace App;
use Illuminate\Database\Eloquent\Model;
use Konekt\Enum\Eloquent\CastsEnums;
class Order extends Model
{
use CastsEnums;
protected $enums = [
'status' => OrderStatus::class
];
}
```
**Client code:**
```php
$order = Order::create([
'status' => 'pending'
]);
// The status attribute will be an enum object:
echo get_class($order->status);
// output: App\OrderStatus
echo $order->status->value();
// output: 'pending'
echo $order->status->isPending() ? 'yes' : 'no';
// output: yes
echo $order->status->isCancelled() ? 'yes' : 'no';
// output: no
// You can assign an enum object as attribute value:
$order->status = OrderStatus::COMPLETED();
echo $order->status->value();
// output: 'completed'
// It also works with mass assignment:
$order = Order::create([
'status' => OrderStatus::COMPLETED()
]);
echo $order->status->value();
// output 'completed'
// It still accepts scalar values:
$order->status = 'completed';
echo $order->status->isCompleted() ? 'yes' : 'no';
// output: yes
// But it doesn't accept scalar values that aren't in the enum:
$order->status = 'negotiating';
// throws UnexpectedValueException
// Given value (negotiating) is not in enum `App\OrderStatus`
```
### Resolving Enum Class Runtime
It is possible to defer the resolution of an Enum class to runtime.
It happens using the `ClassName@method` notation known from Laravel.
This is useful for libraries, so you can 'late-bind' the actual enum class and let the user to extend it.
#### Example
**The Model:**
```php
namespace App;
use Illuminate\Database\Eloquent\Model;
use Konekt\Enum\Eloquent\CastsEnums;
class Order extends Model
{
use CastsEnums;
protected $enums = [
'status' => 'OrderStatusResolver@enumClass'
];
}
```
**The Resolver:**
```php
namespace App;
class OrderStatusResolver
{
/**
* Returns the enum class to use as order status enum
*
* @return string
*/
public static function enumClass()
{
return config('app.order.status.class', OrderStatus::class);
}
}
```
This way the enum class becomes configurable without the need to modify the Model code.
## Laravel Collective Forms Compatibility
Laravel Collective [Forms Package](https://laravelcollective.com/docs/master/html) provides the
`Form` facade known from Laravel v4.x.
In case you want to use the Forms package with this one, you need to add the
`EnumsAreCompatibleWithLaravelForms` trait to your model, next to `CastsEnums`.
This will fix a problem where the forms package detects the enum label instead of its actual value
as the value of the field.
It is being done by adding the (undocumented) `getFormValue()` method to the model, that is being
used by the forms library to obtain form field value.
---
Enjoy!
For detailed usage of konekt enums refer to the [Konekt Enum Documentation](https://konekt.dev/enum).