Mercurial > hg > isophonics-drupal-site
annotate vendor/symfony/serializer/Encoder/DecoderInterface.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 decoders. |
Chris@0 | 18 * |
Chris@0 | 19 * @author Jordi Boggiano <j.boggiano@seld.be> |
Chris@0 | 20 */ |
Chris@0 | 21 interface DecoderInterface |
Chris@0 | 22 { |
Chris@0 | 23 /** |
Chris@0 | 24 * Decodes a string into PHP data. |
Chris@0 | 25 * |
Chris@0 | 26 * @param string $data Data to decode |
Chris@0 | 27 * @param string $format Format name |
Chris@14 | 28 * @param array $context Options that decoders have access to |
Chris@0 | 29 * |
Chris@0 | 30 * The format parameter specifies which format the data is in; valid values |
Chris@0 | 31 * depend on the specific implementation. Authors implementing this interface |
Chris@0 | 32 * are encouraged to document which formats they support in a non-inherited |
Chris@0 | 33 * phpdoc comment. |
Chris@0 | 34 * |
Chris@0 | 35 * @return mixed |
Chris@0 | 36 * |
Chris@0 | 37 * @throws UnexpectedValueException |
Chris@0 | 38 */ |
Chris@17 | 39 public function decode($data, $format, array $context = []); |
Chris@0 | 40 |
Chris@0 | 41 /** |
Chris@0 | 42 * Checks whether the deserializer can decode from given format. |
Chris@0 | 43 * |
Chris@14 | 44 * @param string $format Format name |
Chris@0 | 45 * |
Chris@0 | 46 * @return bool |
Chris@0 | 47 */ |
Chris@0 | 48 public function supportsDecoding($format); |
Chris@0 | 49 } |