ContextAwareEncoderInterface
interface ContextAwareEncoderInterface implements EncoderInterface
Adds the support of an extra $context parameter for the supportsEncoding method.
Methods
| scalar | encode(mixed $data, string $format, array $context = array()) Encodes data into the given format. | from EncoderInterface |
| bool | supportsEncoding(string $format, array $context = array()) Checks whether the serializer can encode to given format. |
Details
scalar encode(mixed $data, string $format, array $context = array())
Encodes data into the given format.
Parameters
| mixed | $data | Data to encode |
| string | $format | Format name |
| array | $context | options that normalizers/encoders have access to |
Return Value
| scalar |
Exceptions
| UnexpectedValueException |
bool supportsEncoding(string $format, array $context = array())
Checks whether the serializer can encode to given format.
Parameters
| string | $format | format name |
| array | $context |
Return Value
| bool |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Serializer/Encoder/ContextAwareEncoderInterface.html