Enumerating behaviour: Why PHP needs better enum?
•
0 likes•254 views
What are possibilities of expressing enumerations in native PHP? And are there better options? What to work with me? Say hello@jankuchar.cz Libraries mentioned: - grifart/enum: https://github.com/grifart/enum - consistence/consistence: https://github.com/consistence/consistence/blob/master/docs/Enum/enums.md - myclabs/php-enum: https://github.com/myclabs/php-enum
Recommended
Recommended
More Related Content
What's hot
What's hot (14)
Similar to Enumerating behaviour: Why PHP needs better enum?
Similar to Enumerating behaviour: Why PHP needs better enum? (20)
Recently uploaded
Recently uploaded (20)
Enumerating behaviour: Why PHP needs better enum?
- 1. Enumeration of values behaviour? Jan Kuchař @honzakuchar www.jankuchar.cz
- 2. @honzakuchar event sourcing & domain driven design static analysis enthusiast UX community member Jan Kuchař @honzakuchar www.jankuchar.cz
- 3. @honzakuchar co-founder at A secure environment for implementing marketing campaigns for pharmaceutical companies.
- 4. @honzakuchar co-founder at A digital mobile assistant for patients on IVF.
- 5. Contents • Story: Project with an order, where state transitions are restricted by domain • Enum in laguages derived from C • What is wrong with C-like implementations? • Better alternatives for PHP
- 9. C C++ C#
- 10. typedef enum { RECEIVED = 1, PROCESSING = 2, FINISHED = 3, CANCELLED = 4 } order_state;
- 11. order_state state = RECEIVED; ✅
- 12. order_state state = 42; compiles 🤷 And it should not.
- 14. int + constants in PHP Heritage C enum
- 15. Usage for C-like enum in domain model is limited.
- 16. /** @return int[] */ function nextStates(int $state): array { … }
- 17. 1. type-unsafe (just an integer)
- 18. /** @return int[] */ function nextStates(int $state): array { switch $state { case RECEIVED: return [PROCESSING, CANCELLED]; case … } }
- 19. 2. Domain logic spreads all over application.
- 20. /** @return int[] */ function nextStates(int $state): array { switch $state { case … } } default: throw new UnexpectedState();
- 21. 3. Does not validate its values. So you have to - every time you use a value.
- 22. Usage for C-like enum in domain model is limited. ❌ does not validate values ❌ is not type safe ❌ does not keep behaviour in one place
- 23. SplEnum, class constants 🙈class State { public const RECEIVED = 1; public const PREPARING = 2; … } The same problem again!
- 24. Custom enum implementations to the rescue. ✚
- 25. @honzakuchar final class OrderState extends Enum { public const RECEIVED = 'received', PROCESSING = 'processing', … function nextPossibleStates(OrderState $state) { // ... }
- 26. composer require myclabs/php-enum ✅ type safe ✅ simple behaviours
- 27. @honzakuchar
- 28. composer require consistence/consistence + multi enums ✅ type safe ✅ simple behaviour ✅ can compare instances
- 30. @honzakuchar final class OrderState { public const RECEIVED = 'received'; public const PROCESSING = 'processing'; public const FINISHED = 'finished'; public const CANCELLED = 'cancelled'; }
- 31. @honzakuchar function canDoTransition(string $currentState, string $desiredState): bool { switch ($currentState) { case OrderState::RECEIVED: return $desiredState === OrderState::PROCESSING || $desiredState === OrderState::CANCELLED; case … global function
- 32. Make it type safe
- 33. @honzakuchar /** * @method static OrderState RECEIVED() * @method static OrderState PROCESSING() * … */ final class OrderState extends Enum { protected const RECEIVED = 'received', PROCESSING = 'processing', …; }
- 34. @honzakuchar
- 35. @honzakuchar function canDoTransition( string $currentState, string $desiredState ): bool function canDoTransition( OrderState $currentState, OrderState $desiredState ): bool
- 37. @honzakuchar
- 38. @honzakuchar final class OrderState extends Enum { protected const RECEIVED = 'received', PROCESSING = 'processing', … public function canDoTransition(OrderState $desiredState): bool { if ($this === self::RECEIVED()) { return $desiredState === self::PROCESSING() || …; } function canDoTransition( OrderState $currentState, OrderState $desiredState ): bool { … } global function
- 41. @honzakuchar final class OrderState extends Enum { protected const RECEIVED = 'received', PROCESSING = 'processing', … public function canDoTransition(OrderState $desiredState): bool { if ($this === self::RECEIVED()) { return $desiredState === self::PROCESSING() || …; } … throw new LogicException('Should not happen: Unknown state'); } ❌ There are still ugly ifs which are hard to read.
- 42. @honzakuchar final class OrderState extends Enum { protected const RECEIVED = 'received', PROCESSING = 'processing', … public function canDoTransition(OrderState $desiredState): bool { if ($this === self::RECEIVED()) { return $desiredState === self::PROCESSING() || …; } … throw new LogicException('Should not happen: Unknown state'); } ❌ I have to worry about case when someone adds new value to this enum and forgets to add switch case.
- 43. Lets fix this using composition
- 44. @honzakuchar abstract class OrderState extends Enum { protected const RECEIVED = 'received', PROCESSING = ‚processing‘ …; abstract public function canDoTransition(OrderState $nextState): bool;
- 45. @honzakuchar abstract class OrderState extends Enum {
- 46. @honzakuchar
- 47. @honzakuchar ✅ Now type-system knows that every enum value must have method canDoTransition().
- 48. @honzakuchar ✅ Got rid of all ifs and switches.
- 49. @honzakuchar ✅ Public API haven’t changed from previous example.
- 50. composer require grifart/enum github.com/grifart/enum ✅ type safe ✅ can compare instances ✅ behaviour by composition POLYMORHISM? checking of annotations
- 51. One more thing
- 52. @honzakuchar
- 53. @honzakuchar
- 55. Jan Kuchař www.jankuchar.cz hello@jankuchar.cz @honzakuchar (Péhápkaři Slack, Twitter) Do you want to work with me? hello@jankuchar.cz