You are here

interface WebformUiElementFormInterface in Webform 6.x

Same name and namespace in other branches
  1. 8.5 modules/webform_ui/src/Form/WebformUiElementFormInterface.php \Drupal\webform_ui\Form\WebformUiElementFormInterface

Provides an interface for webform element webform.

Hierarchy

Expanded class hierarchy of WebformUiElementFormInterface

All classes that implement WebformUiElementFormInterface

File

modules/webform_ui/src/Form/WebformUiElementFormInterface.php, line 11

Namespace

Drupal\webform_ui\Form
View source
interface WebformUiElementFormInterface extends FormInterface, ContainerInjectionInterface {

  /**
   * Is new element.
   *
   * @return bool
   *   TRUE if this webform generating a new element.
   */
  public function isNew();

  /**
   * Return the webform associated with this form.
   *
   * @return \Drupal\webform\WebformInterface
   *   A form
   */
  public function getWebform();

  /**
   * Return the webform element associated with this form.
   *
   * @return \Drupal\webform\Plugin\WebformElementInterface
   *   A webform element.
   */
  public function getWebformElementPlugin();

  /**
   * Return the render element associated with this form.
   *
   * @return array
   *   An element.
   */
  public function getElement();

  /**
   * Return the render element's key associated with this form.
   *
   * This method allows form alter hooks to know the element's key, which
   * is not included in the element's properties.
   *
   * @return string
   *   The render element's key.
   */
  public function getKey();

  /**
   * Return the render element's parent key associated with this form.
   *
   * This method allows form alter hooks to know the element's parent key, which
   * is not included in the element's properties.
   *
   * @return string
   *   The render element's parent key.
   */
  public function getParentKey();

}

Members

Namesort descending Modifiers Type Description Overrides
ContainerInjectionInterface::create public static function Instantiates a new instance of this class. 75
FormInterface::buildForm public function Form constructor. 192
FormInterface::getFormId public function Returns a unique string identifying the form. 264
FormInterface::submitForm public function Form submission handler. 214
FormInterface::validateForm public function Form validation handler. 32
WebformUiElementFormInterface::getElement public function Return the render element associated with this form. 1
WebformUiElementFormInterface::getKey public function Return the render element's key associated with this form. 1
WebformUiElementFormInterface::getParentKey public function Return the render element's parent key associated with this form. 1
WebformUiElementFormInterface::getWebform public function Return the webform associated with this form. 1
WebformUiElementFormInterface::getWebformElementPlugin public function Return the webform element associated with this form. 1
WebformUiElementFormInterface::isNew public function Is new element. 1