interface InPlaceEditorInterface in Drupal 10

Defines an interface for in-place editors plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\quickedit\Plugin\InPlaceEditorInterface

See also

\Drupal\quickedit\Annotation\InPlaceEditor

\Drupal\quickedit\Plugin\InPlaceEditorBase

\Drupal\quickedit\Plugin\InPlaceEditorManager

Plugin API

1 file declares its use of InPlaceEditorInterface

Editor.php in core/modules/quickedit/src/Plugin/InPlaceEditor/Editor.php

File

core/modules/quickedit/src/Plugin/InPlaceEditorInterface.php, line 16

Namespace

Drupal\quickedit\Plugin

interface InPlaceEditorInterface extends PluginInspectionInterface {

  /**
   * Checks whether this in-place editor is compatible with a given field.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   The field values to be in-place edited.
   *
   * @return bool
   *   TRUE if it is compatible, FALSE otherwise.
   */
  public function isCompatible(FieldItemListInterface $items);

  /**
   * Generates metadata that is needed specifically for this editor.
   *
   * Will only be called by \Drupal\quickedit\MetadataGeneratorInterface::generate()
   * when the passed in field & item values will use this editor.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   The field values to be in-place edited.
   *
   * @return array
   *   A keyed array with metadata. Each key should be prefixed with the plugin
   *   ID of the editor.
   */
  public function getMetadata(FieldItemListInterface $items);

  /**
   * Returns the attachments for this editor.
   *
   * @return array
   *   An array of attachments, for use with #attached.
   *
   * @see \Drupal\Core\Render\AttachmentsResponseProcessorInterface::processAttachments()
   */
  public function getAttachments();

}