🛠
Native enum utilities you always need
This library provides a collection of native enum utilities (traits) which you almost always need in every PHP project.
Installation
You can install the package via composer:
composer require dive-be/php-enum-utils
Usage
Assume the following string backed enum:
enum Role: string
{
case Administrator = 'admin';
case Auditor = 'audit';
case Moderator = 'mod';
}
Arrayable (backed enums only)
Allows you to retrieve a key-value pair of names and values:
Role::toArray(); // ['Administrator' => 'admin', 'Auditor' => 'audit', 'Moderator' => 'mod']
Assertable
This relies on the enum names being in PascalCase, which is also recommended by the official PHP docs.
Allows you to make assertions on enum instances using predicate functions:
$role = Role::Moderator;
$role->isAuditor(); // false
$role->isModerator(); // true
Comparable
Allows you to compare enums. Mostly useful when providing backed values:
$role = Role::Administrator;
$role->equals('admin'); // true
$role->equals(Role::Administrator); // true
$role->equals('mod'); // false
$role->equals(Role::Moderator); // false
$role->equalsAny(['admin', 'mod', 'audit']); // true
$role->equalsAny([Role::Administrator, Role::Auditor]); // true
$role->equalsAny([Role::Moderator, 'audit']); // false
NameListable
Allows you to retrieve a list of the enum names:
Role::toNames(); // ['Administrator', 'Auditor', 'Moderator']
ValueListable (backed enums only)
Allows you to retrieve a list of the enum values:
Role::toValues(); // ['admin', 'audit', 'mod']
WithUtilities (backed enums only)
Aggregator trait for all of the aforementioned utilities.
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
40 Nov 20, 2022
52 Jan 1, 2023
1.1k Dec 21, 2022
16 Dec 20, 2022
5 Jul 19, 2022
1.7k Dec 27, 2022
55 Jan 3, 2023
5 Oct 7, 2022
17 Sep 12, 2022
786 Dec 30, 2022
2 Jun 6, 2022
1 Jan 7, 2022
2 Sep 29, 2022
5 Dec 2, 2022
5 Jun 9, 2023
5 May 29, 2023
13 Nov 11, 2022
5 Apr 17, 2022