Download the PHP package mle86/enum without Composer
On this page you can find all versions of the php package mle86/enum. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package enum
php-enum
This PHP library
provides enum
functionality for PHP 7.1+
with an Enum interface,
an AbstractEnum base class,
and an AbstractAutoEnum base class.
It is released under the MIT License.
Installation and Dependencies:
Via Composer: $ composer require mle86/enum
Or insert this into your project's composer.json
file:
Its only dependency is the mle86/value library.
Minimum PHP Version:
PHP 7.1
Usage:
To implement a custom Enum class, simply extend the AbstractAutoEnum base class and add a few public constants:
For more fine control
over which values are considered valid by your class,
override the isValid()
class method or
extend the more general AbstractEnum base class instead.
Keep in mind though that enum classes
are fundamentally based on
a hardcoded list of accepted values known at compile-time;
if you want to accept values based on a pattern or on complex validation logic,
consider using a value object class
such as Value
instead.
There's three ways to use enum classes:
-
Just use the class constants.
You don't really need this library to do that as you can simply write a standalone class for that, but it's definitely a possibility. -
Build instances and use typehints in your methods.
The AbstractAutoEnum base classes have a default constructor and wraps a single valid enum value in the instance. The wrapped value can then be retrieved with thevalue()
getter but it's also returned by the default__toString()
andjsonSerialize()
methods. - Use the
validate()
andvalidateOptional()
methods to enfore correct types in your methods.
If you don't want to build instances of your enum classes to avoid the object overhead or simply because you receive non-object input values (e.g. from a JSON API), you can also check raw input values with the twovalidate
methods. They will accept both raw values and instances, return void, and throw an EnumValueException if the input is invalid. ThevalidateOptional()
method also accepts NULL values.
An example with instances and enum typehints:
Another example without typehints and more explicit validation:
Classes and Interfaces:
- Enum base interface:
- AbstractEnum base class.
- AbstractAutoEnum base class.
- AutoEnumTrait trait.
- Exception classes.
More Documentation:
- Enum Inheritance – how to extend enum classes.
- Serializability – how Enum instances can be serialized.
- Type Safety – notes about enum value types and typecasting.