diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

minor #30869 [Validator] Define null return type for Constraint::getDefaultOption() (jaikdean)

Browse Source 
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
-------

03987f2ba5 Define null return type for Constraint::getDefaultOption()
This commit is contained in:
Fabien Potencier 2019-04-05 14:51:33 +02:00
commit d45ecefe0c
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/Symfony/Component/Validator/Constraint.php
View File

@ -232,12 +232,13 @@ abstract class Constraint
* *
* Override this method to define a default option. * Override this method to define a default option.
* *
* @return string * @return string|null
* *
* @see __construct() * @see __construct()
*/ */
public function getDefaultOption() public function getDefaultOption()
{ {
return null;
} }
/** /**