The HttpFoundation Component

Accessing Request Data

A Request object holds information about the client request. This information can be accessed via several public properties:

• request: equivalent of $_POST;
• query: equivalent of $_GET ($request->query->get('name'));
• cookies: equivalent of $_COOKIE;
• attributes: no equivalent - used by your app to store other data (see below);
• files: equivalent of $_FILES;
• server: equivalent of $_SERVER;
• headers: mostly equivalent to a subset of $_SERVER ($request->headers->get('User-Agent')).

Each property is a ParameterBag instance (or a subclass of), which is a data holder class:

• request: ParameterBag or InputBag if the data is coming from $_POST parameters;
• query: InputBag;
• cookies: InputBag;
• attributes: ParameterBag;
• files: FileBag;
• server: ServerBag;
• headers: HeaderBag.

All ParameterBag instances have methods to retrieve and update their data:

all()

Returns the parameters.

keys()

Returns the parameter keys.

replace()

Replaces the current parameters by a new set.

add()

Adds parameters.

get()

Returns a parameter by name.

set()

Sets a parameter by name.

has()

Returns true if the parameter is defined.

remove()

Removes a parameter.

The ParameterBag instance also has some methods to filter the input values:

getAlpha()

Returns the alphabetic characters of the parameter value;

getAlnum()

Returns the alphabetic characters and digits of the parameter value;

getBoolean()

Returns the parameter value converted to boolean;

getDigits()

Returns the digits of the parameter value;

getInt()

Returns the parameter value converted to integer;

getEnum()

Returns the parameter value converted to a PHP enum;

getString()

Returns the parameter value as a string;

filter()

Filters the parameter by using the PHP filter_var function.

6.3

Ignoring invalid values when using filter() is deprecated and will throw a BadRequestHttpException in Symfony 7.0. You can use the FILTER_NULL_ON_FAILURE flag to keep ignoring them.

All getters take up to two arguments: the first one is the parameter name and the second one is the default value to return if the parameter does not exist:

1
2
3
4
5
6
7
8
9
10

// the query string is '?foo=bar'

$request->query->get('foo');
// returns 'bar'

$request->query->get('bar');
// returns null

$request->query->get('bar', 'baz');
// returns 'baz'

When PHP imports the request query, it handles request parameters like foo[bar]=baz in a special way as it creates an array. The get() method doesn't support returning arrays, so you need to use the following code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

// the query string is '?foo[bar]=baz'

// don't use $request->query->get('foo'); use the following instead:
$request->query->all('foo');
// returns ['bar' => 'baz']

// if the requested parameter does not exist, an empty array is returned:
$request->query->all('qux');
// returns []

$request->query->get('foo[bar]');
// returns null

$request->query->all()['foo']['bar'];
// returns 'baz'

Thanks to the public attributes property, you can store additional data in the request, which is also an instance of ParameterBag. This is mostly used to attach information that belongs to the Request and that needs to be accessed from many different points in your application.

Finally, the raw data sent with the request body can be accessed using getContent():

1

$content = $request->getContent();

For instance, this may be useful to process an XML string sent to the application by a remote service using the HTTP POST method.

If the request body is a JSON string, it can be accessed using toArray():

1

$data = $request->toArray();

If the request data could be $_POST data or a JSON string, you can use the getPayload() method which returns an instance of InputBag wrapping this data:

1

$data = $request->getPayload();

Identifying a Request

In your application, you need a way to identify a request; most of the time, this is done via the "path info" of the request, which can be accessed via the getPathInfo() method:

1
2
3

// for a request to http://example.com/blog/index.php/post/hello-world
// the path info is "/post/hello-world"
$request->getPathInfo();

Simulating a Request

Instead of creating a request based on the PHP globals, you can also simulate a request:

1
2
3
4
5

$request = Request::create(
    '/hello-world',
    'GET',
    ['name' => 'Fabien']
);

The create() method creates a request based on a URI, a method and some parameters (the query parameters or the request ones depending on the HTTP method); and of course, you can also override all other variables as well (by default, Symfony creates sensible defaults for all the PHP global variables).

Based on such a request, you can override the PHP global variables via overrideGlobals():

1

$request->overrideGlobals();

Accessing the Session

If you have a session attached to the request, you can access it via the getSession() method of the Request or RequestStack class; the hasPreviousSession() method tells you if the request contains a session which was started in one of the previous requests.

Processing HTTP Headers

Processing HTTP headers is not a trivial task because of the escaping and white space handling of their contents. Symfony provides a HeaderUtils class that abstracts this complexity and defines some methods for the most common tasks:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

