fix: Entity::normalizeValue() must handle UnitEnum before toArray() #10137
Open
maniaba wants to merge 2 commits intocodeigniter4:developfrom
Open
fix: Entity::normalizeValue() must handle UnitEnum before toArray() #10137maniaba wants to merge 2 commits intocodeigniter4:developfrom
maniaba wants to merge 2 commits intocodeigniter4:developfrom
Conversation
* fix: Entity::normalizeValue() must handle UnitEnum before toArray() Moves the `UnitEnum` instanceof check before `JsonSerializable` and `method_exists($data, 'toArray')` in Entity::normalizeValue(), so that enums implementing toArray() are always normalized as enums rather than as generic objects. Fixes codeigniter4#10136 Agent-Logs-Url: https://github.com/maniaba/CodeIgniter4/sessions/d5c8c660-329b-4872-8633-dd918674e4ac Co-authored-by: maniaba <61078470+maniaba@users.noreply.github.com> * fix test: correct toRawArray() assertion for injected enum toRawArray() returns raw $this->attributes, so an injected enum object stays as an enum object — not the backing string value. The real regression is that hasChanged() must return false (normalizeValue() handles UnitEnum before toArray()). Fixes the failing test from the previous commit. Agent-Logs-Url: https://github.com/maniaba/CodeIgniter4/sessions/d86b9a68-aee9-4178-a8b8-cf1bac285359 Co-authored-by: maniaba <61078470+maniaba@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: maniaba <61078470+maniaba@users.noreply.github.com>
Contributor
|
You need to add this fix in v4.7.3 changelog |
Agent-Logs-Url: https://github.com/maniaba/CodeIgniter4/sessions/40f33833-bf97-486e-a6d8-5d95bff1bf50 Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: maniaba <61078470+maniaba@users.noreply.github.com>
michalsn
reviewed
Apr 24, 2026
| public function toArray(): array | ||
| { | ||
| return array_column(self::cases(), 'value'); | ||
| } |
Member
There was a problem hiding this comment.
You're returning scalar strings, so this test does not test the reported recursion path.
Comment on lines
+1049
to
+1065
| public function testInjectRawDataWithEnumThatHasToArrayMethod(): void | ||
| { | ||
| // Regression test for https://github.com/codeigniter4/CodeIgniter4/issues/10136 | ||
| // Enums implementing toArray() must still be handled by the UnitEnum branch in | ||
| // normalizeValue(), so hasChanged() does not incorrectly report a change after | ||
| // injectRawData() stores the same enum value. | ||
| $entity = new class () extends Entity {}; | ||
|
|
||
| $entity->injectRawData(['state' => StateEnum::DRAFT]); | ||
|
|
||
| // toRawArray() returns raw attributes, so the enum object is returned as-is. | ||
| $this->assertSame(StateEnum::DRAFT, $entity->toRawArray()['state']); | ||
|
|
||
| // The key assertion: normalizeValue() must treat the enum as a UnitEnum | ||
| // (not call toArray() on it), so the original and current normalized forms match. | ||
| $this->assertFalse($entity->hasChanged('state')); | ||
| } |
Member
There was a problem hiding this comment.
Please remove all these comments, and just add in the docblock:
@see https://github.com/codeigniter4/CodeIgniter4/issues/10136
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Moves the
UnitEnuminstanceof check beforeJsonSerializableandmethod_exists($data, 'toArray')in Entity::normalizeValue(), so that enums implementing toArray() are always normalized as enums rather than as generic objects.Fixes #10136
toRawArray() returns raw $this->attributes, so an injected enum object stays as an enum object — not the backing string value. The real regression is that hasChanged() must return false (normalizeValue() handles UnitEnum before toArray()).
Checklist: