【PHP8.1リリース記念】PHPerのためのPHP8.1をもっと語り合うPHP TechCafe でLTした時の資料です。

1. コードを書いて理解する!Enumに
ついて
2021/12/17
【PHP8.1リリース記念】PHPerのためのPHP8.1をもっと語り合うPHP TechCafe
hiro(@etBeEP5e7dwmw7P)

2. 自己紹介
・hiro
・Laravel+vue.js+postgresql
・趣味：ボルダリング(最高グレード4D)
・年末の楽しみ：獣道４
今だけフォロバ還元率 100%!!
Twitterのフォローよろしくお願いしま
す!

3. いきなりですが、
みなさんはPHPでEnumのコードを書きましたか？

4. 利用するサイト: Laravel PlayGround

5. Lesson1
Pure Enum

6. <?php
/**
* Lesson1.基本 Pure Enum
*/
// 1.enumの書き方
// enumに続き、case文(推奨:パスカルケース)を続ける
// caseのkeyはユニークである必要がある
enum HogeStatus {
case Hogeing;
case HOGA; // minor
// case Hogeing; // duplicate error
}

7. // 2.Enumには組み込みのメソッドがある
// case() -> 全caseの配列 (collectionのallメソッドみたい)
echo dd(HogeStatus::cases());
// 内部的にUnit Enumというインターフェースを実装している
// https://www.php.net/manual/ja/language.enumerations.listing.php
// key部分はname属性として定義される
// caseにvalueを書いてないタイプをPure Enumという

8. Lesson2
Backed Enum

9. // 1. 各caseにスカラー値のvalueを設定できる
// 参照された時に返す値をBacked Value という
// Backed Valueを定義したEnumをBacked Enumという
/**
* Backed Valueの規約:
* タイプヒント必須
* 全casesに設定必須
* 型は int or string
* 同じ型である必要がある
* ユニーク制約
*/
enum HogeStatus: string {
case Hogeing = 'hoge';
case Huga = 'huga';
}

10. // 参照する方法①プロパティにアクセス
// echo HogeStatus::Huga->value;
// 参照する方法②組み込みメソッド
// ・cases()
// echo dd(HogeStatus::cases());
// ・from()
// 引数と同じvalueのcaseを返す
// 見つからない時はエラーを返す(findOrFailみたいな感じ)
echo HogeStatus::from('hoge')->value;
// ・tryFrom()
// 引数と同じvalueのcaseを返す
// 見つからない時はnullを返す (find みたいな感じ)
echo HogeStatus::tryFrom('hyou') ?? 'nullだよ';

11. Lesson３(実践編)は,
時間の関係で割愛させてもらいます。
次のLaravel/PHPイベントでやらせてもらうかも?

12. すこし早いですが、よい年末を
来年もよろしくおねがいします!

13. Lesson3
Enum実践編

14. <?php
/**
* Lesson3. Enum実用編
*/
// Laravel collectionでenumもどきを作ってみる
$order_status_enum = collect([
'reserved' => 0, // 予約
'purchased' => 1, // 購入
'shipping' => 2, // 発送準備中
'delivering' => 3, // 発送済
'delivered' => 10, // 配達済
]);
class Order {
// statusには0,1,2,3,10が入ることを想定しているが、それ以外の値も入ってしまう可能性
public function updateStatus(int $status)
{
echo '注文ステータスを' . $status . 'へ更新'. "<br>";
}
}
// $order = new Order;
// $order->updateStatus($order_status_enum->get('delivering'));
// 動くけどよくない例：1がどんなステータスかわからない
(マジック)
// $order->updateStatus(1);
// バグの原因になりうる例：無効なステータス値も入る
// $order->updateStatus(100);

15. /**
* Enumを使って実装
*/
class NeoOrder {
// 引数がenumで限定されているため、
public function updateStatus(OrderStatus $status)
{
echo 'NEO 注文ステータスを' . $status->value . 'へ更新'. "<br>";
// echo 'NEO 注文ステータスを' . $status->value . 'へ更新'. "n";
}
}
enum OrderStatus: int {
case Reserved = 0; // 予約
case Purchased = 1; // 購入
case Shipping = 2; // 発送準備中
case Delivering = 3; // 発送済
case Delivered = 10; // 配達済
case Canceled = 20; // キャンセル
case Returned = 30; // 返品
}
$neo_order = new NeoOrder;
// リクエストパラメータの値を
enumへ変換してステータスを変更する例
$params = ['status' => 20];
$status = OrderStatus::from($params['status']);
$neo_order->updateStatus($status);

16. 興味が湧いた方は、こちらも参考にどうぞ
PHPリファレンス Enum: https://www.php.net/manual/ja/language.enumerations.php
PHP8.1 Enums/Ayesh Karunaratne: https://www.youtube.com/watch?v=iKAu1ApYbbw