README

This package is your framework-agnostic Swiss Army knife when it comes to PHP 8.1's native enums. In this package you will find a lot of tools for the most common use cases, and more will be added in the future.

If you have an idea, or you miss something that needs to be added, just let me know.

Enumhancer is case-agnostic, which means Enum equals ENUM equals enum. This is done with the idea that it is useless to have two different enums having the same name and different casing.

It is also type-agnostic. This way you can steer clear as much as possible from the extra work that comes with backed enums.

Note: While most functionality that also exists in Spatie's PHP Enum is made backwards compatible to allow for an easy migration to PHP native enums, currently this is not the case for their laravel package, PHPUnit assertions or Faker Provider.

Installation

You can install the package via composer:

composer require henzeb/enumhancer

Usage

You can simply add the Enhancers trait to your enum in order to use almost all functionality of this package. All features should work with basic enums as well as backed enums' unless stated otherwise.

use Henzeb\Enumhancer\Concerns\Enhancers;

enum YourEnum {
    use Enhancers;

    // ...
}

You can also just use one of the features by using the specific trait for that feature.

Note: all traits can be used next to each other, except for Mappers, which has implemented the methods of Getters, Extractor and Reporters.

Features

Helper functions

Development

Laravel specific Features

Laravel's auto-discovery

When you are installing this package into a laravel project, Enumhancer will automatically set macro's for the validation rules and sets the global Reporter for the getOrReport methods, so that it will use Laravel's Log facade.

If you don't want that to happen, you can tell Laravel not to discover the package.

"extra": {
        "laravel": {
            "dont-discover": [
                "henzeb/enumhancer"
            ]
        }
    }

Testing

composer test

PHPStan integration

If you are using PHPStan for static analysis, you can enable the extension.

Add the following to your projects phpstan.neon:

includes:
- vendor/henzeb/enumhancer/extension.neon

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

Credits

Henze Berkheij

License

The GNU AGPLv. Please see License File for more information.

henzeb / enumhancer

Maintainers

Details