You are here

interface ExtraFieldPlusDisplayInterface in Extra Field Settings Provider 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/ExtraFieldPlusDisplayInterface.php \Drupal\extra_field_plus\Plugin\ExtraFieldPlusDisplayInterface

Defines an interface for Extra Field Plus Display plugins.

Hierarchy

Expanded class hierarchy of ExtraFieldPlusDisplayInterface

All classes that implement ExtraFieldPlusDisplayInterface

File

src/Plugin/ExtraFieldPlusDisplayInterface.php, line 10

Namespace

Drupal\extra_field_plus\Plugin
View source
interface ExtraFieldPlusDisplayInterface extends ExtraFieldDisplayInterface {

  /**
   * Returns field settings.
   *
   * @return array
   *   The field settings.
   */
  public function getSettings();

  /**
   * Returns field setting.
   *
   * @param string $name
   *   Setting name.
   *
   * @return mixed|null
   *   The field setting or NULL if does not exist.
   */
  public function getSetting($name);

  /**
   * Returns field settings form.
   *
   * @return array
   *   The field settings form.
   *   Example: [key_1 => [...], key_2 => [...], ...].
   */
  public function getSettingsForm();

  /**
   * Returns field settings form default values.
   *
   * @return array
   *   The form values.
   *   Example: [key_1 => value_1, key_2 => value_2,...].
   */
  public function getDefaultFormValues();

}

Members

Namesort descending Modifiers Type Description Overrides
ExtraFieldPlusDisplayInterface::getDefaultFormValues public function Returns field settings form default values. 1
ExtraFieldPlusDisplayInterface::getSetting public function Returns field setting. 1
ExtraFieldPlusDisplayInterface::getSettings public function Returns field settings. 1
ExtraFieldPlusDisplayInterface::getSettingsForm public function Returns field settings form. 1