use Symfony\Component\HttpFoundation\HeaderUtils;

// Splits an HTTP header by one or more separators
HeaderUtils::split('da, en-gb;q=0.8', ',;');
// => [['da'], ['en-gb','q=0.8']]

// Combines an array of arrays into one associative array
HeaderUtils::combine([['foo', 'abc'], ['bar']]);
// => ['foo' => 'abc', 'bar' => true]

// Joins an associative array into a string for use in an HTTP header
HeaderUtils::toString(['foo' => 'abc', 'bar' => true, 'baz' => 'a b c'], ',');
// => 'foo=abc, bar, baz="a b c"'

// Encodes a string as a quoted string, if necessary
HeaderUtils::quote('foo "bar"');
// => '"foo \"bar\""'

// Decodes a quoted string
HeaderUtils::unquote('"foo \"bar\""');
// => 'foo "bar"'

// Parses a query string but maintains dots (PHP parse_str() replaces '.' by '_')
HeaderUtils::parseQuery('foo[bar.baz]=qux');
// => ['foo' => ['bar.baz' => 'qux']]

Accessing Accept-* Headers Data

You can access basic data extracted from Accept-* headers by using the following methods:

getAcceptableContentTypes()

Returns the list of accepted content types ordered by descending quality.

getLanguages()

Returns the list of accepted languages ordered by descending quality.

getCharsets()

Returns the list of accepted charsets ordered by descending quality.

getEncodings()

Returns the list of accepted encodings ordered by descending quality.

If you need to get full access to parsed data from Accept, Accept-Language, Accept-Charset or Accept-Encoding, you can use AcceptHeader utility class:

1
2
3
4
5
6
7
8
9
10
11
12

use Symfony\Component\HttpFoundation\AcceptHeader;

$acceptHeader = AcceptHeader::fromString($request->headers->get('Accept'));
if ($acceptHeader->has('text/html')) {
    $item = $acceptHeader->get('text/html');
    $charset = $item->getAttribute('charset', 'utf-8');
    $quality = $item->getQuality();
}

// Accept header items are sorted by descending quality
$acceptHeaders = AcceptHeader::fromString($request->headers->get('Accept'))
    ->all();

The default values that can be optionally included in the Accept-* headers are also supported:

1
2
3
4
5

$acceptHeader = 'text/plain;q=0.5, text/html, text/*;q=0.8, */*;q=0.3';
$accept = AcceptHeader::fromString($acceptHeader);

$quality = $accept->get('text/xml')->getQuality(); // $quality = 0.8
$quality = $accept->get('application/xml')->getQuality(); // $quality = 0.3

Anonymizing IP Addresses

An increasingly common need for applications to comply with user protection regulations is to anonymize IP addresses before logging and storing them for analysis purposes. Use the anonymize() method from the IpUtils to do that:

1
2
3
4
5
6
7
8
9

use Symfony\Component\HttpFoundation\IpUtils;

$ipv4 = '123.234.235.236';
$anonymousIpv4 = IpUtils::anonymize($ipv4);
// $anonymousIpv4 = '123.234.235.0'

$ipv6 = '2a01:198:603:10:396e:4789:8e99:890f';
$anonymousIpv6 = IpUtils::anonymize($ipv6);
// $anonymousIpv6 = '2a01:198:603:10::'

Check if an IP Belongs to a Private Subnet

If you need to know if an IP address belongs to a private subnet, you can use the isPrivateIp() method from the IpUtils to do that:

1
2
3
4
5
6
7
8
9

use Symfony\Component\HttpFoundation\IpUtils;

$ipv4 = '192.168.1.1';
$isPrivate = IpUtils::isPrivateIp($ipv4);
// $isPrivate = true

$ipv6 = '2a01:198:603:10:396e:4789:8e99:890f';
$isPrivate = IpUtils::isPrivateIp($ipv6);
// $isPrivate = false

Accessing other Data

The Request class has many other methods that you can use to access the request information. Have a look at the Request API for more information about them.

Overriding the Request

The Request class should not be overridden as it is a data object that represents an HTTP message. But when moving from a legacy system, adding methods or changing some default behavior might help. In that case, register a PHP callable that is able to create an instance of your Request class:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

use App\Http\SpecialRequest;
use Symfony\Component\HttpFoundation\Request;

