Feature/refactor api #4
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
- Updated tests - Changed internal implementation of keyForValue
lachlankrautz
approved these changes
Sep 21, 2018
Contributor
lachlankrautz
left a comment
lachlankrautz
left a comment
There was a problem hiding this comment.
Agree with all the new names, much "clearer" which is important because it can be used in many contexts
|
|
||
| use Rexlabs\Enum\Enum; | ||
|
|
||
| class Animal extends Enum |
Contributor
There was a problem hiding this comment.
Changing from animals to cities is anthropocentric
| * @throws InvalidKeyException | ||
| */ | ||
| public static function checkExists($key) | ||
| public static function requireValidKey($key) |
| - **Breaking** Change `$instance->identifier` to `$instance->name()` | ||
| - **Breaking** Change `Enum::identifiers()` to `Enum::names()` | ||
| - **Breaking** Change `Enum::getKeyForIdentfier()` to `Enum::keyForName()` | ||
| - **Breaking** Change `Enum::valueFor()` to `Enum::valueForKey()` |
Contributor
There was a problem hiding this comment.
Enum::valueForName() for completeness?
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.
Refactored API as discussed in issue #3
$instance->identifier()to$instance->name()Enum::identifiers()toEnum::names()Enum::getKeyForIdentfier()toEnum::keyForName()Enum::valueFor()toEnum::valueForKey()Enum::nameForKey()to get the constant name for a given keyEnum::exists()toEnum::isValidKey()Enum::checkExists()toEnum::requireValidKey()$instance->key()to handle non-string keys$instance->is()to handle non-string keysself::Enum::instanceFromName($name)to get an instance via name (alternative to Enum::NAME())Enum::instanceFromKey($key)to use array_searchmap()method will return an array of constant keys mapped tonull.Previously it returned an empty array
[]when not overridden. In practice, this may not effect userland code.map()method implementedin your sub-class. This method should be used to map keys to values (if necessary). A default map() method is provided
which maps keys to
nullvalues.Enum::fromValue($val)has been renamed toEnum::keyForValue()Enum::flip()