Contrib.social

Add functions to generate event name by form id

Open on Drupal.org →
Created on 22 December 2022, over 2 years ago
Updated 3 October 2023, over 1 year ago

Problem/Motivation

It will be good to have a helper function that generates an event name from a form id string. It's not hard to generate manually, but need to always remember the format.

So the static helper function that does this will be a good helper for users!

Steps to reproduce

Now to hook a form or a base form by the form id values, developers have to compose the event name manually, like this:

  public static function getSubscribedEvents(): array {
    $formId = 'layout_builder_remove_block'
    $eventName = 'hook_event_dispatcher.' . $formId . '.alter';
    return [
      $eventName => ['alterRemoveForm'],
    ];
  }

Proposed resolution

Provide a helper function that will compose the right event name, to allow using this approach:

  public static function getSubscribedEvents(): array {
    return [
      FormAlterEvent::generateEventName('layout_builder_remove_block') => ['alterRemoveForm'],
    ];
  }

Remaining tasks

MR is ready, please review.

User interface changes

API changes

Implemented two helper functions to generate event names for forms by ids:

  • FormAlterEvent::generateEventName()
  • FormBaseAlterEvent::generateEventName()

Data model changes

✨ Feature request
Status

Needs review

Version

4.0

Component

Code

Created by

🇦🇲Armenia murz Yerevan, Armenia

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024