Download the PHP package erikaraujo/php-enhanced-enums without Composer
On this page you can find all versions of the php package erikaraujo/php-enhanced-enums. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download erikaraujo/php-enhanced-enums
More information about erikaraujo/php-enhanced-enums
Files in erikaraujo/php-enhanced-enums
Package php-enhanced-enums
Short Description Enhanced enum methods for PHP enums
License MIT
Informations about the package php-enhanced-enums
PHP Enhanced Enums
Enhanced Enum methods for PHP Enums
In this package, we have 4 traits: EnhancedEnum
, HasDescription
, HasLabel
and IsSelectArray
. Here are all the methods that each trait provides:
-
EnhancedEnum
parse()
tryParse()
tryFromIgnoringCase()
tryParseIgnoringCase()
getNames()
getValues()
isDefined()
toString()
is()
getBackingType()
getUnderlyingType()
isIntEnum()
isStringEnum()
getRandom()
getCaseByPosition()
tryGetCaseByPosition()
first()
last()
-
HasDescription
getDescription()
getDescriptions()
tryFromDescription()
tryFromDescriptionIgnoringCase()
-
HasLabel
getLabel()
getLabels()
tryFromLabel()
tryFromLabelIgnoringCase()
shouldAutoGenerateLabelFromValue()
- IsSelectArray
asSelectArray()
EnhancedEnum
parse()
This method is simply an alias to the native from()
method. Here's an example:
tryParse()
This method is an improved alias to the tryFrom()
method. The difference here, is that, instead of only having the $value
parameter, it also has a $ignoreCase
boolean parameter to allow the method to ignore the case of the value before parsing it. Here's an example:
tryFromIgnoringCase()
// TODO
tryParseIgnoringCase()
An alias to tryFromIgnoreCase()
.
getNames()
This method returns an array with all the names of the enum cases. Here's an example:
getValues()
This method returns an array with all the values of the enum cases. Here's an example:
isDefined()
This method checks if a given value is defined in the enum. Here's an example:
toString()
This method returns the value of the enum as string - even if it's an integer enum.
is()
TODO: describe
getBackingType()
// TODO: describe
getUnderlyingType()
An alias to getBackingType()
isIntEnum()
Returns if the enum's backing type is an integer.
isStringEnum()
Returns if the enum's backing type is a string.
getRandom()
Returns a random enum case.
getCaseByPosition()
tryGetCaseByPosition()
first()
last()
HasDescription
getDescription()
Returns the description of the given enum
getDescriptions()
Returns an array of all the descriptions
tryFromDescription()
tryFromDescriptionIgnoringCase()
HasLabel
getLabel()
getLabels()
tryFromLabel()
tryFromLabelIgnoringCase()
shouldAutoGenerateLabelFromValue()
protected