Chris@18: <?php
Chris@18: 
Chris@18: namespace Drupal\jsonapi\Serializer;
Chris@18: 
Chris@18: use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
Chris@18: use Symfony\Component\Serializer\Serializer as SymfonySerializer;
Chris@18: 
Chris@18: /**
Chris@18:  * Overrides the Symfony serializer to cordon off our incompatible normalizers.
Chris@18:  *
Chris@18:  * This service is for *internal* use only. It is not suitable for *any* reuse.
Chris@18:  * Backwards compatibility is in no way guaranteed and will almost certainly be
Chris@18:  * broken in the future.
Chris@18:  *
Chris@18:  * @link https://www.drupal.org/project/jsonapi/issues/2923779#comment-12407443
Chris@18:  *
Chris@18:  * @internal JSON:API maintains no PHP API since its API is the HTTP API. This
Chris@18:  *   class may change at any time and this will break any dependencies on it.
Chris@18:  *
Chris@18:  * @see https://www.drupal.org/project/jsonapi/issues/3032787
Chris@18:  * @see jsonapi.api.php
Chris@18:  */
Chris@18: final class Serializer extends SymfonySerializer {
Chris@18: 
Chris@18:   /**
Chris@18:    * A normalizer to fall back on when JSON:API cannot normalize an object.
Chris@18:    *
Chris@18:    * @var \Symfony\Component\Serializer\Normalizer\NormalizerInterface|\Symfony\Component\Serializer\Normalizer\DenormalizerInterface
Chris@18:    */
Chris@18:   protected $fallbackNormalizer;
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function __construct(array $normalizers = [], array $encoders = []) {
Chris@18:     foreach ($normalizers as $normalizer) {
Chris@18:       if (strpos(get_class($normalizer), 'Drupal\jsonapi\Normalizer') !== 0) {
Chris@18:         throw new \LogicException('JSON:API does not allow adding more normalizers!');
Chris@18:       }
Chris@18:     }
Chris@18:     parent::__construct($normalizers, $encoders);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Adds a secondary normalizer.
Chris@18:    *
Chris@18:    * This normalizer will be attempted when JSON:API has no applicable
Chris@18:    * normalizer.
Chris@18:    *
Chris@18:    * @param \Symfony\Component\Serializer\Normalizer\NormalizerInterface $normalizer
Chris@18:    *   The secondary normalizer.
Chris@18:    */
Chris@18:   public function setFallbackNormalizer(NormalizerInterface $normalizer) {
Chris@18:     $this->fallbackNormalizer = $normalizer;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function normalize($data, $format = NULL, array $context = []) {
Chris@18:     if ($this->selfSupportsNormalization($data, $format, $context)) {
Chris@18:       return parent::normalize($data, $format, $context);
Chris@18:     }
Chris@18:     if ($this->fallbackNormalizer->supportsNormalization($data, $format, $context)) {
Chris@18:       return $this->fallbackNormalizer->normalize($data, $format, $context);
Chris@18:     }
Chris@18:     return parent::normalize($data, $format, $context);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function denormalize($data, $type, $format = NULL, array $context = []) {
Chris@18:     if ($this->selfSupportsDenormalization($data, $type, $format, $context)) {
Chris@18:       return parent::denormalize($data, $type, $format, $context);
Chris@18:     }
Chris@18:     return $this->fallbackNormalizer->denormalize($data, $type, $format, $context);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function supportsNormalization($data, $format = NULL, array $context = []) {
Chris@18:     return $this->selfSupportsNormalization($data, $format, $context) || $this->fallbackNormalizer->supportsNormalization($data, $format, $context);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Checks whether this class alone supports normalization.
Chris@18:    *
Chris@18:    * @param mixed $data
Chris@18:    *   Data to normalize.
Chris@18:    * @param string $format
Chris@18:    *   The format being (de-)serialized from or into.
Chris@18:    * @param array $context
Chris@18:    *   (optional) Options available to the normalizer.
Chris@18:    *
Chris@18:    * @return bool
Chris@18:    *   Whether this class supports normalization for the given data.
Chris@18:    */
Chris@18:   private function selfSupportsNormalization($data, $format = NULL, array $context = []) {
Chris@18:     return parent::supportsNormalization($data, $format, $context);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * {@inheritdoc}
Chris@18:    */
Chris@18:   public function supportsDenormalization($data, $type, $format = NULL, array $context = []) {
Chris@18:     return $this->selfSupportsDenormalization($data, $type, $format, $context) || $this->fallbackNormalizer->supportsDenormalization($data, $type, $format, $context);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Checks whether this class alone supports denormalization.
Chris@18:    *
Chris@18:    * @param mixed $data
Chris@18:    *   Data to denormalize from.
Chris@18:    * @param string $type
Chris@18:    *   The class to which the data should be denormalized.
Chris@18:    * @param string $format
Chris@18:    *   The format being deserialized from.
Chris@18:    * @param array $context
Chris@18:    *   (optional) Options available to the denormalizer.
Chris@18:    *
Chris@18:    * @return bool
Chris@18:    *   Whether this class supports normalization for the given data and type.
Chris@18:    */
Chris@18:   private function selfSupportsDenormalization($data, $type, $format = NULL, array $context = []) {
Chris@18:     return parent::supportsDenormalization($data, $type, $format, $context);
Chris@18:   }
Chris@18: 
Chris@18: }