class RelationshipNormalizer

Same name and namespace in other branches
  1. 9 core/modules/jsonapi/src/Normalizer/RelationshipNormalizer.php \Drupal\jsonapi\Normalizer\RelationshipNormalizer
  2. 8.9.x core/modules/jsonapi/src/Normalizer/RelationshipNormalizer.php \Drupal\jsonapi\Normalizer\RelationshipNormalizer
  3. 11.x core/modules/jsonapi/src/Normalizer/RelationshipNormalizer.php \Drupal\jsonapi\Normalizer\RelationshipNormalizer

Normalizes a JSON:API relationship object.

@internal

Hierarchy

Expanded class hierarchy of RelationshipNormalizer

1 file declares its use of RelationshipNormalizer
RelationshipNormalizerTest.php in core/modules/jsonapi/tests/src/Kernel/Normalizer/RelationshipNormalizerTest.php
1 string reference to 'RelationshipNormalizer'
jsonapi.services.yml in core/modules/jsonapi/jsonapi.services.yml
core/modules/jsonapi/jsonapi.services.yml
1 service uses RelationshipNormalizer
serializer.normalizer.relationship.jsonapi in core/modules/jsonapi/jsonapi.services.yml
Drupal\jsonapi\Normalizer\RelationshipNormalizer

File

core/modules/jsonapi/src/Normalizer/RelationshipNormalizer.php, line 13

Namespace

Drupal\jsonapi\Normalizer
View on git.drupalcode.org
View source 
class RelationshipNormalizer extends NormalizerBase {
  
  /**
   * {@inheritdoc}
   */
  public function normalize($object, $format = NULL, array $context = []) : array|string|int|float|bool|\ArrayObject|null {
    assert($object instanceof Relationship);
    return CacheableNormalization::aggregate([
      'data' => $this->serializer
        ->normalize($object->getData(), $format, $context),
      'links' => $this->serializer
        ->normalize($object->getLinks(), $format, $context)
        ->omitIfEmpty(),
      'meta' => CacheableNormalization::permanent($object->getMeta())
        ->omitIfEmpty(),
    ]);
  }
  
  /**
   * {@inheritdoc}
   */
  public function hasCacheableSupportsMethod() : bool {
    @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use getSupportedTypes() instead. See https://www.drupal.org/node/3359695', E_USER_DEPRECATED);
    return TRUE;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getSupportedTypes(?string $format) : array {
    return [
      Relationship::class => TRUE,
    ];
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY constant Name of key for bubbling cacheability metadata via serialization context.
NormalizerBase::$format protected property List of formats which supports (de-)normalization. Overrides NormalizerBase::$format
NormalizerBase::addCacheableDependency protected function Adds cacheability if applicable.
NormalizerBase::checkFormat protected function Checks if the provided format is supported by this normalizer. Overrides NormalizerBase::checkFormat
NormalizerBase::rasterizeValueRecursive protected static function Rasterizes a value recursively.
NormalizerBase::supportsDenormalization public function Implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface::supportsDenormalization() 1
NormalizerBase::supportsNormalization public function 1
RelationshipNormalizer::getSupportedTypes public function Overrides NormalizerBase::getSupportedTypes
RelationshipNormalizer::hasCacheableSupportsMethod public function Overrides NormalizerBase::hasCacheableSupportsMethod
RelationshipNormalizer::normalize public function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.