nasyrov/laravel-enums

Laravel package for Enum implementation.

Laravel Enums

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Laravel package for Enum implementation., _(*2)

Requirements

Make sure all dependencies have been installed before moving on:, _(*3)

• PHP >= 7.0
• Composer

Install

Pull the package via Composer:, _(*4)

``` bash $ composer require nasyrov/laravel-enums, <sub>(*5)</sub>

Register the service provider in `config/app.php`:

``` php
'providers' => [
    ...
    Nasyrov\Laravel\Enums\EnumServiceProvider::class,
    ...
]

Usage

Generate a new enum class via the command:, <sub>(*6)</sub>

``` bash $ php artisan make:enum UserStatusEnum, <sub>(*7)</sub>

Define the enum constants:

``` php
/**
 * @method static UserStatusEnum ACTIVE()
 * @method static UserStatusEnum INACTIVE()
 */
class UserStatusEnum extends Enum
{
    const ACTIVE = 10;
    const INACTIVE = 20;
}

To use the enum new up the instance or simply call via the static methods:, <sub>(*8)</sub>

``` php $status = new UserStatusEnum(UserStatusEnum::ACTIVE); $status = UserStatusEnum::ACTIVE();, <sub>(*9)</sub>

Type-hint the model accessor:

``` php
public function getStatusAttribute($attribute) {
    return new UserStatusEnum($attribute);
}

Type-hint the model mutator:, <sub>(*10)</sub>

``` php public function setStatusAttribute(UserStatusEnum $attribute) { $this->attributes['status'] = $attribute->getValue(); }, <sub>(*11)</sub>

Validation:

``` php
$this->validate($request, [
    'status' => [
        'required',
        Rule::in(UserStatusEnum::values()),
    ],
]);

Localization:, <sub>(*12)</sub>

``` php use Nasyrov\Laravel\Enums\Enum as BaseEnum;, <sub>(*13)</sub>

abstract class Enum extends BaseEnum { /** * Get the enum labels. * * @return array */ public static function labels() { return static::constants() ->flip() ->map(function ($key) { // Place your translation strings in resources/lang/en/enum.php return trans(sprintf('enum.%s', strtolower($key))); }) ->all(); } }, <sub>(*14)</sub>

``` blade
<select name="status">
    @foreach (UserStatusEnum::labels() as $value => $label)
        <option value="{{ $value }}">
            {{ $label }}
        </option>
    @endforeach
</select>

Testing

bash $ composer lint $ composer test, <sub>(*15)</sub>

Security

If you discover any security related issues, please email inasyrov@ya.ru instead of using the issue tracker., <sub>(*16)</sub>

Credits

• Evgenii Nasyrov
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*17)</sub>