php8.5
Home/ Manual/ predefined / unitenum/ UnitEnum::cases

UnitEnum::cases

PHP function Edit on GitHub ✎

(PHP 8 >= 8.1.0)

Generates a list of cases on an enum

Description

UnitEnum::cases(): array

This method will return a packed array of all cases in an enumeration, in order of declaration.

Parameters Parameters

Return Values

An array of all defined cases of this enumeration, in order of declaration.

Examples

Basic usage

The following example illustrates how enum cases are returned.

php
<?php
enum Suit
{
    case Hearts;
    case Diamonds;
    case Clubs;
    case Spades;
}

var_dump(Suit::cases());

The above example will output:

output
array(4) {
  [0]=>
  enum(Suit::Hearts)
  [1]=>
  enum(Suit::Diamonds)
  [2]=>
  enum(Suit::Clubs)
  [3]=>
  enum(Suit::Spades)
}

Source: language/predefined/unitenum/cases.xml · from the official PHP manual (php/doc-en)