interface QuickEditInPlaceEditorInterface in Quick Edit 7

Defines an interface for in-place editors plugins.

Hierarchy

• interface \QuickEditInPlaceEditorInterface

File

includes/QuickEditInPlaceEditorInterface.php, line 13

Contains Quick Edit's InPlaceEditorInterface.

interface QuickEditInPlaceEditorInterface {

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

  /**
   * Generates metadata that is needed specifically for this editor.
   *
   * Will only be called by QuickEditMetadataGeneratorInterface::generate()
   * when the passed in field instance & item values will use this in-place
   * editor.
   *
   * @param array $instance
   *   The field instance to be in-place edited.
   * @param array $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(array $instance, array $items);

  /**
   * Returns the attachments for this editor.
   *
   * @return array
   *   An array of attachments, for use with #attached.
   *
   * @see drupal_process_attached()
   */
  public function getAttachments();

}

Members

Name	Modifiers	Type	Description	Overrides
QuickEditInPlaceEditorInterface::getAttachments	public	function	Returns the attachments for this editor.	3
QuickEditInPlaceEditorInterface::getMetadata	public	function	Generates metadata that is needed specifically for this editor.	3
QuickEditInPlaceEditorInterface::isCompatible	public	function	Checks whether this in-place editor is compatible with a given field.	3