myclabs / php-enum
PHP Enum implementation
Installs: 190 240 653
Dependents: 722
Suggesters: 4
Security: 0
Stars: 2 722
Watchers: 32
Forks: 131
Open Issues: 15
Requires
- php: ^7.3 || ^8.0
- ext-json: *
Requires (Dev)
- phpunit/phpunit: ^9.5
- squizlabs/php_codesniffer: 1.*
- vimeo/psalm: ^4.6.2
README
Maintenance for this project is supported via Tidelift.
Why?
First, and mainly, SplEnum
is not integrated to PHP, you have to install the extension separately.
Using an enum instead of class constants provides the following advantages:
- You can use an enum as a parameter type:
function setAction(Action $action) {
- You can use an enum as a return type:
function getAction() : Action {
- You can enrich the enum with methods (e.g.
format
,parse
, …) - You can extend the enum to add new values (make your enum
final
to prevent it) - You can get a list of all the possible values (see below)
This Enum class is not intended to replace class constants, but only to be used when it makes sense.
Installation
composer require myclabs/php-enum
Declaration
use MyCLabs\Enum\Enum; /** * Action enum * * @extends Enum<Action::*> */ final class Action extends Enum { private const VIEW = 'view'; private const EDIT = 'edit'; }
Usage
$action = Action::VIEW(); // or with a dynamic key: $action = Action::$key(); // or with a dynamic value: $action = Action::from($value); // or $action = new Action($value);
As you can see, static methods are automatically implemented to provide quick access to an enum value.
One advantage over using class constants is to be able to use an enum as a parameter type:
function setAction(Action $action) { // ... }
Documentation
__construct()
The constructor checks that the value exist in the enum__toString()
You canecho $myValue
, it will display the enum value (value of the constant)getValue()
Returns the current value of the enumgetKey()
Returns the key of the current value on Enumequals()
Tests whether enum instances are equal (returnstrue
if enum values are equal,false
otherwise)
Static methods:
from()
Creates an Enum instance, checking that the value exist in the enumtoArray()
method Returns all possible values as an array (constant name in key, constant value in value)keys()
Returns the names (keys) of all constants in the Enum classvalues()
Returns instances of the Enum class of all Enum constants (constant name in key, Enum instance in value)isValid()
Check if tested value is valid on enum setisValidKey()
Check if tested key is valid on enum setassertValidValue()
Assert the value is valid on enum set, throwing exception otherwisesearch()
Return key for searched value
Static methods
final class Action extends Enum { private const VIEW = 'view'; private const EDIT = 'edit'; } // Static method: $action = Action::VIEW(); $action = Action::EDIT();
Static method helpers are implemented using __callStatic()
.
If you care about IDE autocompletion, you can either implement the static methods yourself:
final class Action extends Enum { private const VIEW = 'view'; /** * @return Action */ public static function VIEW() { return new Action(self::VIEW); } }
or you can use phpdoc (this is supported in PhpStorm for example):
/** * @method static Action VIEW() * @method static Action EDIT() */ final class Action extends Enum { private const VIEW = 'view'; private const EDIT = 'edit'; }
Native enums and migration
Native enum arrived to PHP in version 8.1: https://www.php.net/enumerations
If your project is running PHP 8.1+ or your library has it as a minimum requirement you should use it instead of this library.
When migrating from myclabs/php-enum
, the effort should be small if the usage was in the recommended way:
- private constants
- final classes
- no method overridden
Changes for migration:
- Class definition should be changed from
/** * @method static Action VIEW() * @method static Action EDIT() */ final class Action extends Enum { private const VIEW = 'view'; private const EDIT = 'edit'; }
to
enum Action: string { case VIEW = 'view'; case EDIT = 'edit'; }
All places where the class was used as a type will continue to work.
Usages and the change needed: