docs: add cases() documentation to README

This commit is contained in:
Victor Westerlund 2026-02-22 14:03:41 +01:00
parent 54396761cc
commit a7f5692184

View file

@ -55,6 +55,7 @@ Method
[Enum::names(): array](#enumnames) [Enum::names(): array](#enumnames)
[Enum::values(): array](#enumvalues) [Enum::values(): array](#enumvalues)
[Enum::entries(): array](#enumentries) [Enum::entries(): array](#enumentries)
[Enum::cases(): array](#enumcases)
## Enum::fromName() ## Enum::fromName()
@ -166,3 +167,24 @@ enum HelloWorld: string {
HelloWorld::entries(); // ["FOO" => "BAR", "BAZ" => "QUX"] HelloWorld::entries(); // ["FOO" => "BAR", "BAZ" => "QUX"]
``` ```
## Enum::cases()
Return an array of `Enum` instances for all cases in the enum.
```php
Enum::cases(): array<Enum>
```
Example:
```php
enum HelloWorld: string {
use xEnum;
case FOO = "BAR";
case BAZ = "QUX";
}
HelloWorld::cases(); // [object<Enum::FOO>, object<Enum::BAZ>]
```