class RelationshipNormalizer in Drupal 8

Normalizes a JSON:API relationship object.

@internal

Hierarchy

• class \Drupal\serialization\Normalizer\NormalizerBase implements \Symfony\Component\Serializer\SerializerAwareInterface, CacheableNormalizerInterface uses \Symfony\Component\Serializer\SerializerAwareTrait
  • class \Drupal\jsonapi\Normalizer\NormalizerBase
    • class \Drupal\jsonapi\Normalizer\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

class RelationshipNormalizer extends NormalizerBase {

  /**
   * {@inheritdoc}
   */
  protected $supportedInterfaceOrClass = Relationship::class;

  /**
   * {@inheritdoc}
   */
  public function normalize($object, $format = NULL, array $context = []) {
    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(),
    ]);
  }

}

Members

Name	Modifiers	Type	Description	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	Checks whether the given class is supported for normalization by this normalizer.	1
RelationshipNormalizer::$supportedInterfaceOrClass	protected	property	The interface or class that this Normalizer supports. Overrides NormalizerBase::$supportedInterfaceOrClass
RelationshipNormalizer::normalize	public	function	Normalizes an object into a set of arrays/scalars.