Contrib.social

Use constants for plugin IDs

Open on Drupal.org →
Created on 13 July 2024, about 1 year ago

Problem/Motivation

Currently plugin IDs are defined as string literals in plugin annotation/attributes. Any time you need to reference plugin you need to make sure you correctly type its ID.

Proposed resolution

Since we are converting plugin definitions to PHP attributes it should be possible to use PHP constants instead of string literals. I think this will ease refactoring and improve DX. No need to rely on phpstorm-meta for auto-completion.

Example

#[FieldType(
  id: self::ID,
  label: new TM('Example'),
  default_widget: ExampleWidget::ID,
  default_formatter: ExampleFormatter::ID,
  list_class: ExampleItemList::class,
)]
final class ExampleItem extends FieldItemBase {
  
  public const string ID = 'example';  

}

$fields['example'] = BaseFieldDefinition::create(Example::ID)
  ->setLabel(t('Example'))
  ->setDisplayOptions('form', ['type' => ExampleWidget::ID])
  ->setDisplayOptions('view', ['type' => ExampleFormatter::ID]);
✨ Feature request
Status

Active

Version

11.0 🔥

Component
Plugin  →

Last updated 3 days ago

Created by

🇷🇺Russia Chi

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

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024