kambo/enum

Simple enumeration library

Kambo PHP enum library

, _(*1)

Just another PHP enumeration library, _(*2)

Install

Prefered way to install library is with composer:, _(*3)

composer require kambo/enum

Usage

Enumeration is declared by implementing class Kambo\Enum\Enum and adding class constants:, _(*4)

use Kambo\Enum\Enum;

class Foo extends Enum {
    const BAR = 'bar';
    const QUX = 'qux';
}

Base enum class implement following usefull methods:, _(*5)

toArray convert whole enumeration to array with constant name in key and Enum instance in value, _(*6)

Following example code:, _(*7)

$array = Foo::toArray();
var_dump($array);

Will print:, _(*8)

array(2) {
  'BAR' =>
  string(3) "bar"
  'QUX' =>
  string(3) "qux"
}

There is also alias method called values which just called toArray method., _(*9)

inEnum check if the provided value is in enumeration:, _(*10)

$existInEnum = Foo::inEnum('bar');
// print true as the value exists in enumeration
echo $existInEnum;

$existInEnum = Foo::inEnum('agh');
// print false as the value does not exists in enumeration
echo $existInEnum;

License

The MIT License (MIT), https://opensource.org/licenses/MIT, _(*11)