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