1. interface
  2. Drupal
  3. \
  4. quickedit
  5. \
  6. MetadataGeneratorInterface

MetadataGeneratorInterface

interface MetadataGeneratorInterface (View source)

Interface for generating in-place editing metadata.

Methods

array
generateEntityMetadata(EntityInterface $entity)

Generates in-place editing metadata for an entity.

array
generateFieldMetadata(FieldItemListInterface $items, string $view_mode)

Generates in-place editing metadata for an entity field.

Details

at line 23
array generateEntityMetadata(EntityInterface $entity)

Generates in-place editing metadata for an entity.

Parameters

EntityInterface $entity

The entity, in the language in which one of its fields is being edited.

Return Value

array

An array containing metadata with the following keys:

  • label: the user-visible label for the entity in the given language.

at line 41
array generateFieldMetadata(FieldItemListInterface $items, string $view_mode)

Generates in-place editing metadata for an entity field.

Parameters

FieldItemListInterface $items

The field values to be in-place edited.
string $view_mode

The view mode the field should be rerendered in.

Return Value

array

An array containing metadata with the following keys:

  • label: the user-visible label for the field.
  • access: whether the current user may edit the field or not.
  • editor: which editor should be used for the field.
  • aria: the ARIA label.
  • custom: (optional) any additional metadata that the editor provides.