Issue #3421019 by DanielVeza, sorlov, andypost, smustgrave, larowlan,...

Issue #3421019 by DanielVeza, sorlov, andypost, smustgrave, larowlan, mstrelan, alexpott: Convert SectionStorage plugin discovery to attributes

core/modules/layout_builder/src/Attribute/SectionStorage.php

+<?php
+
+namespace Drupal\layout_builder\Attribute;
+
+use Drupal\Component\Plugin\Attribute\Plugin;
+use Drupal\layout_builder\SectionStorage\SectionStorageDefinition;
+
+/**
+ * Defines a SectionStorage attribute.
+ *
+ * Plugin Namespace: Plugin\SectionStorage
+ *
+ * @see \Drupal\layout_builder\SectionStorage\SectionStorageManager
+ * @see plugin_api
+ */
+#[\Attribute(\Attribute::TARGET_CLASS)]
+class SectionStorage extends Plugin {
+
+  /**
+   * Constructs a SectionStorage attribute.
+   *
+   * @param string $id
+   *   The plugin ID.
+   * @param int $weight
+   *   (optional) The plugin weight.
+   *   When an entity with layout is rendered, section storage plugins are
+   *   checked, in order of their weight, to determine which one should be used
+   *   to render the layout.
+   * @param \Drupal\Component\Plugin\Context\ContextDefinitionInterface[] $context_definitions
+   *   (optional) Any required context definitions.
+   *   When an entity with layout is rendered, all section storage plugins which
+   *   match a particular set of contexts are checked, in order of their weight,
+   *   to determine which plugin should be used to render the layout.
+   *   @see \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface::findByContext()
+   * @param bool $handles_permission_check
+   *   (optional) Indicates that this section storage handles its own
+   *   permission checking. If FALSE, the 'configure any layout' permission
+   *   will be required during routing access. If TRUE, Layout Builder will
+   *   not enforce any access restrictions for the storage, so the section
+   *   storage's implementation of access() must perform the access checking itself.
+   * @param string|null $deriver
+   *   (optional) The deriver class.
+   */
+  public function __construct(
+    public readonly string $id,
+    public readonly int $weight = 0,
+    public readonly array $context_definitions = [],
+    public readonly bool $handles_permission_check = FALSE,
+    public readonly ?string $deriver = NULL,
+  ) {}
+
+  /**
+   * {@inheritdoc}
+   */
+  public function get(): SectionStorageDefinition {
+    return new SectionStorageDefinition([
+      'id' => $this->id,
+      'class' => $this->class,
+      'weight' => $this->weight,
+      'context_definitions' => $this->context_definitions,
+      'handles_permission_check' => $this->handles_permission_check,
+    ]);
+  }
+
+}

core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php

@@ -331,7 +331,7 @@ protected function buildSections(FieldableEntityInterface $entity) {
         $build[$delta] = $section->toRenderArray($contexts);
       }
     }
-    // The render array is built based on decisions made by @SectionStorage
+    // The render array is built based on decisions made by SectionStorage
     // plugins and therefore it needs to depend on the accumulated
     // cacheability of those decisions.
     $cacheability->applyTo($build);

core/modules/layout_builder/src/Plugin/SectionStorage/DefaultsSectionStorage.php

@@ -11,9 +11,13 @@
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Entity\FieldableEntityInterface;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\Core\Plugin\Context\ContextDefinition;
 use Drupal\Core\Plugin\Context\EntityContext;
+use Drupal\Core\Plugin\Context\EntityContextDefinition;
 use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Drupal\Core\Url;
+use Drupal\layout_builder\Attribute\SectionStorage;
 use Drupal\layout_builder\DefaultsSectionStorageInterface;
 use Drupal\layout_builder\Entity\SampleEntityGeneratorInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
@@ -28,18 +32,20 @@
  * - The default weight is 0, so other custom implementations will also take
  *   precedence unless otherwise specified.
  *
- * @SectionStorage(
- *   id = "defaults",
- *   weight = 20,
- *   context_definitions = {
- *     "display" = @ContextDefinition("entity:entity_view_display"),
- *     "view_mode" = @ContextDefinition("string", default_value = "default"),
- *   },
- * )
- *
  * @internal
  *   Plugin classes are internal.
  */
