Merge pull request #144 from Chi-teck/action-plugin-attribute

Use PHP attribute for action plugins
Chi-teck · Apr 14, 2024 · 0acf136 · 0acf136
2 parents 5dc84d5 + 6fef58a
commit 0acf136
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 21 deletions.
diff --git a/templates/Plugin/_action/action.twig b/templates/Plugin/_action/action.twig
@@ -7,7 +7,9 @@ namespace Drupal\{{ machine_name }}\Plugin\Action;
 
 {% sort %}
 use Drupal\Core\Access\AccessResultInterface;
+use Drupal\Core\Action\Attribute\Action;
 use Drupal\Core\Entity\ContentEntityInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
   {% if configurable %}
 use Drupal\Core\Action\ConfigurableActionBase;
 use Drupal\Core\Form\FormStateInterface;
@@ -26,13 +28,6 @@ use Symfony\Component\DependencyInjection\ContainerInterface;
 /**
  * Provides {{ plugin_label|article }} action.
  *
- * @Action(
- *   id = "{{ plugin_id }}",
- *   label = @Translation("{{ plugin_label }}"),
- *   type = "{{ entity_type }}",
- *   category = @Translation("{{ category }}"),
- * )
- *
  * @DCG
  * For updating entity fields consider extending FieldUpdateActionBase.
  * @see \Drupal\Core\Field\FieldUpdateActionBase
@@ -47,6 +42,12 @@ use Symfony\Component\DependencyInjection\ContainerInterface;
  * The whole action API is subject of change.
  * @see https://www.drupal.org/project/drupal/issues/2011038
  */
+#[Action(
+  id: '{{ plugin_id }}',
+  label: new TranslatableMarkup('{{ plugin_label }}'),
+  category: new TranslatableMarkup('{{ category }}'),
+  type: '{{ entity_type }}',
+)]
 final class {{ class }} extends {{ configurable ? 'ConfigurableActionBase' : 'ActionBase' }} {% if services %}implements ContainerFactoryPluginInterface {% endif %}{
 
 {% if services %}

diff --git a/tests/functional/Generator/Plugin/_action/_n_deps/_w_config/src/Plugin/Action/Foo.php b/tests/functional/Generator/Plugin/_action/_n_deps/_w_config/src/Plugin/Action/Foo.php
@@ -5,21 +5,16 @@
 namespace Drupal\example\Plugin\Action;
 
 use Drupal\Core\Access\AccessResultInterface;
+use Drupal\Core\Action\Attribute\Action;
 use Drupal\Core\Action\ConfigurableActionBase;
 use Drupal\Core\Entity\ContentEntityInterface;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 
 /**
  * Provides a Foo action.
  *
- * @Action(
- *   id = "example_foo",
- *   label = @Translation("Foo"),
- *   type = "node",
- *   category = @Translation("Custom"),
- * )
- *
  * @DCG
  * For updating entity fields consider extending FieldUpdateActionBase.
  * @see \Drupal\Core\Field\FieldUpdateActionBase
@@ -34,6 +29,12 @@
  * The whole action API is subject of change.
  * @see https://www.drupal.org/project/drupal/issues/2011038
  */
+#[Action(
+  id: 'example_foo',
+  label: new TranslatableMarkup('Foo'),
+  category: new TranslatableMarkup('Custom'),
+  type: 'node',
+)]
 final class Foo extends ConfigurableActionBase {
 
   /**

diff --git a/tests/functional/Generator/Plugin/_action/_w_deps/_n_config/src/Plugin/Action/Foo.php b/tests/functional/Generator/Plugin/_action/_w_deps/_n_config/src/Plugin/Action/Foo.php
@@ -6,22 +6,17 @@
 
 use Drupal\Core\Access\AccessResultInterface;
 use Drupal\Core\Action\ActionBase;
+use Drupal\Core\Action\Attribute\Action;
 use Drupal\Core\Entity\ContentEntityInterface;
 use Drupal\Core\Flood\FloodInterface;
 use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
 use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Provides a Foo action.
  *
- * @Action(
- *   id = "example_foo",
- *   label = @Translation("Foo"),
- *   type = "user",
- *   category = @Translation("My Actions"),
- * )
- *
  * @DCG
  * For updating entity fields consider extending FieldUpdateActionBase.
  * @see \Drupal\Core\Field\FieldUpdateActionBase
@@ -36,6 +31,12 @@
  * The whole action API is subject of change.
  * @see https://www.drupal.org/project/drupal/issues/2011038
  */
+#[Action(
+  id: 'example_foo',
+  label: new TranslatableMarkup('Foo'),
+  category: new TranslatableMarkup('My Actions'),
+  type: 'user',
+)]
 final class Foo extends ActionBase implements ContainerFactoryPluginInterface {
 
   /**