feature #40576 [Mime] Remove @internal from Headers methods (VincentLanglet)

fabpot · fabpot · commit f6159038edaa · 2021-03-31T13:46:29.000+02:00
This PR was merged into the 5.3-dev branch. Discussion ---------- [Mime] Remove @internal from Headers methods | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no  | Deprecations? | no  | Tickets | Fix #...  | License | MIT | Doc PR | symfony/symfony-docs#...   I don't understand why the methods - `Headers::getHeaderBody()` - `Headers::setHeaderBody()` - `Headers::getHeaderParameter()` - `Headers::setHeaderParameter()` are marked as internal. They are already used by others libraries, like https://github.com/symfony/mailchimp-mailer/blob/a6c3fa9aeaf83ad79445c9e7c072e15288bea3c9/Transport/MandrillApiTransport.php#L92 https://github.com/symfony/mailchimp-mailer/blob/a6c3fa9aeaf83ad79445c9e7c072e15288bea3c9/Transport/MandrillApiTransport.php#L99 The implementation shouldn't change so they could be under the BC promise. Plus they are useful, and I don't see any other way that reimplementing the method if we want to do something like ``` ->getHeaderParameter('Content-Disposition', 'name') ``` Commits ------- 592fb13 Remove internal annotation
diff --git a/UPGRADE-5.3.md b/UPGRADE-5.3.md
@@ -61,6 +61,11 @@ Messenger
  * Deprecated the `prefetch_count` parameter in the AMQP bridge, it has no effect and will be removed in Symfony 6.0
  * Deprecated the use of TLS option for Redis Bridge, use `rediss://127.0.0.1` instead of `redis://127.0.0.1?tls=1`
 
+Mime
+----
+
+ * Remove the internal annotation from the `getHeaderBody()` and `getHeaderParameter()` methods of the `Headers` class.
+
 Notifier
 --------
 
diff --git a/src/Symfony/Component/Mime/Header/Headers.php b/src/Symfony/Component/Mime/Header/Headers.php
@@ -254,9 +254,6 @@ public function toArray(): array
         return $arr;
     }
 
-    /**
-     * @internal
-     */
     public function getHeaderBody($name)
     {
         return $this->has($name) ? $this->get($name)->getBody() : null;
@@ -274,9 +271,6 @@ public function setHeaderBody(string $type, string $name, $body): void
         }
     }
 
-    /**
-     * @internal
-     */
     public function getHeaderParameter(string $name, string $parameter): ?string
     {
         if (!$this->has($name)) {
diff --git a/src/Symfony/Component/Mime/Tests/Header/HeadersTest.php b/src/Symfony/Component/Mime/Tests/Header/HeadersTest.php
@@ -279,4 +279,39 @@ public function testToArray()
             "Foo: =?utf-8?Q?aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa?=\r\n =?utf-8?Q?aaaa?=",
         ], $headers->toArray());
     }
+
+    public function testHeaderBody()
+    {
+        $headers = new Headers();
+        $this->assertNull($headers->getHeaderBody('Content-Type'));
+        $headers->setHeaderBody('Text', 'Content-Type', 'type');
+        $this->assertSame('type', $headers->getHeaderBody('Content-Type'));
+    }
+
+    public function testHeaderParameter()
+    {
+        $headers = new Headers();
+        $this->assertNull($headers->getHeaderParameter('Content-Disposition', 'name'));
+
+        $headers->addParameterizedHeader('Content-Disposition', 'name');
+        $headers->setHeaderParameter('Content-Disposition', 'name', 'foo');
+        $this->assertSame('foo', $headers->getHeaderParameter('Content-Disposition', 'name'));
+    }
+
+    public function testHeaderParameterNotDefined()
+    {
+        $headers = new Headers();
+
+        $this->expectException(\LogicException::class);
+        $headers->setHeaderParameter('Content-Disposition', 'name', 'foo');
+    }
+
+    public function testSetHeaderParameterNotParameterized()
+    {
+        $headers = new Headers();
+        $headers->addTextHeader('Content-Disposition', 'name');
+
+        $this->expectException(\LogicException::class);
+        $headers->setHeaderParameter('Content-Disposition', 'name', 'foo');
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -254,9 +254,6 @@ public function toArray(): array`
`254`	`254`	`return $arr;`
`255`	`255`	`}`
`256`	`256`
`257`		`- /**`
`258`		`- * @internal`
`259`		`- */`
`260`	`257`	`public function getHeaderBody($name)`
`261`	`258`	`{`
`262`	`259`	`return $this->has($name) ? $this->get($name)->getBody() : null;`
`@@ -274,9 +271,6 @@ public function setHeaderBody(string $type, string $name, $body): void`
`274`	`271`	`}`
`275`	`272`	`}`
`276`	`273`
`277`		`- /**`
`278`		`- * @internal`
`279`		`- */`
`280`	`274`	`public function getHeaderParameter(string $name, string $parameter): ?string`
`281`	`275`	`{`
`282`	`276`	`if (!$this->has($name)) {`