[TypeDeclarationDocblocks] Skip contradicting @param array when local call type conflicts with default value - #8381
Merged
TomasVotruba merged 1 commit intoAug 26, 2026
Conversation
… call type conflicts with default value
TomasVotruba
deleted the
fix-array-docblock-param-default-contradiction
branch
August 26, 2026 07:50
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.
Fixes rectorphp/rector#9864
ClassMethodArrayDocblockParamFromLocalCallsRectorinferred a@paramfrom local call sites that could contradict the callee's own default value.When an argument is a plain
arrayvariable, PHPStan flow-narrows it (e.g. after$row['state'] && ...) tonon-empty-array&hasOffsetValue(...). That narrowed type leaked into the generated docblock, producing anon-empty-arraycomponent on a param that declares= []- self-contradictory, and a source of PHPStan false positives (notably with#[\Override]).Before
class Minimal { + /** + * @param non-empty-array|array<string, int>|array<string, string> $row + */ public function callee(array $row = [])After
The default value is united into the inferred type, so the
non-empty-arraynarrowing collapses to a plain mixed array, which is then correctly recognized as valueless and skipped - no docblock added.Genuinely useful cases are unaffected: a literal call still narrows a defaulted param.
Changes
ClassMethodArrayDocblockParamFromLocalCallsRector- unite the resolved param type with the default value type so the docblock can never contradict the signature.NodeDocblockTypeDecorator::isArrayMixed()- also treat a mixed-keyed mixed array as valueless (previously only integer-keyed), so the collapsedmixed[]is skipped instead of emitted.