try-again-later/multi-backed-enum

A small PHP library for creating enums with cases backed by multiple values.

v0.1.0 2022-06-27 21:46 UTC

Requires

• php: >=8.1.0

Requires (Dev)

• phpunit/phpunit: ^9

MIT

• try-again-later

README

Just a proof of concept and me playing around with PHP 8 attributes.

A small PHP library for creating enums with cases backed by multiple values. Useful when you have a bunch of "backing" values (strings or numbers) all of which identify the same thing.

The interface mimics PHP 8.1.0 backed enums with an addition of method allValues(), which returns a list of all "backing" values.

Installation

Via composer:

$ composer require try-again-later/multi-backed-enum

Example

use TryAgainLater\MultiBackedEnum\{MultiBackedEnum, Values, MakeMultiBacked};

#[MultiBackedEnum]
enum Status
{
  #[Values('on', 'true', 'yes')]
  case ON;

  #[Values('off', 'false', 'no', 'null')]
  case OFF;

  use MakeMultiBacked;
}

// Status::ON
$status = Status::tryFrom('true');

// Throws a ValueError
$status = Status::from('some bad value');

// 'off'
$stringStatus = Status::OFF->value();

// ['on', 'true', 'yes']
$stringStatuses = Status::ON->allValues();