From a7f5692184e75c0759c52fd84fb42bf12522093f Mon Sep 17 00:00:00 2001 From: vlw Date: Sun, 22 Feb 2026 14:03:41 +0100 Subject: [PATCH] docs: add cases() documentation to README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 5437d0e..ca45a3f 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,7 @@ Method [Enum::names(): array](#enumnames) [Enum::values(): array](#enumvalues) [Enum::entries(): array](#enumentries) +[Enum::cases(): array](#enumcases) ## Enum::fromName() @@ -166,3 +167,24 @@ enum HelloWorld: string { HelloWorld::entries(); // ["FOO" => "BAR", "BAZ" => "QUX"] ``` + +## Enum::cases() + +Return an array of `Enum` instances for all cases in the enum. + +```php +Enum::cases(): array +``` + +Example: + +```php +enum HelloWorld: string { + use xEnum; + + case FOO = "BAR"; + case BAZ = "QUX"; +} + +HelloWorld::cases(); // [object, object] +```