Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vjik/php-enum
PHP Enum Implementation
https://github.com/vjik/php-enum
enum php php-enum
Last synced: about 5 hours ago
JSON representation
PHP Enum Implementation
- Host: GitHub
- URL: https://github.com/vjik/php-enum
- Owner: vjik
- License: bsd-3-clause
- Created: 2017-07-14T20:51:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-05-27T06:50:39.000Z (over 3 years ago)
- Last Synced: 2024-10-28T22:47:55.662Z (21 days ago)
- Topics: enum, php, php-enum
- Language: PHP
- Homepage:
- Size: 40 KB
- Stars: 21
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PHP Enum Implementation
[](https://packagist.org/packages/vjik/php-enum)
[](https://packagist.org/packages/vjik/php-enum)
[](https://github.com/vjik/php-enum/actions?query=workflow%3Abuild)
[](https://dashboard.stryker-mutator.io/reports/github.com/vjik/php-enum/master)
[](https://github.com/vjik/php-enum/actions?query=workflow%3A%22static+analysis%22)
The package implement ideas from [RFC Enumerations](https://wiki.php.net/rfc/enumerations) and provide abstract class `Enum` that intended to create
[enumerated objects](https://en.wikipedia.org/wiki/Enumerated_type) with support [extra data](#extradata) and auxiliary static functions [`values()`](#values), [`cases()`](#cases) and [`isValid()`](#isValid).
## Requirements
- PHP 8.0 or higher.
## Installation
The package could be installed with composer:
```shell
composer require vjik/php-enum --prefer-dist
```
## General usage
### Declaration of class
```php
use Vjik\Enum\Enum;
/**
* @method static self NEW()
* @method static self PROCESS()
* @method static self DONE()
*/
final class Status extends Enum
{
private const NEW = 'new';
private const PROCESS = 'process';
private const DONE = 'done';
}
```
### Creating an object
#### By static method `from()`
```php
$process = Status::from('process');
```
On create object with invalid value throws `ValueError`.
#### By static method `tryFrom()`
```php
$process = Status::tryFrom('process'); // Status object with value "process"
$process = Status::tryFrom('not-exists'); // null
```
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.
```php
$process = Status::PROCESS();
```
### Getting value and name
```php
Status::DONE()->getName(); // DONE
Status::DONE()->getValue(); // done
```
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()`.
```php
use Vjik\Enum\Enum;
/**
* @method static self CREATE()
* @method static self UPDATE()
*/
final class Action extends Enum
{
private const CREATE = 1;
private const UPDATE = 2;
protected static function data(): array
{
return [
self::CREATE => [
'tip' => 'Create document',
],
self::UPDATE => [
'tip' => 'Update document',
],
];
}
public function getTip(): string
{
/** @var string */
return $this->getPropertyValue('tip');
}
public function getColor(): string
{
return $this->match([
self::CREATE => 'red',
self::UPDATE => 'blue',
]);
}
public function getCode(): int
{
return $this->match([
self::CREATE => 1,
], 99);
}
}
```
Usage:
```php
echo Action::CREATE()->getTip();
echo Action::CREATE()->getColor();
echo Action::CREATE()->getCode();
```
### Auxiliary static functions
#### List of values `values()`
Returns list of values.
```php
// [1, 2]
Action::values();
```
#### List of objects `cases()`
Returns list of objects:
```php
// [$createObject, $updateObject]
Action::cases();
```
#### Validate value `isValid()`
Check if value is valid on the enum set.
```php
Action::isValid(1); // true
Action::isValid(99); // false
```
### Casting to string
`Enum` support casting to string (using magic method `__toString`). The value is returned as a string.
```php
echo Status::DONE(); // done
```
## Testing
### Unit testing
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
```shell
./vendor/bin/phpunit
```
### Mutation testing
The package tests are checked with [Infection](https://infection.github.io/) mutation framework. To run it:
```shell
./vendor/bin/infection
```
### Static analysis
The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
```shell
./vendor/bin/psalm
```
## License
The PHP Enum implementation is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information.
## Credits
Version 3 of this package is inspired by [`myclabs/php-enum`](https://github.com/myclabs/php-enum).