sunkan / enum
Enum classes
Installs: 13 522
Dependents: 5
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Requires
- php: ^8.0.0
- ext-json: *
Requires (Dev)
- phpstan/phpstan: ^1.10
- phpunit/phpunit: ^9.0
README
Installation
composer require sunkan/enum
Declaration
use Sunkan\Enum\Enum; /** * Action enum */ class Action extends Enum { private const VIEW = 'view'; private const EDIT = 'edit'; }
Usage
$action = Action::fromValue('view'); // or $action = Action::VIEW();
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 type-hint enum values:
function setAction(Action $action) { // ... }
Documentation
__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 Enumis()
Tests whether enum instances are equal (returnstrue
if enum values are equal,false
otherwise)
Static methods:
fromValue()
The named constructor checks 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 setsearch()
Return key for searched value