Classes List

Symfony\Component\Serializer\Normalizer\NormalizerInterface

 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 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
<?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\Normalizer;

use Symfony\Component\Serializer\Exception\CircularReferenceException;
use Symfony\Component\Serializer\Exception\InvalidArgumentException;
use Symfony\Component\Serializer\Exception\LogicException;

/** * Defines the interface of normalizers. * * @author Jordi Boggiano <j.boggiano@seld.be> */
interface NormalizerInterface
{
    /** * Normalizes an object into a set of arrays/scalars. * * @param object $object Object to normalize * @param string $format Format the normalization result will be encoded as * @param array $context Context options for the normalizer * * @return array|string|int|float|bool * * @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 */
    public function normalize($object$format = nullarray $context = array());

    /** * Checks whether the given class is supported for normalization by this normalizer. * * @param mixed $data Data to normalize * @param string $format The format being (de-)serialized from or into * * @return bool */
    public function supportsNormalization($data$format = null);
}