joaorbrandao/phenum

PHP enums made easy.

v0.1.0 2020-12-27 17:30 UTC

Requires

• php: >=7.4

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.16
• phpunit/phpunit: 8.*

MIT

• João Brandão

README

This package creates a simple way of creating PHP enums (one more!). Your IDE will detect them without using DocBlocks. In the end, it's all about PHP constants!

Installing

composer require joaorbrandao/phenum

Usage

Create an Enum

1. Create a class.
2. Extend the Enum class.
3. Use the Enumerable trait.
4. Define PHP constants as needed.

<?php
namespace Acme;

use Joaorbrandao\Phenum\Classes\Enum;
use Joaorbrandao\Phenum\Traits\Enumerable;

class Peripheral extends Enum
{
    use Enumerable;

    const MOUSE = 'mouse';
    const KEYBOARD = 'keyboard';
}

Use it

We're talking about PHP constants, so:

<?php

$mouse = Peripheral::MOUSE;

But in case you need some help like getting all defined values, the first, last, etc:

<?php
$first = Peripheral::first(); // 'mouse'
$last = Peripheral::last(); // 'keyboard'
$exists = Peripheral::exists('mouse'); // true

License

phenum is an open-source package licensed under the MIT license.