Request::setFactory(function (
    array $query = [],
    array $request = [],
    array $attributes = [],
    array $cookies = [],
    array $files = [],
    array $server = [],
    $content = null
) {
    return new SpecialRequest(
        $query,
        $request,
        $attributes,
        $cookies,
        $files,
        $server,
        $content
    );
});

$request = Request::createFromGlobals();

Sending the Response

Before sending the Response, you can optionally call the prepare() method to fix any incompatibility with the HTTP specification (e.g. a wrong Content-Type header):

1

$response->prepare($request);

Sending the response to the client is done by calling the method send():

1

$response->send();

Setting Cookies

The response cookies can be manipulated through the headers public attribute:

1
2
3

use Symfony\Component\HttpFoundation\Cookie;

$response->headers->setCookie(Cookie::create('foo', 'bar'));

The setCookie() method takes an instance of Cookie as an argument.

You can clear a cookie via the clearCookie() method.

In addition to the Cookie::create() method, you can create a Cookie object from a raw header value using fromString() method. You can also use the with*() methods to change some Cookie property (or to build the entire Cookie using a fluent interface). Each with*() method returns a new object with the modified property:

1
2
3
4
5

$cookie = Cookie::create('foo')
    ->withValue('bar')
    ->withExpires(strtotime('Fri, 20-May-2011 15:25:52 GMT'))
    ->withDomain('.example.com')
    ->withSecure(true);

Managing the HTTP Cache

The Response class has a rich set of methods to manipulate the HTTP headers related to the cache:

• setPublic()
• setPrivate()
• expire()
• setExpires()
• setMaxAge()
• setSharedMaxAge()
• setStaleIfError()
• setStaleWhileRevalidate()
• setTtl()
• setClientTtl()
• setLastModified()
• setEtag()
• setVary()

The setCache() method can be used to set the most commonly used cache information in one method call:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

$response->setCache([
    'must_revalidate'  => false,
    'no_cache'         => false,
    'no_store'         => false,
    'no_transform'     => false,
    'public'           => true,
    'private'          => false,
    'proxy_revalidate' => false,
    'max_age'          => 600,
    's_maxage'         => 600,
    'stale_if_error'   => 86400,
    'stale_while_revalidate' => 60,
    'immutable'        => true,
    'last_modified'    => new \DateTime(),
    'etag'             => 'abcdef',
]);

To check if the Response validators (ETag, Last-Modified) match a conditional value specified in the client Request, use the isNotModified() method:

1
2
3

if ($response->isNotModified($request)) {
    $response->send();
}

If the Response is not modified, it sets the status code to 304 and removes the actual response content.

Redirecting the User

To redirect the client to another URL, you can use the RedirectResponse class:

1
2
3

use Symfony\Component\HttpFoundation\RedirectResponse;

$response = new RedirectResponse('http://example.com/');

Streaming a Response

The StreamedResponse class allows you to stream the Response back to the client. The response content is represented by a PHP callable instead of a string:

1
2
3
4
5
6
7
8
9
10
11

use Symfony\Component\HttpFoundation\StreamedResponse;

$response = new StreamedResponse();
$response->setCallback(function (): void {
    var_dump('Hello World');
    flush();
    sleep(2);
    var_dump('Hello World');
    flush();
});
$response->send();

1
2

// disables FastCGI buffering in nginx only for this response
$response->headers->set('X-Accel-Buffering', 'no');

Streaming a JSON Response

The StreamedJsonResponse allows to stream large JSON responses using PHP generators to keep the used resources low.

The class constructor expects an array which represents the JSON structure and includes the list of contents to stream. In addition to PHP generators, which are recommended to minimize memory usage, it also supports any kind of PHP Traversable containing JSON serializable data:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

use Symfony\Component\HttpFoundation\StreamedJsonResponse;

// any method or function returning a PHP Generator
function loadArticles(): \Generator {
     yield ['title' => 'Article 1'];
     yield ['title' => 'Article 2'];
     yield ['title' => 'Article 3'];
};

$response = new StreamedJsonResponse(
    // JSON structure with generators in which will be streamed as a list
    [
        '_embedded' => [
            'articles' => loadArticles(),
        ],
    ],
);

When loading data via Doctrine, you can use the toIterable() method to fetch results row by row and minimize resources consumption. See the Doctrine Batch processing documentation for more:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

public function __invoke(): Response
{
    return new StreamedJsonResponse(
        [
            '_embedded' => [
                'articles' => $this->loadArticles(),
            ],
        ],
    );
}

