[Php81] Skip readonly on property returned by reference in ReadOnlyPropertyRector#8108
Merged
Conversation
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.
Problem
ReadOnlyPropertyRectormade a promoted propertyreadonlyeven when it is returned by reference from a& method(). Returning by reference lets callers hold and mutate the value, so the property cannot bereadonly— PHP throws a fatal "Cannot acquire reference to readonly property" at runtime.Spotted in the wild in infection: https://github.com/infection/infection/blob/HEAD/src/TestFramework/Tracing/Trace/TestLocations.php
The rule rewrote
private array $byLinetoprivate readonly array $byLine, which breaks the by-reference getter.Fix
Add
isPropertyReturnedByRef()guard. Before making a property/promoted paramreadonly, bail out if any method declared with&(returns by reference) returns$this-><property>(directly or as the base of a nested expression).Added
skip_returned_by_ref.php.incfixture covering the case.