例
例1 基本的な、値を限定する例
<?php
enum SortOrder
{
case Asc;
case Desc;
}
function query($fields, $filter, SortOrder $order = SortOrder::Asc)
{
/* ... */
}
?>
query()
関数は、
$order
が
SortOrder::Asc
または SortOrder::Desc
であることが保証されることを知っているので、安全に処理できます。
それら以外の値を渡しても、
TypeError
になるので、それ以上のチェックやテストは不要です。
例2 唯一の値を指定する、高度な例
<?php
enum UserStatus: string
{
case Pending = 'P';
case Active = 'A';
case Suspended = 'S';
case CanceledByUser = 'C';
public function label(): string
{
return match($this) {
static::Pending => 'Pending',
static::Active => 'Active',
static::Suspended => 'Suspended',
static::CanceledByUser => 'Canceled by user',
};
}
}
?>
この例では、ユーザーのステータスは
UserStatus::Pending
、
UserStatus::Active
、
UserStatus::Suspended
または
UserStatus::CanceledByUser
のうちのひとつに限られています。
関数は引数の型を UserStatus
に指定できますし、これら4つの値だけを受け入れます。
これら4つの値は、それぞれ
label()
メソッドを持ちます。
これは、人間が読みやすい文字列を返します。
この文字列は、"マシン上の" スカラー値とは別のものです。
このスカラー値は、データベースのフィールドや、
HTML の select ボックスで使うことができます。
<?php
foreach (UserStatus::cases() as $case) {
printf('<option value="%s">%s</option>\n', $case->value, $case->label());
}
?>
+add a note
User Contributed Notes 1 note
php-net at mentordosnerds dot com ¶
1 year ago
Additional use-case examples:
<?php
trait EnumNamesTrait
{
abstract public static function cases(): array;
public static function names(): array
{
return array_map(fn($enum) => $enum->name, static::cases());
}
}
trait EnumValuesTrait
{
abstract public static function cases(): array;
public static function values(): array
{
return array_map(fn($enum) => $enum->value, static::cases());
}
}
trait EnumArraySerializableTrait
{
use EnumNamesTrait;
use EnumValuesTrait;
public static function array(): array
{
return array_combine(static::names(), static::values());
}
}
trait EnumJsonSerializableTrait
{
use EnumArraySerializableTrait;
public static function jsonSerialize(): string
{
return json_encode(static::array());
}
}
enum Suit: string
{
case Clubs = '♣';
case Diamonds = '♦';
case Hearts = '♥';
case Spades = '♠';
use EnumJsonSerializableTrait;
public const DEFAULT = self::Hearts;
public static function default(): static
{
return self::DEFAULT;
}
}
var_dump(
Suit::cases(),
Suit::values(),
Suit::names(),
Suit::array(),
Suit::jsonSerialize(),
Suit::default(),
);
↑ and ↓ to navigate •
Enter to select •
Esc to close
Press Enter without
selection to search using Google