orkhanahmadov / eloquent-enum-cast
Enum cast for Eloquent
Installs: 1 666
Dependents: 0
Suggesters: 0
Security: 0
Stars: 5
Watchers: 2
Forks: 1
Open Issues: 0
Requires
- php: ^7.3|^8.0
- illuminate/contracts: ^8.0
- illuminate/database: ^8.0
- myclabs/php-enum: ^1.8
Requires (Dev)
- orchestra/testbench: ^6.0
- phpunit/phpunit: ^9.0
README
Simple Enum cast for Eloquent ORM using myclabs/php-enum.
Important!
Since the release of PHP 8.1 this package is no longer maintained!
With PHP 8.1 you should use native enums and as of Laravel v8.71.0 Eloquent has official support to cast from and to native backed enums.
Requirements
- PHP ^7.3 or PHP ^8.0
- Laravel 8.0 or higher
Installation
You can install the package via composer:
composer require orkhanahmadov/eloquent-enum-cast
Usage
Let's say you have following Enum class using myclabs/php-enum.
namespace App\Enums; use MyCLabs\Enum\Enum; class Role extends Enum { private const ADMIN = 1; private const USER = 2; }
To make it Eloquent castable, instead of MyCLabs\Enum\Enum
, extend from Orkhanahmadov\EloquentEnumCast\EnumCast
namespace App\Enums; use Orkhanahmadov\EloquentEnumCast\EnumCast; class Role extends EnumCast { private const ADMIN = 1; private const USER = 2; }
Note:
Orkhanahmadov\EloquentEnumCast\EnumCast
extendsMyCLabs\Enum\Enum
, you can still use any other methods and properties that it has.
Finally, in your Eloquent model cast attribute using your Enum class
use App\Enums\Role; use Illuminate\Database\Eloquent\Model; class User extends Model { protected $casts = [ 'role' => Role::class, ]; }
Now Eloquent will cast raw database values to your App\Enums\Role
enum whenever you retrieve User model from database.
Likewise, whenever you save User model with App\Enums\Role
enum as role
attribute Eloquent will automatically save enum's underlying value into database.
Testing
composer test
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 hi@orkhan.dev instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.