clutz88/enum-comparison

A package for adding comparison functions to enum classes

Maintainers

Details

github.com/Clutz88/enum-comparison

Homepage

Source

Issues

Fund package maintenance!
Clutz88

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

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

Requires

  • php: ^8.2

Requires (Dev)

MIT 367a530e2daebbd0f6ecab29583fe84cb2a81e0d

  • Chris Cutts <github.woop@chriscutts.uk>

Clutz88enum-comparison

This package is auto-updated.

Last update: 2025-03-31 15:57:07 UTC

README

Latest Version on Packagist Tests Total Downloads

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

License

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