Deprecate "civi.api4.createRequest" event listener

The "civi.api4.createRequest" event will be removed in CiviCRM Core, see civicrm/civicrm-core#23311. The "civi.api4.entityTypes" event provides all necessary information.
systopia · Apr 27, 2022 · d1cf2d5 · d1cf2d5
1 parent f1ea640
commit d1cf2d5
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/Civi/Eck/API/Entity.php b/Civi/Eck/API/Entity.php
@@ -29,6 +29,10 @@ class Entity implements API_ProviderInterface, EventSubscriberInterface {
    */
   public static function getSubscribedEvents():array {
     return [
+      // TODO: "civi.api4.createRequest" will be removed in CiviCRM Core, see
+      //       https://github.com/civicrm/civicrm-core/pull/23311.
+      //       The "civi.api4.entityTypes" event provides all necessary
+      //       information.
       'civi.api4.createRequest' => [['onApi4CreateRequest', Events::W_EARLY]],
       'civi.api4.entityTypes' => [['onApi4EntityTypes', Events::W_EARLY]],
     ];
@@ -84,6 +88,11 @@ public function onApi4EntityTypes(GenericHookEvent $event) {
    * Callback for `civi.api4.createRequest` event.
    *
    * @param CreateApi4RequestEvent $event
+   *
+   * @deprecated
+   *   The "civi.api4.createRequest" event will be removed in CiviCRM Core, see
+   *   https://github.com/civicrm/civicrm-core/pull/23311.
+   *   The "civi.api4.entityTypes" event provides all necessary information.
    */
   public function onApi4CreateRequest(CreateApi4RequestEvent $event) {
     if (strpos($event->entityName, 'Eck_') === 0) {