QuickEditEditorSelectorInterface.php in Quick Edit 7

Contains Quick Edit's EditorSelectorInterface.

See also

Drupal 8's \Drupal\quickedit\EditorSelectorInterface.

File

includes/QuickEditEditorSelectorInterface.php

<?php

/**
 * @file
 * Contains Quick Edit's EditorSelectorInterface.
 *
 * @see Drupal 8's \Drupal\quickedit\EditorSelectorInterface.
 */

/**
 * Interface for selecting an in-place editor (an Editor plugin) for a field.
 */
interface QuickEditEditorSelectorInterface {

  /**
   * Returns the in-place editor (an Editor plugin) to use for a field.
   *
   * @param string $formatter_type
   *   The field's formatter type name.
   * @param array $instance
   *   The field's instance info.
   * @param array $items
   *   The field's item values.
   *
   * @return string|NULL
   *   The editor to use, or NULL to not enable in-place editing.
   */
  public function getEditor($formatter_type, array $instance, array $items);

  /**
   * Returns the attachments for all editors.
   *
   * @param array $editor_ids
   *   A list of all in-place editor IDs that should be attached.
   *
   * @return array
   *   An array of attachments, for use with #attached.
   *
   * @see drupal_process_attached()
   */
  public function getEditorAttachments(array $editor_ids);

}

Interfaces

Name	Description
QuickEditEditorSelectorInterface	Interface for selecting an in-place editor (an Editor plugin) for a field.