bug #11439 custom encoders interface signature (PandaaAgency)

OskarStark · OskarStark · commit 1afd1381024f · 2019-05-24T08:41:02.000+02:00
This PR was merged into the 4.2 branch. Discussion ---------- custom encoders interface signature Fixes the documentation about encoders that was wrong. Using `Symfony\Component\Serializer\Encoder\EncoderInterface` no `$context` parameter is passed to `supportsEncoding` method. You have to use the ContextAware version of it.  Commits ------- 754a62b custom encoders interface signature
diff --git a/serializer/custom_encoders.rst b/serializer/custom_encoders.rst
@@ -32,7 +32,7 @@ create your own encoder that uses the
             return Yaml::dump($data);
         }
 
-        public function supportsEncoding($format, array $context = [])
+        public function supportsEncoding($format)
         {
             return 'yaml' === $format;
         }
@@ -42,12 +42,18 @@ create your own encoder that uses the
             return Yaml::parse($data);
         }
 
-        public function supportsDecoding($format, array $context = [])
+        public function supportsDecoding($format)
         {
             return 'yaml' === $format;
         }
     }
 
+.. tip::
+
+    If you need access to ``$context`` in your ``supportsDecoding`` or ``supportsEncoding`` method, make sure
+    to implements ``Symfony\Component\Serializer\Encoder\ContextAwareEncoderInterface`` or ``Symfony\Component\Serializer\Encoder\ContextAwareEncoderInterface`` interface
+    
+    
 Registering it in your app
 --------------------------
 

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ create your own encoder that uses the`
`32`	`32`	`return Yaml::dump($data);`
`33`	`33`	`}`
`34`	`34`
`35`		`- public function supportsEncoding($format, array $context = [])`
	`35`	`+ public function supportsEncoding($format)`
`36`	`36`	`{`
`37`	`37`	`return 'yaml' === $format;`
`38`	`38`	`}`
`@@ -42,12 +42,18 @@ create your own encoder that uses the`
`42`	`42`	`return Yaml::parse($data);`
`43`	`43`	`}`
`44`	`44`
`45`		`- public function supportsDecoding($format, array $context = [])`
	`45`	`+ public function supportsDecoding($format)`
`46`	`46`	`{`
`47`	`47`	`return 'yaml' === $format;`
`48`	`48`	`}`
`49`	`49`	`}`
`50`	`50`
	`51`	`+.. tip::`
	`52`	`+`
	`53`	+ If you need access to ``$context`` in your ``supportsDecoding`` or ``supportsEncoding`` method, make sure
	`54`	+ to implements ``Symfony\Component\Serializer\Encoder\ContextAwareEncoderInterface`` or ``Symfony\Component\Serializer\Encoder\ContextAwareEncoderInterface`` interface
	`55`	`+`
	`56`	`+`
`51`	`57`	`Registering it in your app`
`52`	`58`	`--------------------------`
`53`	`59`