Php Enum Laravel Package

What's Changed

• Fix PHP 8.4 warning by @it-can in https://github.com/myclabs/php-enum/pull/177

New Contributors

• @it-can made their first contribution in https://github.com/myclabs/php-enum/pull/177

Full Changelog: https://github.com/myclabs/php-enum/compare/1.8.4...1.8.5

What's Changed

• Do not export psalm.xml in dist by @simPod in https://github.com/myclabs/php-enum/pull/153
• Add Github Actions CI by @simPod in https://github.com/myclabs/php-enum/pull/154
• document migration to native enums by @drealecs in https://github.com/myclabs/php-enum/pull/158
• Added PHP 8.1 to CI configuration by @grogy in https://github.com/myclabs/php-enum/pull/161
• Fix Shepherd link in README by @szepeviktor in https://github.com/myclabs/php-enum/pull/162
• yii2-enum is abandoned and not supporting anymore by @KartaviK in https://github.com/myclabs/php-enum/pull/163
• Implement Stringable interface on Enum by @jdecool in https://github.com/myclabs/php-enum/pull/160

New Contributors

• @simPod made their first contribution in https://github.com/myclabs/php-enum/pull/153
• @szepeviktor made their first contribution in https://github.com/myclabs/php-enum/pull/162
• @jdecool made their first contribution in https://github.com/myclabs/php-enum/pull/160

Full Changelog: https://github.com/myclabs/php-enum/compare/1.8.3...1.8.4

#147 Fix Psalm annotation

#146 Fix Psalm annotation

Resolve deprecation on PHP 8.1 #145

Added:

• new Enum::from() method as an alternative to the constructor that is more strictly typed, and provides a forward compatible solution with PHP 8.1 enums
• new Enum::assertValidValue() to assert that a value is correct

Psalm annotations have been improved as well.

Thanks @drealecs, @Ocramius, @michaelpetri, @gharlan, @simPod

#129 Performance improvement

Avoid conflicts with Doctrine Annotations by renaming the Psalm [@template](https://github.com/template) annotation into [@psalm-template](https://github.com/psalm-template).

#112 Improved Psalm typing

Psalm has been moved to require-dev ;)

#111 Add Psalm annotations

Fixed #95 with #97: handle inherited enums

• Compatibility with PHP 7.1
• #90 New PHPUnit comparator to help with tests

• #88: require PHP 7.2 + add a return type to the equals() method
• #87: the equals() method now accepts anything as a parameter
• #86: compatibility with php-ds/ext-ds

#84 Require ext-json explicitly in composer.json to avoid bugs when the JSON extension is not installed

#83: It is now possible to create a new Enum instance from another Enum instance

#80 Fix validating key with null value #82 Fix coding style and setup https://prettyci.com

Fix #77 #78: better support for null values in enums.

#75 Performance optimizations

#71 Allow null in the equals() method

• Drop support for PHP 5.3 (only 5.4+ is supported)
• Implement JsonSerializable interface to allow serializing the class to JSON

Remove unneeded file permissions.

Bugfix in the equals() method

Issue: #47 Pull request: #48 Contributed by @peter-gribanov

Example:

class CommandAction extends Enum
{
    const EDIT = 'edit';
}

class AccessRule extends Enum
{
    const EDIT = 'edit';
}

Expected

CommandAction::EDIT()->equals(AccessRule::EDIT()); // false

Actual

CommandAction::EDIT()->equals(AccessRule::EDIT()); // true

#4 #39 #40: new equals() method to compare enums

$enum = MyEnum::FOO();

if ($enum->equals(MyEnum::BAR())) {
    ...
}

It behaves the same as ==:

if ($enum == MyEnum::BAR()) {
    ...
}

It was added because it carries a bit more sense than == which, because it is a loose comparison, is often source of confusion (comparing objects with == is often a no-go for good reasons).

• #36, #37 Small phpdoc improvement for better autocompletion in IDEs

#21 Allow to extend the class to fetch values from somewhere else than the class constants (e.g. a database, file, …)

New static method values(): returns instances of the Enum class of all Enum constants (constant name in key, Enum instance in value).

MyEnum::values()

• Fixed #9 Ability to create invalid enum
• Fixed #13 search() is not type safe

Small performance enhancement.

A bunch of new methods were added in #5:

• $value->getKey() Returns the key of the current value on Enum
• Enum::keys() Returns the names (keys) of all constants in the Enum class
• Enum::isValid() Check if tested value is valid on enum set
• Enum::isValidKey() Check if tested key is valid on enum set
• Enum::search() Return key for searched value

The library is now PSR-4 compliant.