public function loadArticles(): \Generator
{
    // get the $entityManager somehow (e.g. via constructor injection)
    $entityManager = ...

    $queryBuilder = $entityManager->createQueryBuilder();
    $queryBuilder->from(Article::class, 'article');
    $queryBuilder->select('article.id')
        ->addSelect('article.title')
        ->addSelect('article.description');

    return $queryBuilder->getQuery()->toIterable();
}

If you return a lot of data, consider calling the flush function after some specific item count to send the contents to the browser:

1
2
3
4
5
6
7
8
9
10
11
12
13

public function loadArticles(): \Generator
{
    // ...

    $count = 0;
    foreach ($queryBuilder->getQuery()->toIterable() as $article) {
        yield $article;

        if (0 === ++$count % 100) {
            flush();
        }
    }
}

Serving Files

When sending a file, you must add a Content-Disposition header to your response. While creating this header for basic file downloads is straightforward, using non-ASCII filenames is more involved. The makeDisposition() abstracts the hard work behind a simple API:

1
2
3
4
5
6
7
8
9
10
11
12
13

use Symfony\Component\HttpFoundation\HeaderUtils;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\ResponseHeaderBag;

$fileContent = ...; // the generated file content
$response = new Response($fileContent);

$disposition = HeaderUtils::makeDisposition(
    HeaderUtils::DISPOSITION_ATTACHMENT,
    'foo.pdf'
);

$response->headers->set('Content-Disposition', $disposition);

Alternatively, if you are serving a static file, you can use a BinaryFileResponse:

1
2
3
4

use Symfony\Component\HttpFoundation\BinaryFileResponse;

$file = 'path/to/file.txt';
$response = new BinaryFileResponse($file);

The BinaryFileResponse will automatically handle Range and If-Range headers from the request. It also supports X-Sendfile (see for nginx and Apache). To make use of it, you need to determine whether or not the X-Sendfile-Type header should be trusted and call trustXSendfileTypeHeader() if it should:

1

BinaryFileResponse::trustXSendfileTypeHeader();

1
2
3
4
5
6
7
8
9
10

<IfModule mod_xsendfile.c>
  # This is already present somewhere...
  XSendFile on
  XSendFilePath ...some path...

  # This needs to be added:
  <IfModule mod_headers.c>
    RequestHeader set X-Sendfile-Type X-Sendfile
  </IfModule>
</IfModule>

With the BinaryFileResponse, you can still set the Content-Type of the sent file, or change its Content-Disposition:

1
2
3
4
5
6

// ...
$response->headers->set('Content-Type', 'text/plain');
$response->setContentDisposition(
    ResponseHeaderBag::DISPOSITION_ATTACHMENT,
    'filename.txt'
);

It is possible to delete the file after the response is sent with the deleteFileAfterSend() method. Please note that this will not work when the X-Sendfile header is set.

If the size of the served file is unknown (e.g. because it's being generated on the fly, or because a PHP stream filter is registered on it, etc.), you can pass a Stream instance to BinaryFileResponse. This will disable Range and Content-Length handling, switching to chunked encoding instead:

1
2
3
4
5

use Symfony\Component\HttpFoundation\BinaryFileResponse;
use Symfony\Component\HttpFoundation\File\Stream;

$stream = new Stream('path/to/stream');
$response = new BinaryFileResponse($stream);

Creating a JSON Response

Any type of response can be created via the Response class by setting the right content and headers. A JSON response might look like this:

1
2
3
4
5
6
7

use Symfony\Component\HttpFoundation\Response;

$response = new Response();
$response->setContent(json_encode([
    'data' => 123,
]));
$response->headers->set('Content-Type', 'application/json');

There is also a helpful JsonResponse class, which can make this even easier:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

use Symfony\Component\HttpFoundation\JsonResponse;

// if you know the data to send when creating the response
$response = new JsonResponse(['data' => 123]);

// if you don't know the data to send or if you want to customize the encoding options
$response = new JsonResponse();
// ...
// configure any custom encoding options (if needed, it must be called before "setData()")
//$response->setEncodingOptions(JsonResponse::DEFAULT_ENCODING_OPTIONS | \JSON_PRESERVE_ZERO_FRACTION);
$response->setData(['data' => 123]);

// if the data to send is already encoded in JSON
$response = JsonResponse::fromJsonString('{ "data": 123 }');

The JsonResponse class sets the Content-Type header to application/json and encodes your data to JSON when needed.

JSONP Callback

If you're using JSONP, you can set the callback function that the data should be passed to:

1

$response->setCallback('handleResponse');

In this case, the Content-Type header will be text/javascript and the response content will look like this:

1

handleResponse({'data': 123});