feat: resolve a BackedEnum case by name (fromName/tryFromName)#1
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Native
BackedEnumonly offersfrom()/tryFrom(), which resolve a case by its backing value. There is no built-in way to resolve a case by its name (the case identifier), so callers hand-roll acases()loop whenever they hold a name string from config, serialized data, a CLI argument or a route parameter.This PR adds the symmetric pair, mirroring the native API:
fromName(string $name): static— throws\ValueErroron an unknown name.tryFromName(string $name): ?static— returnsnullon an unknown name.Both are added to
ExtendedBackedEnum(trait) andExtendedBackedEnumInterface. Consumers using the trait get the implementation for free.Also in this PR
K2gl\Enum\src\…,K2gl\Enum\Types\…); corrected to the realK2gl\Enum\…paths so the snippet actually compiles.Tests
New
FromNameTest/TryFromNameTestcover valid names, unknown names, case-sensitivity and the "backing value is not a name" case for both string- and int-backed enums. Full gate green: PHPUnit (57 tests), PHPStan level 9, Pint.