You are here

class ComplexDataDefinitionNormalizer in Schemata 8

Same name in this branch
  1. 8 schemata_json_schema/src/Normalizer/jsonapi/ComplexDataDefinitionNormalizer.php \Drupal\schemata_json_schema\Normalizer\jsonapi\ComplexDataDefinitionNormalizer
  2. 8 schemata_json_schema/src/Normalizer/json/ComplexDataDefinitionNormalizer.php \Drupal\schemata_json_schema\Normalizer\json\ComplexDataDefinitionNormalizer
  3. 8 schemata_json_schema/src/Normalizer/hal/ComplexDataDefinitionNormalizer.php \Drupal\schemata_json_schema\Normalizer\hal\ComplexDataDefinitionNormalizer

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.

Hierarchy

Expanded class hierarchy of ComplexDataDefinitionNormalizer

1 string reference to 'ComplexDataDefinitionNormalizer'
schemata_json_schema.services.yml in schemata_json_schema/schemata_json_schema.services.yml
schemata_json_schema/schemata_json_schema.services.yml
1 service uses ComplexDataDefinitionNormalizer
serializer.normalizer.complex_data_definition.schema_json.jsonapi in schemata_json_schema/schemata_json_schema.services.yml
Drupal\schemata_json_schema\Normalizer\jsonapi\ComplexDataDefinitionNormalizer

File

schemata_json_schema/src/Normalizer/jsonapi/ComplexDataDefinitionNormalizer.php, line 17

Namespace

Drupal\schemata_json_schema\Normalizer\jsonapi
View source
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 = []) {

    /* @var $entity \Drupal\Core\TypedData\ComplexDataDefinitionInterface */
    $context['parent'] = $entity;
    $normalized = $this
      ->extractPropertyData($entity);
    $normalized['type'] = 'object';

    // Retrieve 'properties' and possibly 'required' nested arrays.
    $property_definitions = $entity
      ->getPropertyDefinitions();
    $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;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY constant Name of key for bubbling cacheability metadata via serialization context.
ComplexDataDefinitionNormalizer::$supportedInterfaceOrClass protected property The interface or class that this Normalizer supports. Overrides DataDefinitionNormalizer::$supportedInterfaceOrClass
ComplexDataDefinitionNormalizer::isReferenceField protected function Determine if the current field is a reference field.
ComplexDataDefinitionNormalizer::normalize public function Normalizes an object into a set of arrays/scalars. Overrides DataDefinitionNormalizer::normalize
DataDefinitionNormalizer::$describedFormat protected property The formats that the Normalizer can handle. Overrides JsonNormalizerBase::$describedFormat
DataDefinitionNormalizer::$format protected property The formats that the Normalizer can handle. Overrides JsonNormalizerBase::$format
DataDefinitionNormalizer::extractPropertyData protected function Extracts property details from a data definition.
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::denormalize public function Denormalizes data back into an object of the given class.
NormalizerBase::normalizeProperties protected function Normalize an array of data definitions.
NormalizerBase::requiredProperty protected function Determine if the given property is a required element of the schema.
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. 1