Symfony\Component\HttpFoundation\Request::setTrustedHeaderName PHP Method

setTrustedHeaderName() public static method

The following header keys are supported: * Request::HEADER_CLIENT_IP: defaults to X-Forwarded-For (see getClientIp()) * Request::HEADER_CLIENT_HOST: defaults to X-Forwarded-Host (see getHost()) * Request::HEADER_CLIENT_PORT: defaults to X-Forwarded-Port (see getPort()) * Request::HEADER_CLIENT_PROTO: defaults to X-Forwarded-Proto (see getScheme() and isSecure()) Setting an empty value allows to disable the trusted header for the given key.
public static setTrustedHeaderName ( string $key, string $value )
$key string The header key
$value string The header name
    public static function setTrustedHeaderName($key, $value)
    {
        if (!array_key_exists($key, self::$trustedHeaders)) {
            throw new \InvalidArgumentException(sprintf('Unable to set the trusted header name for key "%s".', $key));
        }

        self::$trustedHeaders[$key] = $value;
    }

Usage Example

Example #1
0
 /**
  * @expectedException \InvalidArgumentException
  */
 public function testSetTrustedProxiesInvalidHeaderName()
 {
     Request::create('http://example.com/');
     Request::setTrustedHeaderName('bogus name', 'X_MY_FOR');
 }
All Usage Examples Of Symfony\Component\HttpFoundation\Request::setTrustedHeaderName