README

This package simplifies working with Enums by providing convenient functionality for handling keys, values, and combined arrays, including a translate function.

It is particularly useful for binding enums to select or multiselect tags in Laravel Nova, allowing you to manage and use translated values effortlessly.

Installation

You can install the package via composer:

composer require cable8mm/enum-getter

Usage

It can be used for Laravel Nova like this:

use Laravel\Nova\Fields\Badge;

/**
 * @see https://nova.laravel.com/docs/v5/resources/fields#badge-field
 */
Badge::make(__('Status'), 'status')
    ->map(Status::array(value: 'info'))
    ->labels(Status::array()),

use Laravel\Nova\Fields\Select;

/**
 * @see https://nova.laravel.com/docs/v5/resources/fields#select-field
 */
Select::make(__('Status'), 'status')
    ->options(Status::array())
    ->displayUsingLabels(),

use Laravel\Nova\Fields\Status;

/**
 * @see https://nova.laravel.com/docs/v5/resources/fields#status-field
 */
Status::make(__('Status'), 'status')
    ->loadingWhen(Status::loadingWhen())
    ->failedWhen(Status::failedWhen())
    ->displayUsing(function ($value) {
        return Status::{$value}->value() ?? '-';
    }),

In order to make a Nova factory::

// In Nova factory file
public function definition(): array
{
    return [
        'size' => fake()->randomElement(Status::keys()),
    ];
}

How to make use in detail

use Cable8mm\EnumGetter\EnumGetter;

enum Size: string
{
    use EnumGetter;

    case LARGE = 'large';
    case MIDDLE = 'middle';
    case SMALL = 'small';
}

print Size::LARGE->name;         //=> 'LARGE'
print Size::LARGE->key();        //=> 'large'
print Size::LARGE->value;        //=> 'large'
print Size::has('large');        //=> true
print Size::has('larger');       //=> false
print Size::has(value: 'large'); //=> true
print Size::names();             //=> ['LARGE', 'MIDDLE', 'SMALL']
print Size::keys();              //=> ['large', 'middle', 'small']
print Size::values();            //=> ['large', 'middle', 'small']
print Size::array();             //=> ['large'=>'large', 'middle'=>'middle', 'small'=>'small']
print Size::reverse();           //=> ['large'=>'large', 'middle'=>'middle', 'small'=>'small']
print Size::of('LARGE');         //=> Size::LARGE
print Size::from('large');       //=> Size::LARGE

When overriding the value() method to support non-English values,

use Cable8mm\EnumGetter\EnumGetter;

enum Size2: string
{
    use EnumGetter;

    case LARGE = 'large';
    case MIDDLE = 'middle';
    case SMALL = 'small';

    public function value(): string
    {
        return match ($this) {
            self::LARGE => __('large'),     // grand
            self::MIDDLE => __('middle'),   // milieu
            self::SMALL => __('small'),     // petit(e)
        };
    }
}

print Size2::LARGE->name;        //=> 'LARGE'
print Size2::LARGE->key();       //=> 'large'
print Size2::LARGE->value;       //=> 'large'
print Size::has('large');        //=> true
print Size::has('larger');       //=> false
print Size::has(value: 'large'); //=> false
print Size::has(value: 'grand'); //=> true
print Size2::LARGE->value();     //=> 'grand'
print Size2::names();            //=> ['LARGE', 'MIDDLE', 'SMALL']
print Size2::keys();             //=> ['large', 'middle', 'small']
print Size2::values();           //=> ['grand', 'milieu', 'petit(e)']
print Size2::array();            //=> ['large'=>'grand', 'middle'=>'milieu', 'small'=>'petit(e)']
print Size2::reverse();          //=> ['grand'=>'large', 'milieu'=>'middle', 'petit(e)'=>'small']
print Size2::of('LARGE');        //=> Size::LARGE
print Size2::from('large');      //=> Size::LARGE

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 cable8mm@gmail.com instead of using the issue tracker.

Credits

• Sam Lee

License

The MIT License (MIT). Please see License File for more information.