Download the PHP package markbaker/enumhelper without Composer
On this page you can find all versions of the php package markbaker/enumhelper. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download markbaker/enumhelper
More information about markbaker/enumhelper
Files in markbaker/enumhelper
Package enumhelper
Short Description A small library that provides Helper Traits for PHP 8.1 Enums
License MIT
Homepage https://github.com/MarkBaker/EnumHelper
Informations about the package enumhelper
A library of helper traits for working with PHP 8.1 enums
This package provides a series of traits that allows you to:
-
RestorableFromName Trait
Create/restore a PHP 8.1 enum from a name string.
-
EnumValidatableCase
Validate an enum name from a name string.
-
CasesIndexedByName
Similar to the standard static
cases()
method, but returns an associative array, indexed by the case names.
Installation
You can install the package via composer:
Usage
RestorableFromName Trait
In PHP 8.1, it is possible to create a backed enum from a value using the enum's from()
or tryFrom()
methods.
The EnumHelper\EnumRestorableFromName
trait provided in this library adds a fromName()
method to any enum where you want to create an enum from its name, rather than from its value.
An invalid name will throw an exception. Note that names are case-sensitive.
This could be useful if you wanted to store the name in a database for readability (particularly appropriate for unbacked enums); then recreate the enum in the model when you load the database record.
This works with both backed and unbacked enums.
EnumValidatableCase Trait
Useful to validate if a name has been defined in the case set for an enum:
Note that names are case-sensitive.
This works with both backed and unbacked enums.
CasesIndexedByName Trait
While PHP 8.1+ Enums already provide a standard static cases()
method to return a list of all cases defined for that enum:
which returns an enumerated array of the defined cases.
Using the CasesIndexedByName
Trait and the related casesIndexedByName()
method
which will return an associative array of the defined cases, where the array index is the case name.
This can be particularly useful if you filter the cases()
list to return a subset of cases, and don't like the gaps in numeric sequence in the enumerated array.
will return
Changelog
Please see the CHANGELOG for more information on what has changed recently.
License
This library is released under the MIT License (MIT). Please see License File for more information.