Download the PHP package brunojunior/simple-enum without Composer
On this page you can find all versions of the php package brunojunior/simple-enum. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download brunojunior/simple-enum
More information about brunojunior/simple-enum
Files in brunojunior/simple-enum
Package simple-enum
Short Description Abstract class to simulate enum with label in PHP
License MIT
Informations about the package simple-enum
simple-enum
Abstract class to simulate enum with label in PHP
How to install
How to use
You have to create a class which extends SimpleEnum\Enum
.
The simpliest enum
This enum will automatically generate labels thanks to the constants name. Here, you'll have those labels «First value», «Second value» and «Third value».
A simple enum with defined labels
In this enum, the user want to change default labels.
A more complex enum with extra fonctionnality
In this enum, the user want to change default label and add some extra features.
Available methods
Enum::getList()
This method will return an array with constants value as keys and the associated Enum instance as values.
Enum::getLabels()
This method will return an array with constants value as keys and the label as values. It can be useful for HTML select options.
Enum::getLabelById()
This method will return the label for a specific key.
If the key is unknown it will raise SimpleEnum\UnknownEumException
.
Enum::getInstance()
This method will return an Enum instance for a specific key.
If the key is unknown it will raise SimpleEnum\UnknownEumException
.
enumInstance->getLabel()
This method will return the label of a specific instance.
enumInstance->setLabel($label)
This method allows you to override the default label.
enumInstance->resetLabel()
This method will reset the default label of the instance.
enumInstance->getKey()
This method will return the key of the instance.
enumInstance->is(int $key)
This method will check if the instance has the same key.
enumInstance->equals(Enum $anotherInstance)
This method will check if the two instances have the same key.
How to compare
Using the ==
This way to compare is really simple. You can do something like this :