interface FormEnhancerInterface in Flexiform 8

Interface for form enhancer plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\flexiform\FormEnhancer\FormEnhancerInterface

File

src/FormEnhancer/FormEnhancerInterface.php, line 11

Namespace

Drupal\flexiform\FormEnhancer

interface FormEnhancerInterface extends PluginInspectionInterface {

  /**
   * Set the form display object.
   *
   * @param \Drupal\flexiform\FlexiformEntityFormDisplayInterface $form_display
   *   The form display.
   *
   * @return \Drupal\flexiform\FormEnhancer\FormEnhancerInterface
   *   The form enhancer with the form display set. (For chaining).
   */
  public function setFormDisplay(FlexiformEntityFormDisplayInterface $form_display);

  /**
   * Whether this enhancer applies to a particular event.
   *
   * @param string $event
   *   The enhancer event name.
   *
   * @return bool
   *   True if the enhancer applies to a particular event.
   */
  public function applies($event);

}

Members

Name	Modifiers	Type	Description	Overrides
FormEnhancerInterface::applies	public	function	Whether this enhancer applies to a particular event.	1
FormEnhancerInterface::setFormDisplay	public	function	Set the form display object.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2