FieldItemNormalizer.php in JSON:API 8

Namespace

Drupal\jsonapi\Normalizer

File

src/Normalizer/FieldItemNormalizer.php

<?php

namespace Drupal\jsonapi\Normalizer;

use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Field\FieldItemInterface;
use Drupal\Core\TypedData\TypedDataInternalPropertiesHelper;
use Drupal\jsonapi\Normalizer\Value\FieldItemNormalizerValue;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;

/**
 * Converts the Drupal field item object to a JSON API array structure.
 *
 * @internal
 */
class FieldItemNormalizer extends NormalizerBase {

  /**
   * The interface or class that this Normalizer supports.
   *
   * @var string
   */
  protected $supportedInterfaceOrClass = FieldItemInterface::class;

  /**
   * The formats that the Normalizer can handle.
   *
   * @var array
   */
  protected $formats = [
    'api_json',
  ];

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

    /** @var \Drupal\Core\TypedData\TypedDataInterface $property */
    $values = [];

    // We normalize each individual property, so each can do their own casting,
    // if needed.
    // @todo Remove this when JSON API requires Drupal 8.5 or newer.
    if (floatval(\Drupal::VERSION) >= 8.5) {
      $field_item = TypedDataInternalPropertiesHelper::getNonInternalProperties($field_item);
    }

    // @todo Use the constant \Drupal\serialization\Normalizer\CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY instead of the 'cacheability' string when JSON API requires Drupal 8.5 or newer.
    $context['cacheability'] = new CacheableMetadata();
    foreach ($field_item as $property_name => $property) {
      $values[$property_name] = $this->serializer
        ->normalize($property, $format, $context);
    }
    if (isset($context['langcode'])) {
      $values['lang'] = $context['langcode'];
    }

    // @todo Use the constant \Drupal\serialization\Normalizer\CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY instead of the 'cacheability' string when JSON API requires Drupal 8.5 or newer.
    $value = new FieldItemNormalizerValue($values, $context['cacheability']);
    unset($context['cacheability']);
    return $value;
  }

  /**
   * {@inheritdoc}
   */
  public function denormalize($data, $class, $format = NULL, array $context = []) {
    throw new UnexpectedValueException('Denormalization not implemented for JSON API');
  }

}

Classes

Name	Description
FieldItemNormalizer	Converts the Drupal field item object to a JSON API array structure.