bug #62246 [HttpFoundation] Allow Request::setFormat() to override predefined formats (longwave)

nicolas-grekas · nicolas-grekas · commit 6c6d8ed8fa12 · 2025-11-01T14:34:02.000+01:00
This PR was merged into the 6.4 branch. Discussion ---------- [HttpFoundation] Allow Request::setFormat() to override predefined formats | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #62226 | License | MIT Since #61267 some additional MIME formats are predefined; in order to override the predefined formats you must explictly deregister them. This PR changes the order so formats added later take precedence. Commits ------- 2402d16 [HttpFoundation] Allow Request::setFormat() to override predefined formats
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -1298,15 +1298,22 @@ public function getFormat(?string $mimeType): ?string
             static::initializeFormats();
         }
 
+        $exactFormat = null;
+        $canonicalFormat = null;
+
         foreach (static::$formats as $format => $mimeTypes) {
-            if (\in_array($mimeType, (array) $mimeTypes)) {
-                return $format;
+            if (\in_array($mimeType, $mimeTypes, true)) {
+                $exactFormat = $format;
             }
-            if (null !== $canonicalMimeType && \in_array($canonicalMimeType, (array) $mimeTypes)) {
-                return $format;
+            if (null !== $canonicalMimeType && \in_array($canonicalMimeType, $mimeTypes, true)) {
+                $canonicalFormat = $format;
             }
         }
 
+        if ($format = $exactFormat ?? $canonicalFormat) {
+            return $format;
+        }
+
         return null;
     }
 
@@ -1323,7 +1330,7 @@ public function setFormat(?string $format, string|array $mimeTypes)
             static::initializeFormats();
         }
 
-        static::$formats[$format] = \is_array($mimeTypes) ? $mimeTypes : [$mimeTypes];
+        static::$formats[$format ?? ''] = (array) $mimeTypes;
     }
 
     /**
diff --git a/src/Symfony/Component/HttpFoundation/Tests/Test/Constraint/ResponseFormatSameTest.php b/src/Symfony/Component/HttpFoundation/Tests/Test/Constraint/ResponseFormatSameTest.php
@@ -58,4 +58,14 @@ public function testNullFormat()
 
         $this->fail();
     }
+
+    public function testOverriddenFormat()
+    {
+        $request = new Request();
+        $request->setFormat('jsonapi', ['application/vnd.api+json']);
+        $request->setFormat('apijson', ['application/vnd.api+json']);
+
+        $constraint = new ResponseFormatSame($request, 'apijson');
+        $this->assertTrue($constraint->evaluate(new Response('', 200, ['Content-Type' => 'application/vnd.api+json']), '', true));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -1298,15 +1298,22 @@ public function getFormat(?string $mimeType): ?string`
`1298`	`1298`	`static::initializeFormats();`
`1299`	`1299`	`}`
`1300`	`1300`
	`1301`	`+ $exactFormat = null;`
	`1302`	`+ $canonicalFormat = null;`
	`1303`	`+`
`1301`	`1304`	`foreach (static::$formats as $format => $mimeTypes) {`
`1302`		`- if (\in_array($mimeType, (array) $mimeTypes)) {`
`1303`		`- return $format;`
	`1305`	`+ if (\in_array($mimeType, $mimeTypes, true)) {`
	`1306`	`+ $exactFormat = $format;`
`1304`	`1307`	`}`
`1305`		`- if (null !== $canonicalMimeType && \in_array($canonicalMimeType, (array) $mimeTypes)) {`
`1306`		`- return $format;`
	`1308`	`+ if (null !== $canonicalMimeType && \in_array($canonicalMimeType, $mimeTypes, true)) {`
	`1309`	`+ $canonicalFormat = $format;`
`1307`	`1310`	`}`
`1308`	`1311`	`}`
`1309`	`1312`
	`1313`	`+ if ($format = $exactFormat ?? $canonicalFormat) {`
	`1314`	`+ return $format;`
	`1315`	`+ }`
	`1316`	`+`
`1310`	`1317`	`return null;`
`1311`	`1318`	`}`
`1312`	`1319`
`@@ -1323,7 +1330,7 @@ public function setFormat(?string $format, string\|array $mimeTypes)`
`1323`	`1330`	`static::initializeFormats();`
`1324`	`1331`	`}`
`1325`	`1332`
`1326`		`- static::$formats[$format] = \is_array($mimeTypes) ? $mimeTypes : [$mimeTypes];`
	`1333`	`+ static::$formats[$format ?? ''] = (array) $mimeTypes;`
`1327`	`1334`	`}`
`1328`	`1335`
`1329`	`1336`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -58,4 +58,14 @@ public function testNullFormat()`
`58`	`58`
`59`	`59`	`$this->fail();`
`60`	`60`	`}`
	`61`	`+`
	`62`	`+ public function testOverriddenFormat()`
	`63`	`+ {`
	`64`	`+ $request = new Request();`
	`65`	`+ $request->setFormat('jsonapi', ['application/vnd.api+json']);`
	`66`	`+ $request->setFormat('apijson', ['application/vnd.api+json']);`
	`67`	`+`
	`68`	`+ $constraint = new ResponseFormatSame($request, 'apijson');`
	`69`	`+ $this->assertTrue($constraint->evaluate(new Response('', 200, ['Content-Type' => 'application/vnd.api+json']), '', true));`
	`70`	`+ }`
`61`	`71`	`}`