Rename getContentType to getContentTypeFormat

MarkPedron · MarkPedron · commit c2c3b203313b · 2022-01-15T20:30:10.000+01:00
Resolves issue #39750. The method getContentType was confusing. This method does not return a mime type, but a mapped type name derived from the mime type in the CONTENT_TYPE header.
diff --git a/UPGRADE-6.1.md b/UPGRADE-6.1.md
@@ -1,6 +1,11 @@
 UPGRADE FROM 6.0 to 6.1
 =======================
 
+HttpFoundation
+--------------
+
+ * Deprecate `Request::getContentType()`, use `Request::getContentTypeFormat()` instead`
+
 Serializer
 ----------
 
diff --git a/src/Symfony/Component/HttpFoundation/CHANGELOG.md b/src/Symfony/Component/HttpFoundation/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.1
+---
+
+ * Deprecate `Request::getContentType()`, use `Request::getContentTypeFormat()` instead`
+
 6.0
 ---
 
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -1324,8 +1324,20 @@ public function setRequestFormat(?string $format)
 
     /**
      * Gets the format associated with the request.
+     *
+     * @deprecated since Symfony 6.1, use getContentTypeFormat instead
      */
     public function getContentType(): ?string
+    {
+        trigger_deprecation('symfony/http-foundation', '6.1', 'The method "%s" is deprecated, use "getContentTypeFormat" instead.', __METHOD__);
+
+        return $this->getContentTypeFormat();
+    }
+
+    /**
+     * Gets the format associated with the request.
+     */
+    public function getContentTypeFormat(): ?string
     {
         return $this->getFormat($this->headers->get('CONTENT_TYPE', ''));
     }
diff --git a/src/Symfony/Component/HttpFoundation/Tests/RequestTest.php b/src/Symfony/Component/HttpFoundation/Tests/RequestTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\HttpFoundation\Tests;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Component\HttpFoundation\Exception\ConflictingHeadersException;
 use Symfony\Component\HttpFoundation\Exception\JsonException;
 use Symfony\Component\HttpFoundation\Exception\SuspiciousOperationException;
@@ -23,6 +24,8 @@
 
 class RequestTest extends TestCase
 {
+    use ExpectDeprecationTrait;
+
     protected function tearDown(): void
     {
         Request::setTrustedProxies([], -1);
@@ -78,14 +81,27 @@ public function testIsNoCache()
         $this->assertFalse($isNoCache);
     }
 
+    /**
+     * @group legacy
+     */
     public function testGetContentType()
     {
+        $this->expectDeprecation('Since symfony/http-foundation 6.1: The method "Symfony\Component\HttpFoundation\Request::getContentType" is deprecated, use "getContentTypeFormat" instead.');
         $request = new Request();
+
         $contentType = $request->getContentType();
 
         $this->assertNull($contentType);
     }
 
+    public function testGetContentTypeFormat()
+    {
+        $request = new Request();
+        $contentType = $request->getContentTypeFormat();
+
+        $this->assertNull($contentType);
+    }
+
     public function testSetDefaultLocale()
     {
         $request = new Request();
