You are here

interface BaseFormIdInterface in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Core/Form/BaseFormIdInterface.php \Drupal\Core\Form\BaseFormIdInterface

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

This will become the $form_state->getBaseInfo()['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
ConfigTranslationFormBase.php in core/modules/config_translation/src/Form/ConfigTranslationFormBase.php
Contains \Drupal\config_translation\Form\ConfigTranslationFormBase.
EntityFormInterface.php in core/lib/Drupal/Core/Entity/EntityFormInterface.php
Contains \Drupal\Core\Entity\EntityFormInterface.

File

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|null
   *   The string identifying the base form or NULL 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. 2
FormInterface::buildForm public function Form constructor. 157
FormInterface::getFormId public function Returns a unique string identifying the form. 212
FormInterface::submitForm public function Form submission handler. 167
FormInterface::validateForm public function Form validation handler. 20