minor #39451 [Serializer] Fix EncoderInterface::encode() return type (jeroennoten)

nicolas-grekas · nicolas-grekas · commit c052542e6582 · 2020-12-14T11:44:27.000+01:00
This PR was merged into the 4.4 branch. Discussion ---------- [Serializer] Fix EncoderInterface::encode() return type | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | N.A. | License | MIT | Doc PR | N.A. I might have missed something (in that case, please let me know), but I believe that `EncoderInterface::encode()` will and should always return a `string`. This makes more sense because `DecoderInterface::decode()` only accepts a string as input. Commits ------- ae6f054 Fix EncoderInterface::encode() return type
diff --git a/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php b/src/Symfony/Component/Serializer/Encoder/EncoderInterface.php
@@ -25,7 +25,7 @@ interface EncoderInterface
      * @param string $format  Format name
      * @param array  $context Options that normalizers/encoders have access to
      *
-     * @return string|int|float|bool
+     * @return string
      *
      * @throws UnexpectedValueException
      */
diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/ChainEncoderTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/ChainEncoderTest.php
@@ -67,9 +67,9 @@ public function testSupportsEncoding()
     public function testEncode()
     {
         $this->encoder1->expects($this->never())->method('encode');
-        $this->encoder2->expects($this->once())->method('encode');
+        $this->encoder2->expects($this->once())->method('encode')->willReturn('foo:123');
 
-        $this->chainEncoder->encode(['foo' => 123], self::FORMAT_2);
+        $this->assertSame('foo:123', $this->chainEncoder->encode(['foo' => 123], self::FORMAT_2));
     }
 
     public function testEncodeUnsupportedFormat()

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ interface EncoderInterface`
`25`	`25`	`* @param string $format Format name`
`26`	`26`	`* @param array $context Options that normalizers/encoders have access to`
`27`	`27`	`*`
`28`		`- * @return string\|int\|float\|bool`
	`28`	`+ * @return string`
`29`	`29`	`*`
`30`	`30`	`* @throws UnexpectedValueException`
`31`	`31`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -67,9 +67,9 @@ public function testSupportsEncoding()`
`67`	`67`	`public function testEncode()`
`68`	`68`	`{`
`69`	`69`	`$this->encoder1->expects($this->never())->method('encode');`
`70`		`- $this->encoder2->expects($this->once())->method('encode');`
	`70`	`+ $this->encoder2->expects($this->once())->method('encode')->willReturn('foo:123');`
`71`	`71`
`72`		`- $this->chainEncoder->encode(['foo' => 123], self::FORMAT_2);`
	`72`	`+ $this->assertSame('foo:123', $this->chainEncoder->encode(['foo' => 123], self::FORMAT_2));`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`public function testEncodeUnsupportedFormat()`