minor #9898 [HttpFoundation] Add info for getAcceptableFormats() method (AndreiIgna)

javiereguiluz · javiereguiluz · commit fbca6db693a3 · 2018-06-19T16:00:15.000+02:00
This PR was squashed before being merged into the master branch (closes #9898). Discussion ---------- [HttpFoundation] Add info for getAcceptableFormats() method Adds info for `Request::getAcceptableFormats()` Should it add more info on docs page? Ex: `Request::getAcceptableContentTypes` returns the accepted content types which can be `text/html`, `application/json`, etc. `Request::getAcceptableFormats` processes that and returns the formats based on those content types `html`, `json` ref symfony/symfony#26486 Commits ------- 65d100e [HttpFoundation] Add info for getAcceptableFormats() method
diff --git a/components/http_foundation.rst b/components/http_foundation.rst
@@ -290,6 +290,21 @@ by using the following methods:
 :method:`Symfony\\Component\\HttpFoundation\\Request::getAcceptableContentTypes`
     Returns the list of accepted content types ordered by descending quality.
 
+:method:`Symfony\\Component\\HttpFoundation\\Request::getAcceptableFormats`
+    Returns the list of accepted client formats associated with the request.
+
+Note that
+:method:`Symfony\\Component\\HttpFoundation\\Request::getAcceptableFormats`
+will use the data from
+:method:`Symfony\\Component\\HttpFoundation\\Request::getAcceptableContentTypes`
+and return the client acceptable formats::
+
+    $request->getAcceptableContentTypes();
+    // returns ['text/html', 'application/xhtml+xml', 'application/xml', '*/*']
+
+    $request->getAcceptableFormats();
+    // returns ['html', 'xml']
+
 :method:`Symfony\\Component\\HttpFoundation\\Request::getLanguages`
     Returns the list of accepted languages ordered by descending quality.
 
