[HttpFoundation] Deprecate null $format argument to Request::setFormat()

longwave · nicolas-grekas · commit 7b18f1a8cbd7 · 2025-11-02T09:41:14.000+01:00
diff --git a/UPGRADE-7.4.md b/UPGRADE-7.4.md
@@ -96,6 +96,7 @@ HttpFoundation
  * Deprecate using `Request::sendHeaders()` after headers have already been sent; use a `StreamedResponse` instead
  * Deprecate method `Request::get()`, use properties `->attributes`, `query` or `request` directly instead
  * Deprecate HTTP method override for methods GET, HEAD, CONNECT and TRACE; it will be ignored in Symfony 8.0
+ * Deprecate accepting null `$format` argument to `Request::setFormat()`
 
 HttpKernel
 ----------
diff --git a/src/Symfony/Component/HttpFoundation/CHANGELOG.md b/src/Symfony/Component/HttpFoundation/CHANGELOG.md
@@ -12,6 +12,7 @@ CHANGELOG
  * Deprecate method `Request::get()`, use properties `->attributes`, `query` or `request` directly instead
  * Make `Request::createFromGlobals()` parse the body of PUT, DELETE, PATCH and QUERY requests
  * Deprecate HTTP method override for methods GET, HEAD, CONNECT and TRACE; it will be ignored in Symfony 8.0
+ * Deprecate accepting null `$format` argument to `Request::setFormat()`
 
 7.3
 ---
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -1369,15 +1369,21 @@ public function getFormat(?string $mimeType/* , bool $subtypeFallback = false */
     /**
      * Associates a format with mime types.
      *
+     * @param string          $format    The format to set
      * @param string|string[] $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type)
      */
     public function setFormat(?string $format, string|array $mimeTypes): void
     {
+        if (null === $format) {
+            trigger_deprecation('symfony/http-foundation', '7.4', 'Passing "null" as the first argument of "%s()" is deprecated. The argument will be non-nullable in Symfony 8.0.', __METHOD__);
+            $format = '';
+        }
+
         if (null === static::$formats) {
             static::initializeFormats();
         }
 
-        static::$formats[$format ?? ''] = (array) $mimeTypes;
+        static::$formats[$format] = (array) $mimeTypes;
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -1369,15 +1369,21 @@ public function getFormat(?string $mimeType/* , bool $subtypeFallback = false */`
`1369`	`1369`	`/**`
`1370`	`1370`	`* Associates a format with mime types.`
`1371`	`1371`	`*`
	`1372`	`+ * @param string $format The format to set`
`1372`	`1373`	`* @param string\|string[] $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type)`
`1373`	`1374`	`*/`
`1374`	`1375`	`public function setFormat(?string $format, string\|array $mimeTypes): void`
`1375`	`1376`	`{`
	`1377`	`+ if (null === $format) {`
	`1378`	`+ trigger_deprecation('symfony/http-foundation', '7.4', 'Passing "null" as the first argument of "%s()" is deprecated. The argument will be non-nullable in Symfony 8.0.', __METHOD__);`
	`1379`	`+ $format = '';`
	`1380`	`+ }`
	`1381`	`+`
`1376`	`1382`	`if (null === static::$formats) {`
`1377`	`1383`	`static::initializeFormats();`
`1378`	`1384`	`}`
`1379`	`1385`
`1380`		`- static::$formats[$format ?? ''] = (array) $mimeTypes;`
	`1386`	`+ static::$formats[$format] = (array) $mimeTypes;`
`1381`	`1387`	`}`
`1382`	`1388`
`1383`	`1389`	`/**`