docs(phpstan): fluent wither over new ctor param on consistent-constructor DTOs#75
Merged
Merged
Conversation
…uctor DTOs Adding a trailing constructor parameter to a @phpstan-consistent-constructor base class collides with subclasses that append their own parameters (method.childParameterType). Document the symptom and the fix — evolve state through a with*() wither instead of a new constructor parameter — as a new "Consistent-Constructor Subclass Collisions" subsection under Common Error Fixes. Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
github-actions
Bot
added
documentation
|
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.
What
Adds a Consistent-Constructor Subclass Collisions subsection to
references/phpstan-compliance.md(under Common Error Fixes).Why
Adding a new trailing parameter to a
@phpstan-consistent-constructorbase constructor collides with any subclass that already appends its own parameters — the same positional slot ends up with two different types, and PHPStan reportsmethod.childParameterType(not contravariant). Encountered while adding a field to an option object whose subclass added its own trailing parameter.Guidance added
Evolve state on a
@phpstan-consistent-constructortype that has subclasses through a fluentwith*()wither (private property +clone $this) instead of a new constructor parameter. The constructor signature stays stable, so there's no subclass collision, and the field stays immutable-by-clone. Cross-links toreferences/immutability-boundaries.md.Docs-only; passes markdownlint (SKILL.md unchanged).