function FieldItemNormalizer::normalize

This normalizer leaves JSON:API normalizer land and enters the land of Drupal core's serialization system. That system was never designed with cacheability in mind, and hence bubbles cacheability out of band. This must catch it, and pass it to the value object that JSON:API uses.

File

core/modules/jsonapi/src/Normalizer/FieldItemNormalizer.php, line 57

Class

FieldItemNormalizer

Converts the Drupal field item object to a JSON:API array structure.

Namespace

Code

public function normalize($field_item, $format = NULL, array $context = []) : array|string|int|float|bool|\ArrayObject|null {
    assert($field_item instanceof FieldItemInterface);
    
    /** @var \Drupal\Core\TypedData\TypedDataInterface $property */
    $values = [];
    $context[CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY] = new CacheableMetadata();
    if (!empty($field_item->getProperties(TRUE))) {
        // We normalize each individual value, so each can do their own casting,
        // if needed.
        $field_properties = TypedDataInternalPropertiesHelper::getNonInternalProperties($field_item);
        foreach ($field_properties as $property_name => $property) {
            $values[$property_name] = $this->serializer
                ->normalize($property, $format, $context);
        }
        // Flatten if there is only a single property to normalize.
        $flatten = count($field_properties) === 1 && $field_item::mainPropertyName() !== NULL;
        $values = static::rasterizeValueRecursive($flatten ? reset($values) : $values);
    }
    else {
        $values = $field_item->getValue();
    }
    $normalization = new CacheableNormalization($context[CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY], $values);
    unset($context[CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY]);
    return $normalization;
}