+#[SectionStorage(id: "defaults", weight: 20, context_definitions: [
+  "display" => new EntityContextDefinition(
+    data_type: "entity_view_display",
+    label: new TranslatableMarkup("Entity view display"),
+  ),
+  'view_mode' => new ContextDefinition(
+    data_type: 'string',
+    label: new TranslatableMarkup("View mode"),
+    default_value: "default",
+  ),
+])]
 class DefaultsSectionStorage extends SectionStorageBase implements ContainerFactoryPluginInterface, DefaultsSectionStorageInterface {
 
   /**

core/modules/layout_builder/src/Plugin/SectionStorage/OverridesSectionStorage.php

@@ -15,7 +15,9 @@
 use Drupal\Core\Plugin\Context\ContextDefinition;
 use Drupal\Core\Plugin\Context\EntityContext;
 use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Drupal\Core\Url;
+use Drupal\layout_builder\Attribute\SectionStorage;
 use Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay;
 use Drupal\layout_builder\OverridesSectionStorageInterface;
 use Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface;
@@ -31,21 +33,28 @@
  * - The default weight is 0, so custom implementations will not take
  *   precedence unless otherwise specified.
  *
- * @SectionStorage(
- *   id = "overrides",
- *   weight = -20,
- *   handles_permission_check = TRUE,
- *   context_definitions = {
- *     "entity" = @ContextDefinition("entity", constraints = {
- *       "EntityHasField" = \Drupal\layout_builder\Plugin\SectionStorage\OverridesSectionStorage::FIELD_NAME,
- *     }),
- *     "view_mode" = @ContextDefinition("string", default_value = "default"),
- *   }
- * )
- *
  * @internal
  *   Plugin classes are internal.
  */
+#[SectionStorage(
+  id: "overrides",
+  weight: -20,
+  context_definitions: [
+    'entity' => new ContextDefinition(
+      data_type: 'entity',
+      label: new TranslatableMarkup("Entity"),
+      constraints: [
+        "EntityHasField" => OverridesSectionStorage::FIELD_NAME,
+      ],
+    ),
+    'view_mode' => new ContextDefinition(
+      data_type: 'string',
+      label: new TranslatableMarkup("View mode"),
+      default_value: "default",
+    ),
+  ],
+  handles_permission_check: TRUE,
+)]
 class OverridesSectionStorage extends SectionStorageBase implements ContainerFactoryPluginInterface, OverridesSectionStorageInterface, SectionStorageLocalTaskProviderInterface {
 
   /**

core/modules/layout_builder/src/SectionStorage/SectionStorageManager.php

@@ -8,7 +8,7 @@
 use Drupal\Core\Extension\ModuleHandlerInterface;
 use Drupal\Core\Plugin\Context\ContextHandlerInterface;
 use Drupal\Core\Plugin\DefaultPluginManager;
-use Drupal\layout_builder\Annotation\SectionStorage;
+use Drupal\layout_builder\Attribute\SectionStorage;
 use Drupal\layout_builder\SectionStorageInterface;
 
 /**
@@ -43,7 +43,7 @@ class SectionStorageManager extends DefaultPluginManager implements SectionStora
    *   The context handler.
    */
   public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, ContextHandlerInterface $context_handler) {
-    parent::__construct('Plugin/SectionStorage', $namespaces, $module_handler, SectionStorageInterface::class, SectionStorage::class);
+    parent::__construct('Plugin/SectionStorage', $namespaces, $module_handler, SectionStorageInterface::class, SectionStorage::class, '\Drupal\layout_builder\Annotation\SectionStorage');
 
     $this->contextHandler = $context_handler;
 

core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/SectionStorage/SimpleConfigSectionStorage.php

@@ -11,7 +11,9 @@
 use Drupal\Core\Plugin\ContextAwarePluginTrait;
 use Drupal\Core\Plugin\PluginBase;
 use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Drupal\Core\Url;
+use Drupal\layout_builder\Attribute\SectionStorage;
 use Drupal\layout_builder\Plugin\SectionStorage\SectionStorageLocalTaskProviderInterface;
 use Drupal\layout_builder\Routing\LayoutBuilderRoutesTrait;
 use Drupal\layout_builder\Section;
@@ -22,14 +24,13 @@
 
 /**
  * Provides section storage utilizing simple config.
- *
- * @SectionStorage(
- *   id = "test_simple_config",
- *   context_definitions = {
- *     "config_id" = @ContextDefinition("string"),
- *   }
- * )
  */
+#[SectionStorage(id: "test_simple_config", context_definitions: [
+  "config_id" => new ContextDefinition(
+    data_type: "string",
+    label: new TranslatableMarkup("Configuration ID"),
+  ),
+])]
 class SimpleConfigSectionStorage extends PluginBase implements SectionStorageInterface, SectionStorageLocalTaskProviderInterface, ContainerFactoryPluginInterface {
 
   use ContextAwarePluginTrait;

core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/SectionStorage/TestStateBasedSectionStorage.php

@@ -4,6 +4,7 @@
 
 use Drupal\Core\Cache\RefinableCacheableDependencyInterface;
 use Drupal\Core\Session\AccountInterface;
+use Drupal\layout_builder\Attribute\SectionStorage;
 use Drupal\layout_builder\Plugin\SectionStorage\SectionStorageBase;
 use Drupal\layout_builder\Section;
 use Drupal\layout_builder\SectionComponent;
@@ -11,11 +12,8 @@
 
 /**
  * Provides a test section storage that is controlled by state.
- *
- * @SectionStorage(
- *   id = "layout_builder_test_state",
- * )
  */
+#[SectionStorage(id: "layout_builder_test_state")]
 class TestStateBasedSectionStorage extends SectionStorageBase {
 
   /**