vendor/symfony/serializer/Normalizer/DenormalizerInterface.php line 47

  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\BadMethodCallException;
  15. use Symfony\Component\Serializer\Exception\ExceptionInterface;
  16. use Symfony\Component\Serializer\Exception\ExtraAttributesException;
  17. use Symfony\Component\Serializer\Exception\InvalidArgumentException;
  18. use Symfony\Component\Serializer\Exception\LogicException;
  19. use Symfony\Component\Serializer\Exception\RuntimeException;
  20. use Symfony\Component\Serializer\Exception\UnexpectedValueException;
  22. /**
  23.  * @author Jordi Boggiano <j.boggiano@seld.be>
  24.  */
  25. interface DenormalizerInterface
  26. {
  27.     public const COLLECT_DENORMALIZATION_ERRORS = 'collect_denormalization_errors';
  29.     /**
  30.      * Denormalizes data back into an object of the given class.
  31.      *
  32.      * @param mixed       $data    Data to restore
  33.      * @param string      $type    The expected class to instantiate
  34.      * @param string|null $format  Format the given data was extracted from
  35.      * @param array       $context Options available to the denormalizer
  36.      *
  37.      * @return mixed
  38.      *
  39.      * @throws BadMethodCallException   Occurs when the normalizer is not called in an expected context
  40.      * @throws InvalidArgumentException Occurs when the arguments are not coherent or not supported
  41.      * @throws UnexpectedValueException Occurs when the item cannot be hydrated with the given data
  42.      * @throws ExtraAttributesException Occurs when the item doesn't have attribute to receive given data
  43.      * @throws LogicException           Occurs when the normalizer is not supposed to denormalize
  44.      * @throws RuntimeException         Occurs if the class cannot be instantiated
  45.      * @throws ExceptionInterface       Occurs for all the other cases of errors
  46.      */
  47.     public function denormalize(mixed $data, string $type, string $format = null, array $context = []);
  49.     /**
  50.      * Checks whether the given class is supported for denormalization by this normalizer.
  51.      *
  52.      * @param mixed       $data   Data to denormalize from
  53.      * @param string      $type   The class to which the data should be denormalized
  54.      * @param string|null $format The format being deserialized from
  55.      * @param array       $context Options available to the denormalizer
  56.      *
  57.      * @return bool
  58.      */
  59.     public function supportsDenormalization(mixed $data, string $type, string $format = null /* , array $context = [] */);
  60. }