interface ConfigurableFormEnhancerInterface in Flexiform 8

Interface for configurable form enhancers.

Hierarchy

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

2 files declare their use of ConfigurableFormEnhancerInterface

FlexiformEntityFormDisplay.php in src/FlexiformEntityFormDisplay.php

FlexiformEntityFormDisplayEditForm.php in src/Form/FlexiformEntityFormDisplayEditForm.php

File

src/FormEnhancer/ConfigurableFormEnhancerInterface.php, line 10

Namespace

Drupal\flexiform\FormEnhancer

interface ConfigurableFormEnhancerInterface extends FormEnhancerInterface {

  /**
   * The configuration form.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   *
   * @return array
   *   The form with any additions.
   */
  public function configurationForm(array $form, FormStateInterface $form_state);

  /**
   * The configuration form validation callback.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   */
  public function configurationFormValidate(array $form, FormStateInterface $form_state);

  /**
   * The configuration form submit callback.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   */
  public function configurationFormSubmit(array $form, FormStateInterface $form_state);

  /**
   * Get the configuration.
   *
   * @return array
   *   The configuration for the enhancer.
   */
  public function getConfiguration();

  /**
   * Set the configuration for the enhancer.
   *
   * @param array $configuration
   *   The configuration array.
   *
   * @return self
   *   The form enhancer.
   */
  public function setConfiguration(array $configuration);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableFormEnhancerInterface::configurationForm	public	function	The configuration form.	6
ConfigurableFormEnhancerInterface::configurationFormSubmit	public	function	The configuration form submit callback.	1
ConfigurableFormEnhancerInterface::configurationFormValidate	public	function	The configuration form validation callback.	1
ConfigurableFormEnhancerInterface::getConfiguration	public	function	Get the configuration.	1
ConfigurableFormEnhancerInterface::setConfiguration	public	function	Set the configuration for the enhancer.	1
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