From 61a6563cfa15fa756576d5b90ceadeed7d7e104d Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Fri, 10 Mar 2023 15:25:46 -0500 Subject: [PATCH] APIv4 - Deprecate unnecessary constants --- Civi/Api4/Event/Events.php | 9 +++++++-- .../Event/Subscriber/ActivitySchemaMapSubscriber.php | 3 +-- .../Api4/Event/Subscriber/ContactSchemaMapSubscriber.php | 3 +-- .../Subscriber/MessageTemplateSchemaMapSubscriber.php | 3 +-- Civi/Api4/Service/Schema/SchemaMapBuilder.php | 3 +-- 5 files changed, 11 insertions(+), 10 deletions(-) diff --git a/Civi/Api4/Event/Events.php b/Civi/Api4/Event/Events.php index 70b5440085..1701f51fa0 100644 --- a/Civi/Api4/Event/Events.php +++ b/Civi/Api4/Event/Events.php @@ -12,15 +12,20 @@ namespace Civi\Api4\Event; +/** + * @deprecated + */ class Events { /** - * Build the database schema, allow adding of custom joins and tables. + * @deprecated + * Just use the string instead of the constant when listening for this event */ const SCHEMA_MAP_BUILD = 'api.schema_map.build'; /** - * Add back POST_SELECT_QUERY const due to Joomla upgrade failure + * @deprecated + * Unused - there is no longer an event with this name * https://lab.civicrm.org/dev/joomla/-/issues/28#note_39487 */ const POST_SELECT_QUERY = 'api.select_query.post'; diff --git a/Civi/Api4/Event/Subscriber/ActivitySchemaMapSubscriber.php b/Civi/Api4/Event/Subscriber/ActivitySchemaMapSubscriber.php index bf32edb1e4..66b8fee472 100644 --- a/Civi/Api4/Event/Subscriber/ActivitySchemaMapSubscriber.php +++ b/Civi/Api4/Event/Subscriber/ActivitySchemaMapSubscriber.php @@ -2,7 +2,6 @@ namespace Civi\Api4\Event\Subscriber; -use Civi\Api4\Event\Events; use Civi\Api4\Event\SchemaMapBuildEvent; use Civi\Api4\Service\Schema\Joinable\ExtraJoinable; use Civi\Api4\Service\Schema\Joinable\Joinable; @@ -18,7 +17,7 @@ class ActivitySchemaMapSubscriber extends \Civi\Core\Service\AutoService impleme */ public static function getSubscribedEvents() { return [ - Events::SCHEMA_MAP_BUILD => 'onSchemaBuild', + 'api.schema_map.build' => 'onSchemaBuild', ]; } diff --git a/Civi/Api4/Event/Subscriber/ContactSchemaMapSubscriber.php b/Civi/Api4/Event/Subscriber/ContactSchemaMapSubscriber.php index e5ef815663..c73b581cba 100644 --- a/Civi/Api4/Event/Subscriber/ContactSchemaMapSubscriber.php +++ b/Civi/Api4/Event/Subscriber/ContactSchemaMapSubscriber.php @@ -2,7 +2,6 @@ namespace Civi\Api4\Event\Subscriber; -use Civi\Api4\Event\Events; use Civi\Api4\Event\SchemaMapBuildEvent; use Civi\Api4\Service\Schema\Joinable\Joinable; use Symfony\Component\EventDispatcher\EventSubscriberInterface; @@ -17,7 +16,7 @@ class ContactSchemaMapSubscriber extends \Civi\Core\Service\AutoService implemen */ public static function getSubscribedEvents() { return [ - Events::SCHEMA_MAP_BUILD => 'onSchemaBuild', + 'api.schema_map.build' => 'onSchemaBuild', ]; } diff --git a/Civi/Api4/Event/Subscriber/MessageTemplateSchemaMapSubscriber.php b/Civi/Api4/Event/Subscriber/MessageTemplateSchemaMapSubscriber.php index 3f218f31c6..108c322f2f 100644 --- a/Civi/Api4/Event/Subscriber/MessageTemplateSchemaMapSubscriber.php +++ b/Civi/Api4/Event/Subscriber/MessageTemplateSchemaMapSubscriber.php @@ -2,7 +2,6 @@ namespace Civi\Api4\Event\Subscriber; -use Civi\Api4\Event\Events; use Civi\Api4\Event\SchemaMapBuildEvent; use Civi\Api4\Service\Schema\Joinable\Joinable; use Symfony\Component\EventDispatcher\EventSubscriberInterface; @@ -17,7 +16,7 @@ class MessageTemplateSchemaMapSubscriber extends \Civi\Core\Service\AutoService */ public static function getSubscribedEvents() { return [ - Events::SCHEMA_MAP_BUILD => 'onSchemaBuild', + 'api.schema_map.build' => 'onSchemaBuild', ]; } diff --git a/Civi/Api4/Service/Schema/SchemaMapBuilder.php b/Civi/Api4/Service/Schema/SchemaMapBuilder.php index 7401539fe2..1db48f17fb 100644 --- a/Civi/Api4/Service/Schema/SchemaMapBuilder.php +++ b/Civi/Api4/Service/Schema/SchemaMapBuilder.php @@ -13,7 +13,6 @@ namespace Civi\Api4\Service\Schema; use Civi\Api4\Entity; -use Civi\Api4\Event\Events; use Civi\Api4\Event\SchemaMapBuildEvent; use Civi\Api4\Service\Schema\Joinable\CustomGroupJoinable; use Civi\Api4\Service\Schema\Joinable\Joinable; @@ -52,7 +51,7 @@ class SchemaMapBuilder extends AutoService { $this->loadTables($map); $event = new SchemaMapBuildEvent($map); - $this->dispatcher->dispatch(Events::SCHEMA_MAP_BUILD, $event); + $this->dispatcher->dispatch('api.schema_map.build', $event); return $map; } -- 2.25.1