2011-01-18 19:17:24 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
/*
|
2012-03-31 22:00:32 +01:00
|
|
|
* This file is part of the Symfony package.
|
2011-01-18 19:17:24 +00:00
|
|
|
*
|
2011-03-06 11:40:06 +00:00
|
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
2011-01-18 19:17:24 +00:00
|
|
|
*
|
2012-03-31 22:00:32 +01:00
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
2011-01-18 19:17:24 +00:00
|
|
|
*/
|
|
|
|
|
2012-04-02 04:52:14 +01:00
|
|
|
namespace Symfony\Component\Serializer\Normalizer;
|
|
|
|
|
2017-03-31 10:20:07 +01:00
|
|
|
use Symfony\Component\Serializer\Exception\CircularReferenceException;
|
|
|
|
use Symfony\Component\Serializer\Exception\InvalidArgumentException;
|
|
|
|
use Symfony\Component\Serializer\Exception\LogicException;
|
|
|
|
|
2011-01-18 19:17:24 +00:00
|
|
|
/**
|
2011-05-06 18:04:22 +01:00
|
|
|
* Defines the interface of normalizers.
|
2011-01-18 19:17:24 +00:00
|
|
|
*
|
|
|
|
* @author Jordi Boggiano <j.boggiano@seld.be>
|
|
|
|
*/
|
|
|
|
interface NormalizerInterface
|
|
|
|
{
|
|
|
|
/**
|
2014-12-21 17:00:50 +00:00
|
|
|
* Normalizes an object into a set of arrays/scalars.
|
2011-01-18 19:17:24 +00:00
|
|
|
*
|
2017-10-28 19:51:46 +01:00
|
|
|
* @param object $object Object to normalize
|
|
|
|
* @param string $format Format the normalization result will be encoded as
|
2014-11-30 13:33:44 +00:00
|
|
|
* @param array $context Context options for the normalizer
|
2012-11-16 16:06:12 +00:00
|
|
|
*
|
2018-01-07 09:28:20 +00:00
|
|
|
* @return array|string|int|float|bool
|
2017-03-31 10:20:07 +01:00
|
|
|
*
|
|
|
|
* @throws InvalidArgumentException Occurs when the object given is not an attempted type for the normalizer
|
|
|
|
* @throws CircularReferenceException Occurs when the normalizer detects a circular reference when no circular
|
|
|
|
* reference handler can fix it
|
|
|
|
* @throws LogicException Occurs when the normalizer is not called in an expected context
|
2011-01-18 19:17:24 +00:00
|
|
|
*/
|
2013-01-18 13:08:59 +00:00
|
|
|
public function normalize($object, $format = null, array $context = array());
|
2011-11-08 20:54:41 +00:00
|
|
|
|
|
|
|
/**
|
2014-12-21 17:00:50 +00:00
|
|
|
* Checks whether the given class is supported for normalization by this normalizer.
|
2011-11-08 20:54:41 +00:00
|
|
|
*
|
2016-06-28 06:50:50 +01:00
|
|
|
* @param mixed $data Data to normalize
|
|
|
|
* @param string $format The format being (de-)serialized from or into
|
2012-11-16 16:06:12 +00:00
|
|
|
*
|
2014-04-16 11:30:19 +01:00
|
|
|
* @return bool
|
2011-11-08 20:54:41 +00:00
|
|
|
*/
|
2012-07-09 13:50:58 +01:00
|
|
|
public function supportsNormalization($data, $format = null);
|
2011-01-18 19:17:24 +00:00
|
|
|
}
|