[Validator] Define null return type for Constraint::getDefaultOption() #30869
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
vudaltsov
approved these changes
Apr 5, 2019
fabpot
approved these changes
Apr 5, 2019
354586d to
03987f2
Compare
|
Good catch, thanks @jaikdean. |
fabpot
added a commit
that referenced
this pull request
Apr 5, 2019
…efaultOption() (jaikdean) This PR was submitted for the 4.2 branch but it was merged into the 3.4 branch instead (closes #30869). Discussion ---------- [Validator] Define null return type for Constraint::getDefaultOption() | Q | A | ------------- | --- | Branch? | 4.2 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | The `Constraint::getDefaultOption()` method is documented with a return type of `string`, but has no `return` statement. This behaviour is expected, as the return value is compared against `null` elsewhere in the code, but the docblock causes problems with static analysis when extending this class. This PR corrects the documented return type to `string|null` and adds an explicit `return null`. Commits ------- 03987f2 Define null return type for Constraint::getDefaultOption()
fabpot
added a commit
that referenced
this pull request
Jun 26, 2019
…lver (Tobion) This PR was merged into the 4.4 branch. Discussion ---------- use proper return types in ErrorHandler and ArgumentResolver | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | tiny | New feature? | no <!-- please update src/**/CHANGELOG.md files --> | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files --> | Tests pass? | yes <!-- please add some, will be required by reviewers --> | Fixed tickets | | License | MIT | Doc PR | Found those things while reviewing #31996 which missed some return types due to using `return` instead of `return null`. It's part of fixing #17201 (due to #10717). See also #30869 that somebody was stumbling over. Commits ------- 2f9121b use proper return types in ErrorHandler and ArgumentResolver
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.
The
Constraint::getDefaultOption()method is documented with a return type ofstring, but has noreturnstatement. This behaviour is expected, as the return value is compared againstnullelsewhere in the code, but the docblock causes problems with static analysis when extending this class.This PR corrects the documented return type to
string|nulland adds an explicitreturn null.