annotate vendor/symfony/serializer/Encoder/EncoderInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Serializer\Encoder;
Chris@0 13
Chris@0 14 use Symfony\Component\Serializer\Exception\UnexpectedValueException;
Chris@0 15
Chris@0 16 /**
Chris@0 17 * Defines the interface of encoders.
Chris@0 18 *
Chris@0 19 * @author Jordi Boggiano <j.boggiano@seld.be>
Chris@0 20 */
Chris@0 21 interface EncoderInterface
Chris@0 22 {
Chris@0 23 /**
Chris@0 24 * Encodes data into the given format.
Chris@0 25 *
Chris@0 26 * @param mixed $data Data to encode
Chris@0 27 * @param string $format Format name
Chris@14 28 * @param array $context Options that normalizers/encoders have access to
Chris@0 29 *
Chris@14 30 * @return string|int|float|bool
Chris@0 31 *
Chris@0 32 * @throws UnexpectedValueException
Chris@0 33 */
Chris@17 34 public function encode($data, $format, array $context = []);
Chris@0 35
Chris@0 36 /**
Chris@0 37 * Checks whether the serializer can encode to given format.
Chris@0 38 *
Chris@14 39 * @param string $format Format name
Chris@0 40 *
Chris@0 41 * @return bool
Chris@0 42 */
Chris@0 43 public function supportsEncoding($format);
Chris@0 44 }