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
@@ -16,6 +16,76 @@ Help us out by testing this project in the [staging environment][link-staging].
If you would like to suggest new functionality, open an Issue and mark it as a __[Feature request]__. Please be specific about why you think this functionality will be of use. If you can, please include some visual description of what you would like the UI to look like, if you are suggesting new UI elements.
## Install
```console
composer require commitglobal/enum-utils
```
## Usage
### Arrayable
> [!important]
> For `Arrayable::options()`, your enum must implement a `getLabel()` method.
| `is($enum)` | Check if this enum matches the given enum instance or value. |
| `isNot($enum)` | Check if this enum does't match the given enum instance or value. |
#### Example
```php
enum Status: string
{
use CommitGlobal\Enums\Concerns\Comparable;
case ACTIVE = 'active';
case INACTIVE = 'inactive';
}
```
```php
$status = Status::ACTIVE;
$status->is(Status::ACTIVE); // true
$status->is('active'); // true
$status->is(Status::INACTIVE); // false
$status->isNot('inactive'); // true
```
## Feedback
* Request a new feature on GitHub.
Expand Down
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.
docs: add examples #2
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Uh oh!
There was an error while loading. Please reload this page.
docs: add examples #2
Filter by extension
Viewed files
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing