feature #18197 Make Request::isFromTrustedProxy() public. (Peter Bex)

fabpot · fabpot · commit 697bac9bf292 · 2016-03-25T12:38:37.000+01:00
This PR was merged into the 3.1-dev branch. Discussion ---------- Make Request::isFromTrustedProxy() public. | Q | A | ------------- | --- | Branch | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | When adding custom headers to your proxy (in our particular case, a `X-Base-Url` header, but it could be anything), it is necessary to be able to tell whether the request came from a trusted proxy or not. Unfortunately, currently the `isFromTrustedProxy()` method is private, which means you'll need to subclass `Request` and add your own *differently named* method just to be able to access this information. This functionality is pretty straightforward, and I don't see a reason to keep this method private so this a trivial pull request to make it public (and it adds a comment so it'll show up in the API docs with proper documentation). Commits ------- 286f64f Make Request::isFromTrustedProxy() public.
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -1931,7 +1931,15 @@ private static function createRequestFromFactory(array $query = array(), array $
         return new static($query, $request, $attributes, $cookies, $files, $server, $content);
     }
 
-    private function isFromTrustedProxy()
+    /**
+     * Indicates whether this request originated from a trusted proxy.
+     *
+     * This can be useful to determine whether or not to trust the
+     * contents of a proxy-specific header.
+     *
+     * @return bool true if the request came from a trusted proxy, false otherwise
+     */
+    public function isFromTrustedProxy()
     {
         return self::$trustedProxies && IpUtils::checkIp($this->server->get('REMOTE_ADDR'), self::$trustedProxies);
     }

Original file line number	Diff line number	Diff line change
`@@ -1931,7 +1931,15 @@ private static function createRequestFromFactory(array $query = array(), array $`
`1931`	`1931`	`return new static($query, $request, $attributes, $cookies, $files, $server, $content);`
`1932`	`1932`	`}`
`1933`	`1933`
`1934`		`- private function isFromTrustedProxy()`
	`1934`	`+ /**`
	`1935`	`+ * Indicates whether this request originated from a trusted proxy.`
	`1936`	`+ *`
	`1937`	`+ * This can be useful to determine whether or not to trust the`
	`1938`	`+ * contents of a proxy-specific header.`
	`1939`	`+ *`
	`1940`	`+ * @return bool true if the request came from a trusted proxy, false otherwise`
	`1941`	`+ */`
	`1942`	`+ public function isFromTrustedProxy()`
`1935`	`1943`	`{`
`1936`	`1944`	`return self::$trustedProxies && IpUtils::checkIp($this->server->get('REMOTE_ADDR'), self::$trustedProxies);`
`1937`	`1945`	`}`