vendor/symfony/serializer/Normalizer/NormalizerInterface.php line 50

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Serializer\Normalizer;
  14. use Symfony\Component\Serializer\Exception\CircularReferenceException;
  15. use Symfony\Component\Serializer\Exception\ExceptionInterface;
  16. use Symfony\Component\Serializer\Exception\InvalidArgumentException;
  17. use Symfony\Component\Serializer\Exception\LogicException;
  19. /**
  20.  * @author Jordi Boggiano <j.boggiano@seld.be>
  21.  */
  22. interface NormalizerInterface
  23. {
  24.     /**
  25.      * Normalizes an object into a set of arrays/scalars.
  26.      *
  27.      * @param mixed       $object  Object to normalize
  28.      * @param string|null $format  Format the normalization result will be encoded as
  29.      * @param array       $context Context options for the normalizer
  30.      *
  31.      * @return array|string|int|float|bool|\ArrayObject|null \ArrayObject is used to make sure an empty object is encoded as an object not an array
  32.      *
  33.      * @throws InvalidArgumentException   Occurs when the object given is not a supported type for the normalizer
  34.      * @throws CircularReferenceException Occurs when the normalizer detects a circular reference when no circular
  35.      *                                    reference handler can fix it
  36.      * @throws LogicException             Occurs when the normalizer is not called in an expected context
  37.      * @throws ExceptionInterface         Occurs for all the other cases of errors
  38.      */
  39.     public function normalize(mixed $object, string $format = null, array $context = []);
  41.     /**
  42.      * Checks whether the given class is supported for normalization by this normalizer.
  43.      *
  44.      * @param mixed       $data    Data to normalize
  45.      * @param string|null $format The format being (de-)serialized from or into
  46.      * @param array       $context Context options for the normalizer
  47.      *
  48.      * @return bool
  49.      */
  50.     public function supportsNormalization(mixed $data, string $format = null /* , array $context = [] */);
  51. }