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

fabpot · fabpot · commit d45ecefe0cc2 · 2019-04-05T14:51:33.000+02:00
This PR was submitted for the 4.2 branch but it was merged into the 3.4 branch instead (closes symfony#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()
diff --git a/src/Symfony/Component/Validator/Constraint.php b/src/Symfony/Component/Validator/Constraint.php
@@ -232,12 +232,13 @@ public function addImplicitGroupName($group)
      *
      * Override this method to define a default option.
      *
-     * @return string
+     * @return string|null
      *
      * @see __construct()
      */
     public function getDefaultOption()
     {
+        return null;
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -232,12 +232,13 @@ public function addImplicitGroupName($group)`
`232`	`232`	`*`
`233`	`233`	`* Override this method to define a default option.`
`234`	`234`	`*`
`235`		`- * @return string`
	`235`	`+ * @return string\|null`
`236`	`236`	`*`
`237`	`237`	`* @see __construct()`
`238`	`238`	`*/`
`239`	`239`	`public function getDefaultOption()`
`240`	`240`	`{`
	`241`	`+ return null;`
`241`	`242`	`}`
`242`	`243`
`243`	`244`	`/**`