minor #10579 Documented the HeaderUtils::makeDisposition() method (javiereguiluz)

javiereguiluz · javiereguiluz · commit b7648135a7ee · 2018-10-26T08:47:28.000+02:00
This PR was merged into the master branch. Discussion ---------- Documented the HeaderUtils::makeDisposition() method Fixes #10571. Commits ------- 4341e98 Documented the HeaderUtils::makeDisposition() method
diff --git a/components/http_foundation.rst b/components/http_foundation.rst
@@ -562,22 +562,26 @@ 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 easy, using
 non-ASCII filenames is more involving. The
-:method:`Symfony\\Component\\HttpFoundation\\ResponseHeaderBag::makeDisposition`
+:method:`Symfony\\Component\\HttpFoundation\\HeaderUtils::makeDisposition`
 abstracts the hard work behind a simple API::
 
+    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 = $response->headers->makeDisposition(
-        ResponseHeaderBag::DISPOSITION_ATTACHMENT,
+    $disposition = HeaderUtils::makeDisposition(
+        HeaderUtils::DISPOSITION_ATTACHMENT,
         'foo.pdf'
     );
 
     $response->headers->set('Content-Disposition', $disposition);
 
+.. versionadded:: 4.2
+    The static ``HeaderUtils::makeDisposition()`` method was introduced in Symfony 4.2.
+
 Alternatively, if you are serving a static file, you can use a
 :class:`Symfony\\Component\\HttpFoundation\\BinaryFileResponse`::
 
