123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272 |
- <?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;
- use Symfony\Component\Serializer\Encoder\ChainDecoder;
- use Symfony\Component\Serializer\Encoder\ChainEncoder;
- use Symfony\Component\Serializer\Encoder\EncoderInterface;
- use Symfony\Component\Serializer\Encoder\DecoderInterface;
- use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
- use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
- use Symfony\Component\Serializer\Exception\LogicException;
- use Symfony\Component\Serializer\Exception\UnexpectedValueException;
- /**
- * Serializer serializes and deserializes data.
- *
- * objects are turned into arrays by normalizers.
- * arrays are turned into various output formats by encoders.
- *
- * $serializer->serialize($obj, 'xml')
- * $serializer->decode($data, 'xml')
- * $serializer->denormalize($data, 'Class', 'xml')
- *
- * @author Jordi Boggiano <j.boggiano@seld.be>
- * @author Johannes M. Schmitt <schmittjoh@gmail.com>
- * @author Lukas Kahwe Smith <smith@pooteeweet.org>
- * @author Kévin Dunglas <dunglas@gmail.com>
- */
- class Serializer implements SerializerInterface, NormalizerInterface, DenormalizerInterface, EncoderInterface, DecoderInterface
- {
- /**
- * @var Encoder\ChainEncoder
- */
- protected $encoder;
- /**
- * @var Encoder\ChainDecoder
- */
- protected $decoder;
- /**
- * @var array
- */
- protected $normalizers = array();
- /**
- * @var array
- */
- protected $normalizerCache = array();
- /**
- * @var array
- */
- protected $denormalizerCache = array();
- public function __construct(array $normalizers = array(), array $encoders = array())
- {
- foreach ($normalizers as $normalizer) {
- if ($normalizer instanceof SerializerAwareInterface) {
- $normalizer->setSerializer($this);
- }
- }
- $this->normalizers = $normalizers;
- $decoders = array();
- $realEncoders = array();
- foreach ($encoders as $encoder) {
- if ($encoder instanceof SerializerAwareInterface) {
- $encoder->setSerializer($this);
- }
- if ($encoder instanceof DecoderInterface) {
- $decoders[] = $encoder;
- }
- if ($encoder instanceof EncoderInterface) {
- $realEncoders[] = $encoder;
- }
- }
- $this->encoder = new ChainEncoder($realEncoders);
- $this->decoder = new ChainDecoder($decoders);
- }
- /**
- * {@inheritdoc}
- */
- final public function serialize($data, $format, array $context = array())
- {
- if (!$this->supportsEncoding($format)) {
- throw new UnexpectedValueException(sprintf('Serialization for the format %s is not supported', $format));
- }
- if ($this->encoder->needsNormalization($format)) {
- $data = $this->normalize($data, $format, $context);
- }
- return $this->encode($data, $format, $context);
- }
- /**
- * {@inheritdoc}
- */
- final public function deserialize($data, $type, $format, array $context = array())
- {
- if (!$this->supportsDecoding($format)) {
- throw new UnexpectedValueException(sprintf('Deserialization for the format %s is not supported', $format));
- }
- $data = $this->decode($data, $format, $context);
- return $this->denormalize($data, $type, $format, $context);
- }
- /**
- * {@inheritdoc}
- */
- public function normalize($data, $format = null, array $context = array())
- {
- // If a normalizer supports the given data, use it
- if ($normalizer = $this->getNormalizer($data, $format)) {
- return $normalizer->normalize($data, $format, $context);
- }
- if (null === $data || is_scalar($data)) {
- return $data;
- }
- if (is_array($data) || $data instanceof \Traversable) {
- $normalized = array();
- foreach ($data as $key => $val) {
- $normalized[$key] = $this->normalize($val, $format, $context);
- }
- return $normalized;
- }
- if (is_object($data)) {
- if (!$this->normalizers) {
- throw new LogicException('You must register at least one normalizer to be able to normalize objects.');
- }
- throw new UnexpectedValueException(sprintf('Could not normalize object of type %s, no supporting normalizer found.', get_class($data)));
- }
- throw new UnexpectedValueException(sprintf('An unexpected value could not be normalized: %s', var_export($data, true)));
- }
- /**
- * {@inheritdoc}
- */
- public function denormalize($data, $type, $format = null, array $context = array())
- {
- return $this->denormalizeObject($data, $type, $format, $context);
- }
- /**
- * {@inheritdoc}
- */
- public function supportsNormalization($data, $format = null)
- {
- return null !== $this->getNormalizer($data, $format);
- }
- /**
- * {@inheritdoc}
- */
- public function supportsDenormalization($data, $type, $format = null)
- {
- return null !== $this->getDenormalizer($data, $type, $format);
- }
- /**
- * Returns a matching normalizer.
- *
- * @param mixed $data Data to get the serializer for
- * @param string $format format name, present to give the option to normalizers to act differently based on formats
- *
- * @return NormalizerInterface|null
- */
- private function getNormalizer($data, $format)
- {
- foreach ($this->normalizers as $normalizer) {
- if ($normalizer instanceof NormalizerInterface && $normalizer->supportsNormalization($data, $format)) {
- return $normalizer;
- }
- }
- }
- /**
- * Returns a matching denormalizer.
- *
- * @param mixed $data data to restore
- * @param string $class the expected class to instantiate
- * @param string $format format name, present to give the option to normalizers to act differently based on formats
- *
- * @return DenormalizerInterface|null
- */
- private function getDenormalizer($data, $class, $format)
- {
- foreach ($this->normalizers as $normalizer) {
- if ($normalizer instanceof DenormalizerInterface && $normalizer->supportsDenormalization($data, $class, $format)) {
- return $normalizer;
- }
- }
- }
- /**
- * {@inheritdoc}
- */
- final public function encode($data, $format, array $context = array())
- {
- return $this->encoder->encode($data, $format, $context);
- }
- /**
- * {@inheritdoc}
- */
- final public function decode($data, $format, array $context = array())
- {
- return $this->decoder->decode($data, $format, $context);
- }
- /**
- * Denormalizes data back into an object of the given class.
- *
- * @param mixed $data data to restore
- * @param string $class the expected class to instantiate
- * @param string $format format name, present to give the option to normalizers to act differently based on formats
- * @param array $context The context data for this particular denormalization
- *
- * @return object
- *
- * @throws LogicException
- * @throws UnexpectedValueException
- */
- private function denormalizeObject($data, $class, $format, array $context = array())
- {
- if (!$this->normalizers) {
- throw new LogicException('You must register at least one normalizer to be able to denormalize objects.');
- }
- if ($normalizer = $this->getDenormalizer($data, $class, $format)) {
- return $normalizer->denormalize($data, $class, $format, $context);
- }
- throw new UnexpectedValueException(sprintf('Could not denormalize object of type %s, no supporting normalizer found.', $class));
- }
- /**
- * {@inheritdoc}
- */
- public function supportsEncoding($format)
- {
- return $this->encoder->supportsEncoding($format);
- }
- /**
- * {@inheritdoc}
- */
- public function supportsDecoding($format)
- {
- return $this->decoder->supportsDecoding($format);
- }
- }
|