Skip to content

docs: update README to clarify enum keys and labels distinction #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

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

Merged
cable8mm merged 1 commit into from
Aug 18, 2026
Merged

docs: update README to clarify enum keys and labels distinction #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,26 @@ Result:
]
```

Get enum keys:

```php
Status::keys();
```

Result:

```php
[
'draft',
'published',
]
```

> **Note:** In this package, "keys" refer to the actual enum values, while "labels" are the translated display names. For example:
>
> - `keys()` returns: `['draft', 'published']` (used as identifiers)
> - `labels()` returns: `['Draft', 'Published']` (displayed to users)

Get translated options:

```php
Expand Down
Loading