minor symfony#22418 [HttpFoundation] Fix getClientIp @return docblock (e-moe)

fabpot · fabpot · commit 5742958a49c2 · 2017-04-13T08:44:20.000-07:00
This PR was merged into the 2.7 branch. Discussion ---------- [HttpFoundation] Fix getClientIp @return docblock | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | symfony#22415 | License | MIT | Doc PR | none Commits ------- af3424f [HttpFoundation] Fix getClientIp @return docblock
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -850,7 +850,7 @@ public function getClientIps()
      * ("Client-Ip" for instance), configure it via "setTrustedHeaderName()" with
      * the "client-ip" key.
      *
-     * @return string The client IP address
+     * @return string|null The client IP address
      *
      * @see getClientIps()
      * @see http://en.wikipedia.org/wiki/X-Forwarded-For

Original file line number	Diff line number	Diff line change
`@@ -850,7 +850,7 @@ public function getClientIps()`
`850`	`850`	`* ("Client-Ip" for instance), configure it via "setTrustedHeaderName()" with`
`851`	`851`	`* the "client-ip" key.`
`852`	`852`	`*`
`853`		`- * @return string The client IP address`
	`853`	`+ * @return string\|null The client IP address`
`854`	`854`	`*`
`855`	`855`	`* @see getClientIps()`
`856`	`856`	`* @see http://en.wikipedia.org/wiki/X-Forwarded-For`