[TwigComponent] Document about Readonly components #3331
Merged
+99
−0
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
Member
Kocal
commented
Feb 2, 2026
Kocal
commented
| Q | A |
|---|---|
| Bug fix? | no |
| New feature? | no |
| Deprecations? | no |
| Documentation? | yes |
| Issues | Fix #3328 |
| License | MIT |
carsonbot
added
Documentation
There was a problem hiding this comment.
Pull request overview
This PR adds documentation explaining the interaction between PHP's readonly keyword and TwigComponent's property assignment system, addressing issue #3328.
Changes:
- Adds a new "Readonly Components and Immutability" section explaining why
readonlycomponents can cause initialization errors - Provides two recommended solutions: making only constructor dependencies readonly, or using the
mount()method for manual property assignment
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
src/TwigComponent/doc/index.rst
Outdated
| **Option 1: Make individual properties readonly instead of the entire class** (Recommended):: | ||
|
|
||
| #[AsTwigComponent] | ||
| final class UserProfile // ✅ class is not readonly |
There was a problem hiding this comment.
The spacing before the inline comment is inconsistent with line 466. Consider using consistent spacing (two spaces) before inline comments throughout the code examples.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.