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.
Installation
You can install the package via composer:
composer require markbaker/enumhelper
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.
enum Suit: string
{
case Hearts = 'H';
case Diamonds = 'D';
case Clubs = 'C';
case Spades = 'S';
}
$suit = Suit::Diamonds;
$value = $suit->value; // Returns 'D'
$newSuit = Suit::from($value);
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.
enum Suit: string
{
use EnumHelper\EnumRestorableFromName;
case Hearts = 'H';
case Diamonds = 'D';
case Clubs = 'C';
case Spades = 'S';
}
$suit = Suit::Diamonds;
$suitName = $suit->name; // Returns 'Diamonds'
$newSuit = Suit::fromName($suitName);
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:
enum Suit: string
{
use EnumHelper\EnumValidatableCase;
case Hearts = 'H';
case Diamonds = 'D';
case Clubs = 'C';
case Spades = 'S';
}
$suit = Suit::Diamonds;
$validCaseName = Suit::Hearts;
$isCaseNameValid = Suit::isValidCase($validCaseName); // Returns boolean true
$invalidCaseName = 'HeArTs';
$isCaseNameValid = Suit::isValidCase($invalidCaseName); // Returns boolean false
Note that names are case-sensitive.
This works with both backed and unbacked enums.
Changelog
Please see the CHANGELOG for more information on what has changed recently.
License
This librar is released under the MIT License (MIT). Please see License File for more information.
54 Sep 21, 2022
87 Nov 26, 2022
33 Oct 18, 2022
349 Mar 24, 2022
5 May 31, 2022
24 Dec 25, 2022
17 Jan 20, 2022
88 Dec 23, 2022
35 Dec 13, 2022
921 Dec 18, 2022
3 Apr 14, 2021
3 Feb 10, 2022
3 Jan 16, 2022
8 Aug 19, 2022
3 Nov 3, 2021
9 Jun 2, 2022
2 Oct 16, 2022
6 Aug 4, 2022
1 Jan 5, 2022