class FormBaseAlterEvent in Hook Event Dispatcher 3.x

Class FormBaserAlterEvent.

Hierarchy

• class \Drupal\core_event_dispatcher\Event\Form\AbstractFormEvent extends \Symfony\Component\EventDispatcher\Event implements EventInterface
  • class \Drupal\core_event_dispatcher\Event\Form\FormBaseAlterEvent

2 files declare their use of FormBaseAlterEvent

core_event_dispatcher.module in modules/core_event_dispatcher/core_event_dispatcher.module

Core event dispatcher submodule.

ExampleFormEventSubscribers.php in examples/ExampleFormEventSubscribers.php

File

modules/core_event_dispatcher/src/Event/Form/FormBaseAlterEvent.php, line 10

Namespace

Drupal\core_event_dispatcher\Event\Form

class FormBaseAlterEvent extends AbstractFormEvent {

  /**
   * The base form id.
   *
   * @var string
   */
  private $baseFormId;

  /**
   * FormBaseAlterEvent constructor.
   *
   * @param array $form
   *   Nested array of form elements that comprise the form.
   * @param \Drupal\Core\Form\FormStateInterface $formState
   *   The current state of the form. The arguments that
   *   \Drupal::formBuilder()->getForm() was originally called with are
   *   available in the array $form_state->getBuildInfo()['args'].
   * @param string $formId
   *   String representing the name of the form itself. Typically this is the
   *   name of the function that generated the form.
   * @param string $baseFormId
   *   The base form id.
   */
  public function __construct(array &$form, FormStateInterface $formState, string $formId, string $baseFormId) {
    parent::__construct($form, $formState, $formId);
    $this->baseFormId = $baseFormId;
  }

  /**
   * {@inheritdoc}
   */
  public function getDispatcherType() : string {
    return 'hook_event_dispatcher.form_base_' . $this
      ->getBaseFormId() . '.alter';
  }

  /**
   * Get the base form id.
   *
   * @return string
   *   The base form id.
   */
  public function getBaseFormId() : string {
    return $this->baseFormId;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AbstractFormEvent::$form	private	property	The form.
AbstractFormEvent::$formId	private	property	The form id.
AbstractFormEvent::$formState	private	property	The form state.
AbstractFormEvent::getForm	public	function	Get the form.
AbstractFormEvent::getFormId	public	function	Get the form id.
AbstractFormEvent::getFormState	public	function	Get the form state.
FormBaseAlterEvent::$baseFormId	private	property	The base form id.
FormBaseAlterEvent::getBaseFormId	public	function	Get the base form id.
FormBaseAlterEvent::getDispatcherType	public	function	Get the dispatcher type. Overrides EventInterface::getDispatcherType
FormBaseAlterEvent::__construct	public	function	FormBaseAlterEvent constructor. Overrides AbstractFormEvent::__construct