class ServerBag

ServerBag is a container for HTTP headers from the $_SERVER variable.

@author Fabien Potencier <fabien@symfony.com> @author Bulat Shakirzyanov <mallluhuct@gmail.com> @author Robert Kiss <kepten@gmail.com>

Hierarchy

  • class \Symfony\Component\HttpFoundation\ParameterBag implements \Symfony\Component\HttpFoundation\IteratorAggregate, \Symfony\Component\HttpFoundation\Countable
    • class \Symfony\Component\HttpFoundation\ServerBag extends \Symfony\Component\HttpFoundation\ParameterBag

Expanded class hierarchy of ServerBag

File

vendor/symfony/http-foundation/ServerBag.php, line 21

Namespace

Symfony\Component\HttpFoundation
View source 
class ServerBag extends ParameterBag {
    
    /**
     * Gets the HTTP headers.
     */
    public function getHeaders() : array {
        $headers = [];
        foreach ($this->parameters as $key => $value) {
            if (str_starts_with($key, 'HTTP_')) {
                $headers[substr($key, 5)] = $value;
            }
            elseif (\in_array($key, [
                'CONTENT_TYPE',
                'CONTENT_LENGTH',
                'CONTENT_MD5',
            ], true) && '' !== $value) {
                $headers[$key] = $value;
            }
        }
        if (isset($this->parameters['PHP_AUTH_USER'])) {
            $headers['PHP_AUTH_USER'] = $this->parameters['PHP_AUTH_USER'];
            $headers['PHP_AUTH_PW'] = $this->parameters['PHP_AUTH_PW'] ?? '';
        }
        else {
            
            /*
             * php-cgi under Apache does not pass HTTP Basic user/pass to PHP by default
             * For this workaround to work, add these lines to your .htaccess file:
             * RewriteCond %{HTTP:Authorization} .+
             * RewriteRule ^ - [E=HTTP_AUTHORIZATION:%0]
             *
             * A sample .htaccess file:
             * RewriteEngine On
             * RewriteCond %{HTTP:Authorization} .+
             * RewriteRule ^ - [E=HTTP_AUTHORIZATION:%0]
             * RewriteCond %{REQUEST_FILENAME} !-f
             * RewriteRule ^(.*)$ index.php [QSA,L]
             */
            $authorizationHeader = null;
            if (isset($this->parameters['HTTP_AUTHORIZATION'])) {
                $authorizationHeader = $this->parameters['HTTP_AUTHORIZATION'];
            }
            elseif (isset($this->parameters['REDIRECT_HTTP_AUTHORIZATION'])) {
                $authorizationHeader = $this->parameters['REDIRECT_HTTP_AUTHORIZATION'];
            }
            if (null !== $authorizationHeader) {
                if (0 === stripos($authorizationHeader, 'basic ')) {
                    // Decode AUTHORIZATION header into PHP_AUTH_USER and PHP_AUTH_PW when authorization header is basic
                    $exploded = explode(':', base64_decode(substr($authorizationHeader, 6)), 2);
                    if (2 == \count($exploded)) {
                        [
                            $headers['PHP_AUTH_USER'],
                            $headers['PHP_AUTH_PW'],
                        ] = $exploded;
                    }
                }
                elseif (empty($this->parameters['PHP_AUTH_DIGEST']) && 0 === stripos($authorizationHeader, 'digest ')) {
                    // In some circumstances PHP_AUTH_DIGEST needs to be set
                    $headers['PHP_AUTH_DIGEST'] = $authorizationHeader;
                    $this->parameters['PHP_AUTH_DIGEST'] = $authorizationHeader;
                }
                elseif (0 === stripos($authorizationHeader, 'bearer ')) {
                    
                    /*
                     * XXX: Since there is no PHP_AUTH_BEARER in PHP predefined variables,
                     *      I'll just set $headers['AUTHORIZATION'] here.
                     *      https://php.net/reserved.variables.server
                     */
                    $headers['AUTHORIZATION'] = $authorizationHeader;
                }
            }
        }
        if (isset($headers['AUTHORIZATION'])) {
            return $headers;
        }
        // PHP_AUTH_USER/PHP_AUTH_PW
        if (isset($headers['PHP_AUTH_USER'])) {
            $headers['AUTHORIZATION'] = 'Basic ' . base64_encode($headers['PHP_AUTH_USER'] . ':' . ($headers['PHP_AUTH_PW'] ?? ''));
        }
        elseif (isset($headers['PHP_AUTH_DIGEST'])) {
            $headers['AUTHORIZATION'] = $headers['PHP_AUTH_DIGEST'];
        }
        return $headers;
    }

}

Members

Title Modifiers Object type Summary Overrides
ParameterBag::add public function Adds parameters. 2
ParameterBag::all public function Returns the parameters.
ParameterBag::count public function Returns the number of parameters.
ParameterBag::filter public function Filter key. 1
ParameterBag::get public function 1
ParameterBag::getAlnum public function Returns the alphabetic characters and digits of the parameter value.
ParameterBag::getAlpha public function Returns the alphabetic characters of the parameter value.
ParameterBag::getBoolean public function Returns the parameter value converted to boolean.
ParameterBag::getDigits public function Returns the digits of the parameter value.
ParameterBag::getEnum public function Returns the parameter value converted to an enum. 1
ParameterBag::getInt public function Returns the parameter value converted to integer.
ParameterBag::getIterator public function Returns an iterator for parameters.
ParameterBag::getString public function Returns the parameter as string. 1
ParameterBag::has public function Returns true if the parameter is defined.
ParameterBag::keys public function Returns the parameter keys.
ParameterBag::remove public function Removes a parameter.
ParameterBag::replace public function Replaces the current parameters by a new set. 2
ParameterBag::set public function 2
ParameterBag::__construct public function 2
ServerBag::getHeaders public function Gets the HTTP headers.