www.aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Form/BaseFormIdInterface.php

   1 <?php
   2
   3 namespace Drupal\Core\Form;
   4
   5 /**
   6  * Provides an interface for a Form that has a base form ID.
   7  *
   8  * This will become the $form_state->getBuildInfo()['base_form_id'] used to
   9  * generate the name of hook_form_BASE_FORM_ID_alter().
  10  */
  11 interface BaseFormIdInterface extends FormInterface {
  12
  13   /**
  14    * Returns a string identifying the base form.
  15    *
  16    * @return string|null
  17    *   The string identifying the base form or NULL if this is not a base form.
  18    */
  19   public function getBaseFormId();
  20
  21 }