Download the PHP package vicgutt/php-enhanced-enum without Composer
On this page you can find all versions of the php package vicgutt/php-enhanced-enum. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vicgutt/php-enhanced-enum
More information about vicgutt/php-enhanced-enum
Files in vicgutt/php-enhanced-enum
Package php-enhanced-enum
Short Description Enhances PHP's native enums with convenient methods
License MIT
Homepage https://github.com/vicgutt/php-enhanced-enum
Informations about the package php-enhanced-enum
Enhances PHP's native enums with convenient methods
This package provides you with convenient and single purposed traits and interfaces that aims to independently enhance native PHP enums.
The provided traits are:
- VicGutt\PhpEnhancedEnum\Concerns\
HasKeys
- VicGutt\PhpEnhancedEnum\Concerns\
HasValues
- VicGutt\PhpEnhancedEnum\Concerns\
HasEntries
- VicGutt\PhpEnhancedEnum\Concerns\
IsComparable
- VicGutt\PhpEnhancedEnum\Concerns\
Enumerable
The provided interfaces are:
- VicGutt\PhpEnhancedEnum\Contracts\
HasKeysContract
- VicGutt\PhpEnhancedEnum\Contracts\
HasValuesContract
- VicGutt\PhpEnhancedEnum\Contracts\
HasEntriesContract
- VicGutt\PhpEnhancedEnum\Contracts\
IsComparableContract
- VicGutt\PhpEnhancedEnum\Contracts\
EnumerableContract
Note: The Enumerable
trait is a compound of all the available traits and similarly, the EnumerableContract
interface extends all the other interfaces.
Installation
You can install the package via composer:
Usage
As the package only provides you with traits and interfaces to enhance your enums, you will need to make use of the given trait/interface pair for each of your enums.
Example:
From there, you will be able to use any of the provided additional methods.
Traits, interfaces and available methods
We will be using the following example enums throughout this documentation:
Note: The example enums above could each choose to make use of one, all or any of the provided traits and interfaces individually.
HasKeys
Retrieve the enum's case names.
Example:
HasValues
Retrieve the enum's case values.
Example:
Note: For "unit enum"s, as they don't technically have values, the HasValues
trait will use the enum's keys as values. Thefore, the values will always be the same as the keys.
HasEntries
Retrieve the enum's keys and values.
Example:
Note: For "unit enum"s, as they don't technically have values, the HasEntries
trait will use the enum's keys as values. Thefore, the values will always be the same as the keys.
IsComparable::is
Checks if a given value is equal to itself.
Example:
IsComparable::isAny
Checks if any of the given values are equal to itself.
Example:
IsComparable::isAll
Checks if all of the given values are equal to itself.
Example:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
If you're interested in contributing to the project, please read our contributing docs before submitting a pull request.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Victor GUTT
- All Contributors
License
The MIT License (MIT). Please see License File for more information.