Fix comments, add PHPDoc

dunglas · dunglas · commit b418f2205995 · 2019-07-04T08:59:51.000+02:00
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -1347,6 +1347,8 @@ public function setFormat($format, $mimeTypes)
      *  * _format request attribute
      *  * $default
      *
+     * @see getPreferredFormat
+     *
      * @param string|null $default The default format
      *
      * @return string|null The request format
@@ -1563,19 +1565,26 @@ public function isNoCache()
         return $this->headers->hasCacheControlDirective('no-cache') || 'no-cache' == $this->headers->get('Pragma');
     }
 
+    /**
+     * Gets the preferred format for the response by inspecting, in the following order:
+     *   * the request format set using setRequestFormat
+     *   * the values of the Accept HTTP header
+     *   * the content type of the body of the request
+     */
     public function getPreferredFormat(?string $default = 'html'): ?string
     {
         if (null !== $this->preferredFormat) {
             return $this->preferredFormat;
         }
 
+        $preferredFormat = null;
         foreach ($this->getAcceptableContentTypes() as $contentType) {
-            if ($this->preferredFormat = $this->getFormat($contentType)) {
-                return $this->preferredFormat;
+            if ($preferredFormat = $this->getFormat($contentType)) {
+                break;
             }
         }
 
-        $this->preferredFormat = $this->getRequestFormat($this->getContentType());
+        $this->preferredFormat = $this->getRequestFormat($preferredFormat ?: $this->getContentType());
 
         return $this->preferredFormat ?: $default;
     }
diff --git a/src/Symfony/Component/HttpFoundation/Tests/RequestTest.php b/src/Symfony/Component/HttpFoundation/Tests/RequestTest.php
@@ -407,13 +407,13 @@ public function testGetPreferredFormat()
         $this->assertSame('json', $request->getPreferredFormat('json'));
 
         $request->setRequestFormat('atom');
-        $request->headers->set('Content-Type', 'application/json');
-        $request->headers->set('Accept', 'application/xml');
+        $request->headers->set('Accept', 'application/ld+json');
+        $request->headers->set('Content-Type', 'application/merge-patch+json');
         $this->assertSame('atom', $request->getPreferredFormat());
 
         $request = new Request();
-        $request->headers->set('Content-Type', 'application/json');
         $request->headers->set('Accept', 'application/xml');
+        $request->headers->set('Content-Type', 'application/json');
         $this->assertSame('xml', $request->getPreferredFormat());
 
         $request = new Request();

Original file line number	Diff line number	Diff line change
`@@ -1347,6 +1347,8 @@ public function setFormat($format, $mimeTypes)`
`1347`	`1347`	`* * _format request attribute`
`1348`	`1348`	`* * $default`
`1349`	`1349`	`*`
	`1350`	`+ * @see getPreferredFormat`
	`1351`	`+ *`
`1350`	`1352`	`* @param string\|null $default The default format`
`1351`	`1353`	`*`
`1352`	`1354`	`* @return string\|null The request format`
`@@ -1563,19 +1565,26 @@ public function isNoCache()`
`1563`	`1565`	`return $this->headers->hasCacheControlDirective('no-cache') \|\| 'no-cache' == $this->headers->get('Pragma');`
`1564`	`1566`	`}`
`1565`	`1567`
	`1568`	`+ /**`
	`1569`	`+ * Gets the preferred format for the response by inspecting, in the following order:`
	`1570`	`+ * * the request format set using setRequestFormat`
	`1571`	`+ * * the values of the Accept HTTP header`
	`1572`	`+ * * the content type of the body of the request`
	`1573`	`+ */`
`1566`	`1574`	`public function getPreferredFormat(?string $default = 'html'): ?string`
`1567`	`1575`	`{`
`1568`	`1576`	`if (null !== $this->preferredFormat) {`
`1569`	`1577`	`return $this->preferredFormat;`
`1570`	`1578`	`}`
`1571`	`1579`
	`1580`	`+ $preferredFormat = null;`
`1572`	`1581`	`foreach ($this->getAcceptableContentTypes() as $contentType) {`
`1573`		`- if ($this->preferredFormat = $this->getFormat($contentType)) {`
`1574`		`- return $this->preferredFormat;`
	`1582`	`+ if ($preferredFormat = $this->getFormat($contentType)) {`
	`1583`	`+ break;`
`1575`	`1584`	`}`
`1576`	`1585`	`}`
`1577`	`1586`
`1578`		`- $this->preferredFormat = $this->getRequestFormat($this->getContentType());`
	`1587`	`+ $this->preferredFormat = $this->getRequestFormat($preferredFormat ?: $this->getContentType());`
`1579`	`1588`
`1580`	`1589`	`return $this->preferredFormat ?: $default;`
`1581`	`1590`	`}`