Download the PHP package vjik/php-enum without Composer
On this page you can find all versions of the php package vjik/php-enum. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vjik/php-enum
More information about vjik/php-enum
Files in vjik/php-enum
Informations about the package php-enum
PHP Enum Implementation
The package implement ideas from RFC Enumerations and provide abstract class Enum
that intended to create
enumerated objects with support isValid()
.
Requirements
- PHP 8.0 or higher.
Installation
The package could be installed with composer:
General usage
Declaration of class
Creating an object
By static method from()
On create object with invalid value throws ValueError
.
By static method tryFrom()
On create object with invalid value returns null
.
By static method with a name identical to the constant name
Static methods are automatically implemented to provide quick access to an enum value.
Getting value and name
Class with extra data
Set data in the protected static function data()
and create getters using the protected method getPropertyValue()
.
Also you can create getter using protected method match()
.
Usage:
Auxiliary static functions
List of values values()
Returns list of values.
List of objects cases()
Returns list of objects:
Validate value isValid()
Check if value is valid on the enum set.
Casting to string
Enum
support casting to string (using magic method __toString
). The value is returned as a string.
Testing
Unit testing
The package is tested with PHPUnit. To run tests:
Mutation testing
The package tests are checked with Infection mutation framework. To run it:
Static analysis
The code is statically analyzed with Psalm. To run static analysis:
License
The PHP Enum implementation is free software. It is released under the terms of the BSD License. Please see LICENSE
for more information.
Credits
Version 3 of this package is inspired by myclabs/php-enum
.