Download the PHP package schleuse/php-enum without Composer
On this page you can find all versions of the php package schleuse/php-enum. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download schleuse/php-enum
More information about schleuse/php-enum
Files in schleuse/php-enum
Package php-enum
Short Description PHP Enum implementation
License MIT
Homepage http://github.com/myclabs/php-enum
Informations about the package php-enum
Fork of myclabs/php-enum
Backports some fixes for PHP 8.1 compability while also mantaining compability with at least PHP 7.1
PHP Enum implementation inspired from SplEnum
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
Declaration
Usage
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:
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:
toArray()
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 setsearch()
Return key for searched value
Static methods
Static method helpers are implemented using __callStatic()
.
If you care about IDE autocompletion, you can either implement the static methods yourself:
or you can use phpdoc (this is supported in PhpStorm for example):
Related projects
All versions of php-enum with dependencies
ext-json Version *