clutz88/enum-comparison

A package for adding comparison functions to enum classes

v0.0.3 2024-11-29 01:17 UTC

Requires

• php: ^8.2

Requires (Dev)

• laravel/pint: ^1.0
• pestphp/pest: ^3.0
• spatie/ray: ^1.28

MIT

• Chris Cutts

• Clutz88
• enum-comparison

README

Provide functions that can be used in Enums for easy comparisons, such as:

TestEnum::test->equals('test')

Installation

You can install the package via composer:

composer require clutz88/enum-comparison

Usage

Add the trait to your enums

enum TestEnum: string
{
    use HasComparisons;
    
    case test = 'test';
}

Call the provided functions when you want to do a comparison of an Enum value

$value_to_test = 'test';
$enum_value_to_test = TestEnum::test;

TestEnum::test->is($enum_value_to_test); // true
TestEnum::test->is($value_to_test); // false
TestEnum::test->isNot($enum_value_to_test); // false
TestEnum::test->isNot($value_to_test); // true
TestEnum::test->equals($value_to_test); // true
TestEnum::test->equals('testing'); // false
TestEnum::test->notEquals('testing'); // true

$enum_value_to_test->equals($value_to_test); // true

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

• Chris Cutts

License

The MIT License (MIT). Please see License File for more information.