From 568ce2c6de111064217eb5b69e6ec5e3e3dc3e38 Mon Sep 17 00:00:00 2001
From: catch <6915-catch@users.noreply.drupalcode.org>
Date: Tue, 3 Dec 2024 10:50:14 +0000
Subject: [PATCH] Issue #3482464 by nicxvan, berdir: Backport Hook and
 LegacyHook Attribute

(cherry picked from commit 5712beef56876595027d5bb9b91fe2b57972413f)
---
 core/lib/Drupal/Core/Hook/Attribute/Hook.php  | 56 +++++++++++++++++++
 .../Drupal/Core/Hook/Attribute/LegacyHook.php | 17 ++++++
 2 files changed, 73 insertions(+)
 create mode 100644 core/lib/Drupal/Core/Hook/Attribute/Hook.php
 create mode 100644 core/lib/Drupal/Core/Hook/Attribute/LegacyHook.php

diff --git a/core/lib/Drupal/Core/Hook/Attribute/Hook.php b/core/lib/Drupal/Core/Hook/Attribute/Hook.php
new file mode 100644
index 00000000000..822f7ba013e
--- /dev/null
+++ b/core/lib/Drupal/Core/Hook/Attribute/Hook.php
@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\Core\Hook\Attribute;
+
+/**
+ * This class will not have an effect until Drupal 11.1.0.
+ *
+ * This class is included in earlier Drupal versions to prevent phpstan errors
+ * for modules implementing object oriented hooks using the #Hook and
+ * #LegacyHook attributes.
+ */
+#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+class Hook {
+
+  /**
+   * Constructs a Hook attribute object.
+   *
+   * @param string $hook
+   *   The short hook name, without the 'hook_' prefix.
+   * @param string $method
+   *   (optional) The method name. If this attribute is on a method, this
+   *   parameter is not required. If this attribute is on a class and this
+   *   parameter is omitted, the class must have an __invoke() method, which is
+   *   taken as the hook implementation.
+   * @param int|null $priority
+   *   (optional) The priority of this implementation relative to other
+   *   implementations of this hook. Hook implementations with higher priority
+   *   are executed first. If omitted, the module order is used to order the
+   *   hook implementations.
+   * @param string|null $module
+   *   (optional) The module this implementation is for. This allows one module to
+   *   implement a hook on behalf of another module. Defaults to the module the
+   *   implementation is in.
+   */
+  public function __construct(
+    public string $hook,
+    public string $method = '',
+    public ?int $priority = NULL,
+    public ?string $module = NULL,
+  ) {}
+
+  /**
+   * Set the method the hook should apply to.
+   *
+   * @param string $method
+   *   The method that the hook attribute applies to.
+   *   This only needs to be set when the attribute is on the class.
+   */
+  public function setMethod(string $method): static {
+    $this->method = $method;
+    return $this;
+  }
+
+}
diff --git a/core/lib/Drupal/Core/Hook/Attribute/LegacyHook.php b/core/lib/Drupal/Core/Hook/Attribute/LegacyHook.php
new file mode 100644
index 00000000000..4e5864088b7
--- /dev/null
+++ b/core/lib/Drupal/Core/Hook/Attribute/LegacyHook.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Drupal\Core\Hook\Attribute;
+
+/**
+ * This class will not have an effect until Drupal 11.1.0.
+ *
+ * This class is included in earlier Drupal versions to prevent phpstan errors
+ * for modules implementing object oriented hooks using the #Hook and
+ * #LegacyHook attributes.
+ */
+#[\Attribute(\Attribute::TARGET_FUNCTION)]
+class LegacyHook {
+
+}