bug #32302 [Mime] Remove @internal annotations for the serialize methods (francoispluchino)

fabpot · fabpot · commit 50dfcaa8ef33 · 2019-07-03T18:27:00.000+02:00
This PR was merged into the 4.3 branch. Discussion ---------- [Mime] Remove @internal annotations for the serialize methods | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | yes (it's not really a bug) | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | ~ | License | MIT | Doc PR | ~ Currently, when we extend the `Symfony\Component\Mime\Message` and `Symfony\Component\Mime\MessageRaw` classes of the Mime component, we get 2 deprecation messages: ``` The "Symfony\Component\Mime\Message::__serialize()" method is considered internal. It may change without further notice. You should not extend it from "Vendor\FooMessage". ``` and ``` The "Symfony\Component\Mime\Message::__unserialize()" method is considered internal. It may change without further notice. You should not extend it from "Vendor\FooMessage". ``` However, we need to add properties to the new class, and so, we need to extend `__serialize()` and `__unserialize()` methods in the same way as `Symfony\Bridge\Twig\Mime\TemplatedEmail`, to know, retrieve the serialization of the parent class: ```php public function __serialize(): array { return [$this->foo, $this->bar, $this->baz, parent::__serialize()]; } public function __unserialize(array $data): void { [$this->foo, $this->bar, $this->baz, $parentData] = $data; parent::__unserialize($parentData); } ``` But given that the third-party components use another namespace, we get the 2 deprecation messages, while the 2 methods must be inevitably used and extended. Of course, the methods `serialize()` and `unserialize()` are always marked by the `@internal` annotation and the `final` keyword. This PR so deletes the 2 deprecation messages that should not be displayed. Commits ------- 8544a35 Remove @internal annotations for the serilize methods
diff --git a/src/Symfony/Component/Mime/Message.php b/src/Symfony/Component/Mime/Message.php
@@ -130,17 +130,11 @@ private function generateMessageId(string $email): string
         return bin2hex(random_bytes(16)).strstr($email, '@');
     }
 
-    /**
-     * @internal
-     */
     public function __serialize(): array
     {
         return [$this->headers, $this->body];
     }
 
-    /**
-     * @internal
-     */
     public function __unserialize(array $data): void
     {
         [$this->headers, $this->body] = $data;
diff --git a/src/Symfony/Component/Mime/RawMessage.php b/src/Symfony/Component/Mime/RawMessage.php
@@ -69,17 +69,11 @@ final public function unserialize($serialized)
         $this->__unserialize(unserialize($serialized));
     }
 
-    /**
-     * @internal
-     */
     public function __serialize(): array
     {
         return [$this->message];
     }
 
-    /**
-     * @internal
-     */
     public function __unserialize(array $data): void
     {
         [$this->message] = $data;

Original file line number	Diff line number	Diff line change
`@@ -130,17 +130,11 @@ private function generateMessageId(string $email): string`
`130`	`130`	`return bin2hex(random_bytes(16)).strstr($email, '@');`
`131`	`131`	`}`
`132`	`132`
`133`		`- /**`
`134`		`- * @internal`
`135`		`- */`
`136`	`133`	`public function __serialize(): array`
`137`	`134`	`{`
`138`	`135`	`return [$this->headers, $this->body];`
`139`	`136`	`}`
`140`	`137`
`141`		`- /**`
`142`		`- * @internal`
`143`		`- */`
`144`	`138`	`public function __unserialize(array $data): void`
`145`	`139`	`{`
`146`	`140`	`[$this->headers, $this->body] = $data;`
Original file line number	Diff line number	Diff line change
`@@ -69,17 +69,11 @@ final public function unserialize($serialized)`
`69`	`69`	`$this->__unserialize(unserialize($serialized));`
`70`	`70`	`}`
`71`	`71`
`72`		`- /**`
`73`		`- * @internal`
`74`		`- */`
`75`	`72`	`public function __serialize(): array`
`76`	`73`	`{`
`77`	`74`	`return [$this->message];`
`78`	`75`	`}`
`79`	`76`
`80`		`- /**`
`81`		`- * @internal`
`82`		`- */`
`83`	`77`	`public function __unserialize(array $data): void`
`84`	`78`	`{`
`85`	`79`	`[$this->message] = $data;`