Classes List

Symfony\Component\Serializer\Serializer

 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 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 
 193 
 194 
 195 
 196 
 197 
 198 
 199 
 200 
 201 
 202 
 203 
 204 
 205 
 206 
 207 
 208 
 209 
 210 
 211 
 212 
 213 
 214 
 215 
 216 
 217 
 218 
 219 
 220 
 221 
 222 
 223 
 224 
 225 
 226 
 227 
 228 
 229 
 230 
 231 
 232 
 233 
 234 
 235 
 236 
 237 
 238 
 239 
 240 
 241 
 242 
 243 
 244 
 245 
 246 
 247 
 248 
 249 
 250 
 251 
 252 
 253 
 254 
 255 
 256 
 257 
 258 
 259 
 260 
 261 
 262 
 263 
 264 
 265 
 266 
 267 
 268 
 269 
 270 
 271 
 272 
 273 
 274 
 275 
 276 
 277 
 278 
 279 
 280 
 281 
 282 
 283 
 284 
 285 
 286 
 287 
 288 
 289 
 290 
 291 
 292 
 293 
 294 
 295 
 296 
 297 
 298 
 299 
 300 
 301 
 302 
 303 
 304 
 305 
 306 
 307 
 308 
 309 
 310 
 311 
 312 
 313 
 314 
 315 
 316 
 317 
 318 
 319 
 320 
 321 
 322 
 323 
 324 
 325 
<?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\Exception\NotEncodableValueException;
use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
use Symfony\Component\Serializer\Normalizer\DenormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
use Symfony\Component\Serializer\Exception\LogicException;

