class ListDataDefinitionNormalizer in JSON:API Schema 8

Normalizer for ListDataDefinitionInterface objects.

Almost all entity properties in the system are a list of values, each value in the "List" might be a ComplexDataDefinitionInterface (an object) or it might be more of a scalar.

Hierarchy

• class \Drupal\serialization\Normalizer\NormalizerBase implements \Symfony\Component\Serializer\SerializerAwareInterface, CacheableNormalizerInterface uses \Symfony\Component\Serializer\SerializerAwareTrait
  • class \Drupal\jsonapi_schema\Normalizer\DataDefinitionNormalizer
    • class \Drupal\jsonapi_schema\Normalizer\ListDataDefinitionNormalizer

1 string reference to 'ListDataDefinitionNormalizer'

jsonapi_schema.services.yml in ./jsonapi_schema.services.yml

jsonapi_schema.services.yml

1 service uses ListDataDefinitionNormalizer

serializer.normalizer.list_data_definition.schema_json in ./jsonapi_schema.services.yml

Drupal\jsonapi_schema\Normalizer\ListDataDefinitionNormalizer

File

src/Normalizer/ListDataDefinitionNormalizer.php, line 16

Namespace

Drupal\jsonapi_schema\Normalizer

class ListDataDefinitionNormalizer extends DataDefinitionNormalizer {

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

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

    // This retrieves the definition common to ever item in the list, and
    // serializes it so we can define how members of the array should look.
    // There are no lists that might contain items of different types.
    $property['items'] = $this->serializer
      ->normalize($list_data_definition
      ->getItemDefinition(), $format, $context);

    // FieldDefinitionInterface::isRequired() explicitly indicates there must be
    // at least one item in the list. Extending this reasoning, the same must be
    // true of all ListDataDefinitions.
    if ($this
      ->requiredProperty($list_data_definition)) {
      $property['minItems'] = 1;
    }
    if (!empty($context['cardinality']) && $context['cardinality'] === 1) {
      $single_property = $property['items'];
      unset($property['items']);
      unset($property['type']);
      unset($property['minItems']);
      $single_property = array_merge($single_property, $property);
      $property = $single_property;
    }
    $normalized = [
      'description' => t('Entity attributes'),
      'type' => 'object',
      'properties' => [],
    ];
    $public_name = $context['name'];
    $normalized['properties'][$public_name] = $property;
    if ($this
      ->requiredProperty($list_data_definition)) {
      $normalized['required'][] = $public_name;
    }
    return $normalized;
  }

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY		constant	Name of key for bubbling cacheability metadata via serialization context.
DataDefinitionNormalizer::$format	protected	property	The formats that the Normalizer can handle. Overrides NormalizerBase::$format
DataDefinitionNormalizer::$supportedDataTypes	protected	property	The supported data type.	6
DataDefinitionNormalizer::denormalize	public	function
DataDefinitionNormalizer::extractPropertyData	protected	function	Extracts property details from a data definition.	6
DataDefinitionNormalizer::JSON_TYPES		constant
DataDefinitionNormalizer::normalizeProperties	protected	function	Normalize an array of data definitions.
DataDefinitionNormalizer::requiredProperty	protected	function	Determine if the given property is a required element of the schema.
DataDefinitionNormalizer::supportsDenormalization	public	function	Implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface::supportsDenormalization() Overrides NormalizerBase::supportsDenormalization
DataDefinitionNormalizer::supportsNormalization	public	function	Checks whether the given class is supported for normalization by this normalizer. Overrides NormalizerBase::supportsNormalization	1
ListDataDefinitionNormalizer::$supportedInterfaceOrClass	protected	property	The interface or class that this Normalizer supports. Overrides DataDefinitionNormalizer::$supportedInterfaceOrClass	2
ListDataDefinitionNormalizer::isReferenceField	protected	function	Determine if the current field is a reference field.
ListDataDefinitionNormalizer::normalize	public	function	Overrides DataDefinitionNormalizer::normalize	2
NormalizerBase::addCacheableDependency	protected	function	Adds cacheability if applicable.
NormalizerBase::checkFormat	protected	function	Checks if the provided format is supported by this normalizer.	2