Download the PHP package frameck/awesome-enums without Composer

Awesome Enums

This package provides a make:enum command and a set of traits that extend the functionality of enums

Installation

You can install the package via composer:

Usage

Possible options:

• --type: creates a backed enum, possible values are: int or string
• --force: overwrites if the enum already exists

If no --type option is passed the command will prompt you to make a choice

This command generates the following code:

Then we add the cases

This is already enough to use this package:

The all() method provides a collection of all cases

The details() method provides a collection of all cases with their details

The toArray() method provides the array representation of the details() method

The fromName() method matches the case name and returns you the enum instance

You can call the enum case as a static function

or from an instance

The details() method gives you the the array of details for that specific case

Additionally you can create a function with the camel cased version of the case name (+ Details) that returns an array of details that will be used instead of the default one:

You can also pass an optional key to retrieve only that value

The toSelect() method provides an array of key value pair useful in html selects

The toJson() method provides the json representation of the toSelect() method useful when you have to share data with a frontend in vue, react ecc... or an api:

The is() and isNot() methods provide a fluent way to check if an enum instance is equal to another:

The in() and notIn() methods provide a fluent way to check if an enum instance is present in an array of enums:

To better integrate the enum in a laravel ecosystem you can add it inside the $casts property of the model

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Frameck
• All Contributors
• Steve Barbera post on medium

License

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