/** * 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 SerializerInterfaceNormalizerInterfaceDenormalizerInterfaceEncoderInterfaceDecoderInterface
{
    /** * @var Encoder\ChainEncoder */
    protected $encoder;

    /** * @var Encoder\ChainDecoder */
    protected $decoder;

    /** * @var array */
    protected $normalizers = array();

    /** * @var array * * @deprecated since 3.1 will be removed in 4.0 */
    protected $normalizerCache = array();

    /** * @var array * * @deprecated since 3.1 will be removed in 4.0 */
    protected $denormalizerCache = array();

    public function __construct(array $normalizers = array(), array $encoders = array())
    {
        foreach ($normalizers as $normalizer) {
            if ($normalizer instanceof SerializerAwareInterface) {
                $normalizer->setSerializer($this);
            }

            if ($normalizer instanceof DenormalizerAwareInterface) {
                $normalizer->setDenormalizer($this);
            }

            if ($normalizer instanceof NormalizerAwareInterface) {
                $normalizer->setNormalizer($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$formatarray $context = array())
    {
        if (!$this->supportsEncoding($format$context)) {
            throw new NotEncodableValueException(sprintf('Serialization for the format %s is not supported'$format));
        }

        if ($this->encoder->needsNormalization($format$context)) {
            $data = $this->normalize($data$format$context);
        }

        return $this->encode($data$format$context);
    }

    /** * {@inheritdoc} */
    final public function deserialize($data$type$formatarray $context = array())
    {
        if (!$this->supportsDecoding($format$context)) {
            throw new NotEncodableValueException(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 = nullarray $context = array())
    {
        // If a normalizer supports the given data, use it
        if ($normalizer = $this->getNormalizer($data$format$context)) {
            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 NotNormalizableValueException(sprintf('Could not normalize object of type %s, no supporting normalizer found.'\get_class($data)));
        }

        throw new NotNormalizableValueException(sprintf('An unexpected value could not be normalized: %s'var_export($datatrue)));
    }

    /** * {@inheritdoc} * * @throws NotNormalizableValueException */
    public function denormalize($data$type$format = nullarray $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$type$format$context)) {
            return $normalizer->denormalize($data$type$format$context);
        }

        throw new NotNormalizableValueException(sprintf('Could not denormalize object of type %s, no supporting normalizer found.'$type));
    }

    /** * {@inheritdoc} */
    public function supportsNormalization($data$format = null/*, array $context = array()*/
)
    {
        if (\func_num_args() > 2) {
            $context = \func_get_arg(2);
        } else {
            if (__CLASS__ !== \get_class($this)) {
                $r = new \ReflectionMethod($this__FUNCTION__);
                if (__CLASS__ !== $r->getDeclaringClass()->getName()) {
                    @trigger_error(sprintf('Method %s() will have a third `$context = array()` argument in version 4.0. Not defining it is deprecated since Symfony 3.3.'__METHOD__), E_USER_DEPRECATED);
                }
            }

            $context = array();
        }

        return null !== $this->getNormalizer($data$format$context);
    }

    /** * {@inheritdoc} */
    public function supportsDenormalization($data$type$format = null/*, array $context = array()*/
)
    {
        if (\func_num_args() > 3) {
            $context = \func_get_arg(3);
        } else {
            if (__CLASS__ !== \get_class($this)) {
                $r = new \ReflectionMethod($this__FUNCTION__);
                if (__CLASS__ !== $r->getDeclaringClass()->getName()) {
                    @trigger_error(sprintf('Method %s() will have a fourth `$context = array()` argument in version 4.0. Not defining it is deprecated since Symfony 3.3.'__METHOD__), E_USER_DEPRECATED);
                }
            }

            $context = array();
        }

        return null !== $this->getDenormalizer($data$type$format$context);
    }

    /** * 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 * @param array $context Options available to the normalizer * * @return NormalizerInterface|null */
    private function getNormalizer($data$formatarray $context)
    {
        foreach ($this->normalizers as $normalizer) {
            if ($normalizer instanceof NormalizerInterface && $normalizer->supportsNormalization($data$format$context)) {
                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 * @param array $context Options available to the denormalizer * * @return DenormalizerInterface|null */
    private function getDenormalizer($data$class$formatarray $context)
    {
        foreach ($this->normalizers as $normalizer) {
            if ($normalizer instanceof DenormalizerInterface && $normalizer->supportsDenormalization($data$class$format$context)) {
                return $normalizer;
            }
        }
    }

    /** * {@inheritdoc} */
    final public function encode($data$formatarray $context = array())
    {
        return $this->encoder->encode($data$format$context);
    }

    /** * {@inheritdoc} */
    final public function decode($data$formatarray $context = array())
    {
        return $this->decoder->decode($data$format$context);
    }

    /** * {@inheritdoc} */
    public function supportsEncoding($format/*, array $context = array()*/
)
    {
        if (\func_num_args() > 1) {
            $context = \func_get_arg(1);
        } else {
            if (__CLASS__ !== \get_class($this)) {
                $r = new \ReflectionMethod($this__FUNCTION__);
                if (__CLASS__ !== $r->getDeclaringClass()->getName()) {
                    @trigger_error(sprintf('Method %s() will have a second `$context = array()` argument in version 4.0. Not defining it is deprecated since Symfony 3.3.'__METHOD__), E_USER_DEPRECATED);
                }
            }

            $context = array();
        }

        return $this->encoder->supportsEncoding($format$context);
    }

    /** * {@inheritdoc} */
    public function supportsDecoding($format/*, array $context = array()*/
)
    {
        if (\func_num_args() > 1) {
            $context = \func_get_arg(1);
        } else {
            if (__CLASS__ !== \get_class($this)) {
                $r = new \ReflectionMethod($this__FUNCTION__);
                if (__CLASS__ !== $r->getDeclaringClass()->getName()) {
                    @trigger_error(sprintf('Method %s() will have a second `$context = array()` argument in version 4.0. Not defining it is deprecated since Symfony 3.3.'__METHOD__), E_USER_DEPRECATED);
                }
            }

            $context = array();
        }

        return $this->decoder->supportsDecoding($format$context);
    }
}