Store a backed enum using its scalar value and reconstruct it with from() or tryFrom() after loading.
The examples below begin with the core behavior, then move to an application-oriented use.
How PHP Enums: Backed Enum Serialization and Persistence Works
Store a backed enum using its scalar value and reconstruct it with from() or tryFrom() after loading.
Example 1: Basic Usage
This example uses a small input to make the main behavior visible.
<?php
enum ApiVersion: string { case V1 = "v1"; case V2 = "v2"; }
$storedValue = ApiVersion::V2->value;
echo ApiVersion::from($storedValue)->name;
Output:
V2
Store a backed enum using its scalar value and reconstruct it with from() or tryFrom() after loading.
Example 2: A Different Input
A different set of values shows the same operation in another situation.
<?php
enum JobState: int { case Queued = 1; case Done = 2; }
$inputValue = 3;
var_dump(JobState::tryFrom($inputValue));
Output:
NULL
Validate incoming database/API values before using from(), which throws on unknown values.
Practical Example: Applying the Feature
This example shows an application-style use of the feature, with its surrounding setup visible.
<?php
enum DeliveryStatus: string { case Pending = "pending"; case Sent = "sent"; }
$storedValue = DeliveryStatus::Sent->value;
$restoredStatus = DeliveryStatus::from($storedValue);
echo $restoredStatus->name;
Output:
Sent
The code is shown for learning. Adjust the class names, inputs and error handling to suit your application.
Important Behavior and Edge Cases
- Validate incoming database/API values before using from(), which throws on unknown values.
- Store a backed enum using its scalar value and reconstruct it with from() or tryFrom() after loading.
- Observe differences in empty inputs, invalid states and optional extension availability where relevant.
Comparison With Related Approaches
| Approach | Important Difference |
|---|---|
PHP Enums: Backed Enum Serialization and Persistence | Store a backed enum using its scalar value and reconstruct it with from() or tryFrom() after loading. |
| Alternative approach | Serializing PHP enum objects is PHP-specific; stable backed values are clearer for interoperable storage. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
Ignoring the documented state or precondition of PHP Enums: Backed Enum Serialization and Persistence | Validate incoming database/API values before using from(), which throws on unknown values. |
| Expecting a different type of result | Read the declared return type and distinguish returned values from changes to the source object. |
| Assuming a related API works identically | Serializing PHP enum objects is PHP-specific; stable backed values are clearer for interoperable storage. |
Key Takeaways
- Store a backed enum using its scalar value and reconstruct it with from() or tryFrom() after loading.
- Validate incoming database/API values before using from(), which throws on unknown values.
- Use the example that matches the values, runtime version and dependencies in your application.
PHP Enums: Backed Enum Serialization and Persistence is useful when its behavior matches the data structure and lifecycle of your PHP application. Choose it with a clear understanding of its preconditions and returned values.