oskarstark/enum-helper

This library provides helpers for several enum operations

1.5.0 2024-09-19 20:02 UTC

Requires

• php: >=8.2

Requires (Dev)

• ergebnis/php-cs-fixer-config: ^5.16
• phpstan/phpstan: ^1.11.8
• phpunit/phpunit: ^9.6.20

MIT

• Oskar Stark

• enum

README

This library provides helpers for several enum operations:

• compare
• to array

It also provides an abstract EnumTestCase.

Installation

composer require oskarstark/enum-helper

Usage

For example, you have the following Enum:

<?php

declare(strict_types=1);

namespace App\Enum;

enum Color: string
{
    case RED = 'red';
    case BLUE = 'blue';
}

You can use the following trait,

<?php

declare(strict_types=1);

namespace App\Enum;

+use OskarStark\Enum\Trait\Comparable;
+use OskarStark\Enum\Trait\ToArray;

enum Color: string
{
+   use Comparable;
+   use ToArray;

    case RED = 'red';
    case BLUE = 'blue';
}

Comparable Trait

This trait gives you the possibility to compare you enum with another one or a collection of enums like the following:

App\Enum\Color::RED->equals(App\Enum\Color::BLUE); // returns false

App\Enum\Color::RED->notEquals(App\Enum\Color::RED); // returns false

    App\Enum\Color::RED->equalsOneOf([
        App\Enum\Color::BLUE,
        App\Enum\Color::RED,
    ]); // returns true

For example, you want to check if a color is a nice color:

<?php

declare(strict_types=1);

namespace App\Enum;

use OskarStark\Enum\Trait\Comparable;
use OskarStark\Enum\Trait\ToArray;

enum Color: string
{
    use Comparable;
    use ToArray;

    case RED = 'red';
    case BLUE = 'blue';
    case GREEN = 'green';
    
    public function isNice(): bool
    {
        return self::equalsOneOf([
            self::BLUE,
            self::GREEN
        ]);
    }
}

App\Enum\Color::RED->isNice(); // returns false
App\Enum\Color::BLUE->isNice(); // returns true

ToArray Trait

This trait gives you the possibility to get an enum as array like the following:

For Backed Enum

App\Enum\Color::toArray(); // returns ['RED' => 'red', 'BLUE' => 'blue']

For Non-Backed Enum

App\Enum\NonBackedEnum::toArray(); // returns ['RED' => 'RED', 'BLUE' => 'BLUE']