interface BaseFormIdInterface

Provides an interface for a Form that has a base form ID.

This will become the $form_state['build_info']['base_form_id'] used to generate the name of hook_form_BASE_FORM_ID_alter().

Hierarchy

Expanded class hierarchy of BaseFormIdInterface

All classes that implement BaseFormIdInterface

2 files declare their use of BaseFormIdInterface
EntityFormControllerInterface.php in drupal/core/lib/Drupal/Core/Entity/EntityFormControllerInterface.php
Contains \Drupal\Core\Entity\EntityFormControllerInterface.
form.inc in drupal/core/includes/form.inc
Functions for form and batch generation and processing.

File

drupal/core/lib/Drupal/Core/Form/BaseFormIdInterface.php, line 16
Contains \Drupal\Core\Form\BaseFormIdInterface.

Namespace

Drupal\Core\Form
View source
interface BaseFormIdInterface extends FormInterface {

  /**
   * Returns a string identifying the base form.
   *
   * @return string|false
   *   The string identifying the base form or FALSE if this is not a base form.
   */
  public function getBaseFormID();

}

Members

Namesort descending Modifiers Type Description Overrides
BaseFormIdInterface::getBaseFormID public function Returns a string identifying the base form. 1
FormInterface::buildForm public function Form constructor. 36
FormInterface::getFormID public function Returns a unique string identifying the form. 90
FormInterface::submitForm public function Form submission handler. 55
FormInterface::validateForm public function Form validation handler. 27