From d5f5cc4c7048eb5d3fedf2c0f599961ea5acba8b Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Fri, 25 Feb 2022 19:16:30 -0800
Subject: [PATCH] Civi\Test\HookInterface is now an alias for
 Civi\Core\HookInterface

This means that we don't need to maintain two copies of the docblock.

There's a strong expectation that the interfaces work equivalently.

It will be more forgiving if a consumer mixes up the names.
---
 Civi/Core/Event/EventScanner.php |  2 +-
 Civi/Test/HookInterface.php      | 49 +++-----------------------------
 2 files changed, 5 insertions(+), 46 deletions(-)

diff --git a/Civi/Core/Event/EventScanner.php b/Civi/Core/Event/EventScanner.php
index 0dc2f2123c..1a9c93f8f5 100644
--- a/Civi/Core/Event/EventScanner.php
+++ b/Civi/Core/Event/EventScanner.php
@@ -67,7 +67,7 @@ class EventScanner {
 
     $listenerMap = [];
     // These 2 interfaces do the same thing; one is meant for unit tests and the other for runtime code
-    if (is_subclass_of($class, '\Civi\Test\HookInterface') || is_subclass_of($class, '\Civi\Core\HookInterface')) {
+    if (is_subclass_of($class, '\Civi\Core\HookInterface')) {
       $listenerMap = static::mergeListenerMap($listenerMap, static::findFunctionListeners($class, $self));
     }
     if (is_subclass_of($class, '\Symfony\Component\EventDispatcher\EventSubscriberInterface')) {
diff --git a/Civi/Test/HookInterface.php b/Civi/Test/HookInterface.php
index 12b0cb7588..4bc4a58060 100644
--- a/Civi/Test/HookInterface.php
+++ b/Civi/Test/HookInterface.php
@@ -1,47 +1,6 @@
 <?php
 
-namespace Civi\Test;
-
-/**
- * Interface HookInterface
- * @package Civi\Test
- *
- * This interface allows you to subscribe to hooks as part of the test.
- * Simply create an eponymous hook function (e.g. `hook_civicrm_post()`).
- *
- * ```
- * class MyTest extends \PHPUnit_Framework_TestCase implements \Civi\Test\HookInterface {
- *   public function hook_civicrm_post($op, $objectName, $objectId, &$objectRef) {
- *     echo "Running hook_civicrm_post\n";
- *   }
- * }
- * ```
- *
- * Similarly, to subscribe using Symfony-style listeners, create function with the 'on_' prefix:
- *
- * ```
- * class MyTest extends \PHPUnit_Framework_TestCase implements \Civi\Test\HookInterface {
- *   public function on_civi_api_authorize(AuthorizeEvent $e): void {
- *     echo "Running civi.api.authorize\n";
- *   }
- *   public function on_hook_civicrm_post(GenericHookEvent $e): void {
- *     echo "Running hook_civicrm_post\n";
- *   }
- * }
- * ```
- *
- * At time of writing, there are a few limitations in how HookInterface is handled
- * by CiviTestListener:
- *
- *  - The test must execute in-process (aka HeadlessInterface; aka CIVICRM_UF==UnitTests).
- *    End-to-end tests (multi-process tests) are not supported.
- *  - Early bootstrap hooks (e.g. hook_civicrm_config) are not supported.
- *  - This does not support priorities or registering multiple listeners.
- *
- * If you need more advanced registration abilities, consider using `Civi::dispatcher()`
- * or `EventDispatcherInterface`.
- *
- * @see CiviTestListener
- */
-interface HookInterface {
-}
+// The interface `Civi\Test\HookInterface` was originally written for use in unit-tests.
+// It got promoted for use in more cases, but then the name became misleading.
+// Leave behind alias for backward compatibility.
+class_alias('Civi\Core\HookInterface', 'Civi\Test\HookInterface');
-- 
2.25.1