ComplexDataDefinitionNormalizer.php in JSON:API Schema 8

Namespace

Drupal\jsonapi_schema\Normalizer

File

src/Normalizer/ComplexDataDefinitionNormalizer.php

<?php

namespace Drupal\jsonapi_schema\Normalizer;

use Drupal\Core\TypedData\ComplexDataDefinitionInterface;
use Drupal\Core\TypedData\DataDefinitionInterface;
use Drupal\Core\TypedData\DataReferenceTargetDefinition;
use Drupal\Component\Utility\NestedArray;

/**
 * Normalizer for ComplexDataDefinitionInterface.
 *
 * ComplexDataDefinitions represent objects - compound values whose objects
 * have string keys. Almost all fields are complex in this way, with their key
 * data stored in an object property of "value". In turn, these objects are
 * wrapped in an array which is normalized by ListDataDefinitionNormalizer.
 */
class ComplexDataDefinitionNormalizer extends DataDefinitionNormalizer {

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

  /**
   * {@inheritdoc}
   */
  public function normalize($entity, $format = NULL, array $context = []) {
    assert($entity instanceof ComplexDataDefinitionInterface);
    $context['parent'] = $entity;
    $normalized = $this
      ->extractPropertyData($entity);
    $normalized['type'] = 'object';

    // Retrieve 'properties' and possibly 'required' nested arrays.
    $property_definitions = array_filter($entity
      ->getPropertyDefinitions(), function (DataDefinitionInterface $item) {
      return !$item
        ->isInternal();
    });
    $properties = $this
      ->normalizeProperties($property_definitions, $format, $context);
    $normalized = NestedArray::mergeDeep($normalized, $properties);
    if (count($property_definitions) == 1) {

      // If there is only one property, JSON API does not use the complex data.
      return $normalized['properties'][key($property_definitions)];
    }
    return $normalized;
  }

  /**
   * Determine if the current field is a reference field.
   *
   * @param \Drupal\Core\TypedData\ComplexDataDefinitionInterface $entity
   *   The complex data definition to be checked.
   * @param array $context
   *   The current serializer context.
   *
   * @return bool
   *   TRUE if it is a reference, FALSE otherwise.
   */
  protected function isReferenceField(ComplexDataDefinitionInterface $entity, array $context = NULL) {
    $main = $entity
      ->getPropertyDefinition($entity
      ->getMainPropertyName());

    // @todo use an interface or API call instead of an object check.
    return $main instanceof DataReferenceTargetDefinition;
  }

}

Classes

Name	Description
ComplexDataDefinitionNormalizer	Normalizer for ComplexDataDefinitionInterface.