class EntityNormalizer in JSON:API 8

Converts the Drupal entity object to a JSON API array structure.

@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\EntityNormalizer implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface uses SerializedColumnNormalizerTrait

Expanded class hierarchy of EntityNormalizer

File

src/Normalizer/EntityNormalizer.php, line 27

Namespace

Drupal\jsonapi\Normalizer

View source

class EntityNormalizer extends NormalizerBase implements DenormalizerInterface {
  use SerializedColumnNormalizerTrait;

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

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

  /**
   * The link manager.
   *
   * @var \Drupal\jsonapi\LinkManager\LinkManager
   */
  protected $linkManager;

  /**
   * The JSON API resource type repository.
   *
   * @var \Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface
   */
  protected $resourceTypeRepository;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs an EntityNormalizer object.
   *
   * @param \Drupal\jsonapi\LinkManager\LinkManager $link_manager
   *   The link manager.
   * @param \Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface $resource_type_repository
   *   The JSON API resource type repository.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(LinkManager $link_manager, ResourceTypeRepositoryInterface $resource_type_repository, EntityTypeManagerInterface $entity_type_manager) {
    $this->linkManager = $link_manager;
    $this->resourceTypeRepository = $resource_type_repository;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function normalize($entity, $format = NULL, array $context = []) {

    // If the fields to use were specified, only output those field values.
    $context['resource_type'] = $resource_type = $this->resourceTypeRepository
      ->get($entity
      ->getEntityTypeId(), $entity
      ->bundle());
    $resource_type_name = $resource_type
      ->getTypeName();

    // Get the bundle ID of the requested resource. This is used to determine if
    // this is a bundle level resource or an entity level resource.
    $bundle = $resource_type
      ->getBundle();
    if (!empty($context['sparse_fieldset'][$resource_type_name])) {
      $field_names = $context['sparse_fieldset'][$resource_type_name];
    }
    else {
      $field_names = $this
        ->getFieldNames($entity, $bundle, $resource_type);
    }

    /* @var Value\FieldNormalizerValueInterface[] $normalizer_values */
    $normalizer_values = [];
    $relationship_field_names = array_keys($resource_type
      ->getRelatableResourceTypes());
    foreach ($this
      ->getFields($entity, $bundle, $resource_type) as $field_name => $field) {
      $normalized_field = $this
        ->serializeField($field, $context, $format);
      assert($normalized_field instanceof FieldNormalizerValueInterface);
      $in_sparse_fieldset = in_array($field_name, $field_names);
      $is_relationship_field = in_array($field_name, $relationship_field_names);

      // Omit fields not listed in sparse fieldsets, except if they're fields
      // modeling relationships; despite a relationship field being omitted,
      // using `?include` to include related resources is still allowed.
      if (!$in_sparse_fieldset) {
        if ($is_relationship_field) {
          $is_null_field = $field instanceof NullFieldNormalizerValue;
          $has_includes = !empty($normalized_field
            ->getIncludes());
          if (!$is_null_field && $has_includes) {
            $normalizer_values[$field_name] = new IncludeOnlyRelationshipNormalizerValue($normalized_field);
          }
        }
        continue;
      }
      $normalizer_values[$field_name] = $normalized_field;
    }
    $link_context = [
      'link_manager' => $this->linkManager,
    ];
    return new EntityNormalizerValue($normalizer_values, $context, $entity, $link_context);
  }

  /**
   * {@inheritdoc}
   */
  public function denormalize($data, $class, $format = NULL, array $context = []) {
    if (empty($context['resource_type']) || !$context['resource_type'] instanceof ResourceType) {
      throw new PreconditionFailedHttpException('Missing context during denormalization.');
    }

    /* @var \Drupal\jsonapi\ResourceType\ResourceType $resource_type */
    $resource_type = $context['resource_type'];
    $entity_type_id = $resource_type
      ->getEntityTypeId();
    $bundle = $resource_type
      ->getBundle();
    $bundle_key = $this->entityTypeManager
      ->getDefinition($entity_type_id)
      ->getKey('bundle');
    if ($bundle_key && $bundle) {
      $data[$bundle_key] = $bundle;
    }
    return $this->entityTypeManager
      ->getStorage($entity_type_id)
      ->create($this
      ->prepareInput($data, $resource_type));
  }

  /**
   * Gets the field names for the given entity.
   *
   * @param mixed $entity
   *   The entity.
   * @param string $bundle
   *   The entity bundle.
   * @param \Drupal\jsonapi\ResourceType\ResourceType $resource_type
   *   The resource type.
   *
   * @return string[]
   *   The field names.
   */
  protected function getFieldNames($entity, $bundle, ResourceType $resource_type) {

    /* @var \Drupal\Core\Entity\ContentEntityInterface $entity */
    return array_keys($this
      ->getFields($entity, $bundle, $resource_type));
  }

  /**
   * Gets the field names for the given entity.
   *
   * @param mixed $entity
   *   The entity.
   * @param string $bundle
   *   The bundle id.
   * @param \Drupal\jsonapi\ResourceType\ResourceType $resource_type
   *   The resource type.
   *
   * @return array
   *   The fields.
   */
  protected function getFields($entity, $bundle, ResourceType $resource_type) {
    $output = [];

    // @todo Remove this when JSON API requires Drupal 8.5 or newer.
    if (floatval(\Drupal::VERSION) >= 8.5) {
      $fields = TypedDataInternalPropertiesHelper::getNonInternalProperties($entity
        ->getTypedData());
    }
    else {
      $fields = $entity
        ->getFields();
    }

    // Filter the array based on the field names.
    $enabled_field_names = array_filter(array_keys($fields), [
      $resource_type,
      'isFieldEnabled',
    ]);

    // Return a sub-array of $output containing the keys in $enabled_fields.
    $input = array_intersect_key($fields, array_flip($enabled_field_names));

    /* @var \Drupal\Core\Entity\ContentEntityInterface $entity */
    foreach ($input as $field_name => $field_value) {
      $public_field_name = $resource_type
        ->getPublicName($field_name);
      $output[$public_field_name] = $field_value;
    }
    return $output;
  }

  /**
   * Serializes a given field.
   *
   * @param mixed $field
   *   The field to serialize.
   * @param array $context
   *   The normalization context.
   * @param string $format
   *   The serialization format.
   *
   * @return Value\FieldNormalizerValueInterface
   *   The normalized value.
   */
  protected function serializeField($field, array $context, $format) {
    return $this->serializer
      ->normalize($field, $format, $context);
  }

  /**
   * Prepares the input data to create the entity.
   *
   * @param array $data
   *   The input data to modify.
   * @param \Drupal\jsonapi\ResourceType\ResourceType $resource_type
   *   Contains the info about the resource type.
   *
   * @return array
   *   The modified input data.
   */
  protected function prepareInput(array $data, ResourceType $resource_type) {
    $data_internal = [];

    // Translate the public fields into the entity fields.
    foreach ($data as $public_field_name => $field_value) {

      // Skip any disabled field.
      if (!$resource_type
        ->isFieldEnabled($public_field_name)) {
        continue;
      }
      $internal_name = $resource_type
        ->getInternalName($public_field_name);
      if ($resource_type
        ->getDeserializationTargetClass() instanceof FieldableEntityInterface) {

        // If $field_value contains items (recognizable by numerical array keys
        // which Drupal's Field API calls "deltas"), then it already is itemized;
        // it's not using the simplified JSON structure that JSON:API generates.
        $is_already_itemized = is_array($field_value) && array_reduce(array_keys($field_value), function ($carry, $index) {
          return $carry && is_numeric($index);
        }, TRUE);
        $itemized_data = $is_already_itemized ? $field_value : [
          0 => $field_value,
        ];
        try {
          $field_item = $this
            ->getFieldItemInstance($resource_type, $internal_name);
          foreach ($itemized_data as $delta => $field_item_value) {
            $this
              ->checkForSerializedStrings($field_item_value, get_class($field_item), $field_item);
            $serialized_property_names = $this
              ->getCustomSerializedPropertyNames($field_item);

            // Explicitly serialize the input, unlike properties that rely on
            // being automatically serialized, manually managed serialized
            // properties expect to receive serialized input.
            if (is_array($field_item_value)) {
              foreach ($serialized_property_names as $serialized_property_name) {
                if (!empty($field_item_value[$serialized_property_name])) {
                  $itemized_data[$delta][$serialized_property_name] = serialize($field_item_value[$serialized_property_name]);
                }
              }
            }
            elseif (in_array($field_item
              ->getDataDefinition()
              ->getMainPropertyName(), $serialized_property_names, TRUE)) {
              $itemized_data[$delta] = serialize($field_item_value);
            }
          }
        } catch (\InvalidArgumentException $e) {

          // The field does not exist, so there is no processing to be done. A
          // helpful error will be shown by EntityResource::createIndividual() or
          // EntityResource::patchIndividual().
        }
        $data_internal[$internal_name] = $is_already_itemized ? $itemized_data : $itemized_data[0];
      }
      else {
        $data_internal[$internal_name] = $field_value;
      }
    }
    return $data_internal;
  }

  /**
   * Gets a field item instance for use with SerializedColumnNormalizerTrait.
   *
   * @param \Drupal\jsonapi\ResourceType\ResourceType $resource_type
   *   The JSON:API resource type of the entity being denormalized.
   * @param string $field_name
   *   The name of the field to get a field item instance for.
   *
   * @return \Drupal\Core\Field\FieldItemInterface
   *   The requested field item instance.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function getFieldItemInstance(ResourceType $resource_type, $field_name) {
    if ($bundle_key = $this->entityTypeManager
      ->getDefinition($resource_type
      ->getEntityTypeId())
      ->getKey('bundle')) {
      $create_values = [
        $bundle_key => $resource_type
          ->getBundle(),
      ];
    }
    else {
      $create_values = [];
    }
    $entity = $this->entityTypeManager
      ->getStorage($resource_type
      ->getEntityTypeId())
      ->create($create_values);
    $field = $entity
      ->get($field_name);
    assert($field instanceof FieldItemListInterface);
    $field_item = $field
      ->appendItem();
    assert($field_item instanceof FieldItemInterface);
    return $field_item;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY		constant	Name of key for bubbling cacheability metadata via serialization context.
EntityNormalizer::$entityTypeManager	protected	property	The entity type manager.
EntityNormalizer::$formats	protected	property	The formats that the Normalizer can handle. Overrides NormalizerBase::$formats
EntityNormalizer::$linkManager	protected	property	The link manager.
EntityNormalizer::$resourceTypeRepository	protected	property	The JSON API resource type repository.
EntityNormalizer::$supportedInterfaceOrClass	protected	property	The interface or class that this Normalizer supports. Overrides NormalizerBase::$supportedInterfaceOrClass	1
EntityNormalizer::denormalize	public	function	Denormalizes data back into an object of the given class.
EntityNormalizer::getFieldItemInstance	protected	function	Gets a field item instance for use with SerializedColumnNormalizerTrait.
EntityNormalizer::getFieldNames	protected	function	Gets the field names for the given entity.
EntityNormalizer::getFields	protected	function	Gets the field names for the given entity.	1
EntityNormalizer::normalize	public	function	Normalizes an object into a set of arrays/scalars.
EntityNormalizer::prepareInput	protected	function	Prepares the input data to create the entity.
EntityNormalizer::serializeField	protected	function	Serializes a given field.	1
EntityNormalizer::__construct	public	function	Constructs an EntityNormalizer object.
NormalizerBase::$format	protected	property	List of formats which supports (de-)normalization.	3
NormalizerBase::addCacheableDependency	protected	function	Adds cacheability if applicable.
NormalizerBase::checkFormat	protected	function	Checks if the provided format is supported by this normalizer.	2
NormalizerBase::supportsDenormalization	public	function	Implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface::supportsDenormalization() Overrides NormalizerBase::supportsDenormalization
NormalizerBase::supportsNormalization	public	function	Checks whether the given class is supported for normalization by this normalizer. Overrides NormalizerBase::supportsNormalization
SerializedColumnNormalizerTrait::checkForSerializedStrings	protected	function	Checks if there is a serialized string for a column.
SerializedColumnNormalizerTrait::dataHasStringForSerializeColumn	protected	function	Checks if the data contains string value for serialize column.
SerializedColumnNormalizerTrait::getCustomSerializedPropertyNames	protected	function	Gets the names of all properties the plugin treats as serialized data.
SerializedColumnNormalizerTrait::getSerializedPropertyNames	protected	function	Gets the names of all serialized properties.

You are here

class EntityNormalizer in JSON:API 8

Hierarchy

File

Namespace

Members

API Navigation