Check if PHP enum contains case, like try() method on basic (not backed) enumerations

Question

I have basic enum

enum Fruit
{
  case APPLE;
  case ORANGE;
  case BANANA;
}

and some function that uses typing with that enum:

function eatFruit (Fruit $fruit)
{
  // do stuff
}

and variable with unknown content

$fruit = $_POST['fruit']; // user choosed "MILK"
if (?????) { // how to check if it's fruit?
  eatFruit($fruit); // this should not be executed
}

I cannot find in documentation simple way to check if enum contains specific case.

It is possible with backed enums like that

enum Fruit
{
  case APPLE = 'APPLE';
  case ORANGE = 'ORANGE';
  case BANANA = 'BANANA';
}

Fruit::from('');
Fruit::tryFrom('');

This will work, but from does not exist on non-backed enums form my first example.

Fatal error: Uncaught Error: Call to undefined method Fruit::from()

Does this answer your question? [Get Case from enum by string](https://stackoverflow.com/questions/70393792/get-case-from-enum-by-string) — Clément Baconnier, Jan 11 '22 at 18:48

rickdenhaan · Accepted Answer · 2022-01-09T21:25:50.787

You can use the static method cases() for this. This returns an array of all values in the enum. The values have a "name" property that is a string representation you can check against (backed enums also have a "value" property that contains the string value you defined in the enum).

So an example implementation could be something like:

enum Fruit {
    case APPLE;
    case ORANGE;
    case BANANA;
}

// String from user input
$fruit = $_POST['fruit'];

// Find matching fruit in all enum cases
$fruits = Fruit::cases();
$matchingFruitIndex = array_search($fruit, array_column($fruits, "name"));

// If found, eat it
if ($matchingFruitIndex !== false) {
    $matchingFruit = $fruits[$matchingFruitIndex];
    eatFruit($matchingFruit);
} else {
    echo $fruit . " is not a valid Fruit";
}

function eatFruit(Fruit $fruit): void {
    if ($fruit === Fruit::APPLE) {
        echo "An apple a day keeps the doctor away";
    } elseif ($fruit === Fruit::ORANGE) {
        echo "When life gives you oranges, make orange juice";
    } elseif ($fruit === Fruit::BANANA) {
        echo "Banana for scale";
    }
}

Working version with sample data: https://3v4l.org/ObD3s

If you want to do this more often with different enums, you could write a helper function for this:

function getEnumValue($value, $enumClass) {
    $cases = $enumClass::cases();
    $index = array_search($value, array_column($cases, "name"));
    if ($index !== false) {
        return $cases[$index];
    }
    
    return null;
}

$fruit = getEnumValue($_POST['fruit'], Fruit::class);
if ($fruit !== null) {
    eatFruit($fruit);
} else {
    echo $_POST['fruit'] . " is not a valid Fruit";
}

Example with the same sample data: https://3v4l.org/bL8Wa

Check if PHP enum contains case, like try() method on basic (not backed) enumerations

1 Answers1