StringBackedEnum

Since: 8.1

interface StringBackedEnum implements BackedEnum (View source)

internal  Internal interface to ensure precise type inference
 

Properties

string $value

Methods

static array
cases()

Generates a list of cases on an enum

from  UnitEnum
static BackedEnum
from(int|string $value)

Translates a string into the corresponding Enum case, if any. If there is no matching case defined, it will throw a ValueError.

static BackedEnum|null
tryFrom(int|string $value)

Translates a string or int into the corresponding Enum case, if any. If there is no matching case defined, it will return null.

Details

in UnitEnum at line 1058
static array cases()

Generates a list of cases on an enum

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

Return Value

array

at line 1150
static BackedEnum from(int|string $value)

Translates a string into the corresponding Enum case, if any. If there is no matching case defined, it will throw a ValueError.

Parameters

int|string $value

Return Value

BackedEnum

Exceptions

ValueError

at line 1160
static BackedEnum|null tryFrom(int|string $value)

Translates a string or int into the corresponding Enum case, if any. If there is no matching case defined, it will return null.

Parameters

int|string $value

Return Value

BackedEnum|null

A case instance of this enumeration, or null if not found.