minor #28321 [Routing] Fixed the interface description of the url generator interface (Toflar)

fabpot · fabpot · commit 487f8acde58b · 2018-09-04T10:17:45.000+02:00
This PR was merged into the 2.8 branch. Discussion ---------- [Routing] Fixed the interface description of the url generator interface | Q | A | ------------- | --- | Branch? | 2.8 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | The `UrlGenerator` has always been able to return `null`. Many tests assert this for many years but the interface actually always only allowed a `string` return. Examples for tests: - https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Routing/Tests/Generator/UrlGeneratorTest.php#L206 - https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Routing/Tests/Generator/UrlGeneratorTest.php#L217 - https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Routing/Tests/Generator/UrlGeneratorTest.php#L471 So I think I would not consider this change as a BC break but rather a doc fix because it seems like `null` has always been an accepted return value. Commits ------- d2e9e0b Fixed the interface description of the url generator interface
diff --git a/src/Symfony/Component/Routing/Generator/UrlGeneratorInterface.php b/src/Symfony/Component/Routing/Generator/UrlGeneratorInterface.php
@@ -73,7 +73,7 @@ interface UrlGeneratorInterface extends RequestContextAwareInterface
      * @param mixed  $parameters    An array of parameters
      * @param int    $referenceType The type of reference to be generated (one of the constants)
      *
-     * @return string The generated URL
+     * @return string|null The generated URL
      *
      * @throws RouteNotFoundException              If the named route doesn't exist
      * @throws MissingMandatoryParametersException When some parameters are missing that are mandatory for the route

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ interface UrlGeneratorInterface extends RequestContextAwareInterface`
`73`	`73`	`* @param mixed $parameters An array of parameters`
`74`	`74`	`* @param int $referenceType The type of reference to be generated (one of the constants)`
`75`	`75`	`*`
`76`		`- * @return string The generated URL`
	`76`	`+ * @return string\|null The generated URL`
`77`	`77`	`*`
`78`	`78`	`* @throws RouteNotFoundException If the named route doesn't exist`
`79`	`79`	`* @throws MissingMandatoryParametersException When some parameters are missing that are mandatory for the route`