From c8bc30181b5b15622359dc020346e90d3149d539 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Wed, 29 Dec 2021 21:35:29 -0600 Subject: [PATCH] MailingEventQueue - Use consistent short/camel-name. Unchanged --------- * XML: `xml/schema/Mailing/Event/Queue.xml` * DAO: `CRM/Mailing/Event/DAO/Queue.php` * BAO: `CRM/Mailing/Event/BAO/Queue.php` * APIv3: `api/v3/MailingEventQueue.php` Changes: Before --------------- * TLDR: Inconsistent mix of `MailingEventQueue` and `Queue` * `AllCoreTables` lists the short/CamelCaseName as `Queue`, which does not match the APIv3 name (`api/v3/MailingEventQueue.php`). * When formatting results for `MailingEventQueue.create`, it uses `_civicrm_api3_basic_create(...'Queue')`. Again, that name does not match `api/v3/MailingEventQueue.php`. (Substantively, this means that it may call `Queue.getfields` to read extra metadata. But this returns an empty list...) Changes: After --------------- * TLDR: Consistent use of `MailingEventQueue` * `AllCoreTables` lists the short/CamleCaseName as `MailingEventQueue` which does match the `api/v3/MailingEventQueue.php` * When formatting results for `MailingEventQueue.create`, it uses `_civicrm_api3_basic_create(...'MailingEventQueue')`. This matches. (Substantively, this means that it may call `MailingEventQueue.getfields` to read extra metadata. As before, this returns an empty list...) Comments -------- In reconciling the conflicted names, I looked at both APIv3 and APIv4. APIv4 does not expose an entity for this; so the Before+After ocuses on APIv3. --- CRM/Core/DAO/AllCoreTables.data.php | 2 +- CRM/Mailing/Event/DAO/Queue.php | 16 ++++++++-------- api/v3/MailingEventQueue.php | 2 +- tests/phpunit/api/v3/SyntaxConformanceTest.php | 1 - xml/schema/Mailing/Event/Queue.xml | 1 + 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CRM/Core/DAO/AllCoreTables.data.php b/CRM/Core/DAO/AllCoreTables.data.php index 930b9605f7..12b46189d6 100644 --- a/CRM/Core/DAO/AllCoreTables.data.php +++ b/CRM/Core/DAO/AllCoreTables.data.php @@ -603,7 +603,7 @@ return [ 'table' => 'civicrm_mailing_spool', ], 'CRM_Mailing_Event_DAO_Queue' => [ - 'name' => 'Queue', + 'name' => 'MailingEventQueue', 'class' => 'CRM_Mailing_Event_DAO_Queue', 'table' => 'civicrm_mailing_event_queue', ], diff --git a/CRM/Mailing/Event/DAO/Queue.php b/CRM/Mailing/Event/DAO/Queue.php index c5ef84e299..193a3905b0 100644 --- a/CRM/Mailing/Event/DAO/Queue.php +++ b/CRM/Mailing/Event/DAO/Queue.php @@ -6,11 +6,11 @@ * * Generated from xml/schema/CRM/Mailing/Event/Queue.xml * DO NOT EDIT. Generated by CRM_Core_CodeGen - * (GenCodeChecksum:64ec9770e9d859c3dba4512005c188be) + * (GenCodeChecksum:445426f940c37e15089892b45866ca06) */ /** - * Database access object for the Queue entity. + * Database access object for the MailingEventQueue entity. */ class CRM_Mailing_Event_DAO_Queue extends CRM_Core_DAO { const EXT = 'civicrm'; @@ -122,7 +122,7 @@ class CRM_Mailing_Event_DAO_Queue extends CRM_Core_DAO { 'required' => TRUE, 'where' => 'civicrm_mailing_event_queue.id', 'table_name' => 'civicrm_mailing_event_queue', - 'entity' => 'Queue', + 'entity' => 'MailingEventQueue', 'bao' => 'CRM_Mailing_Event_BAO_Queue', 'localizable' => 0, 'html' => [ @@ -139,7 +139,7 @@ class CRM_Mailing_Event_DAO_Queue extends CRM_Core_DAO { 'required' => TRUE, 'where' => 'civicrm_mailing_event_queue.job_id', 'table_name' => 'civicrm_mailing_event_queue', - 'entity' => 'Queue', + 'entity' => 'MailingEventQueue', 'bao' => 'CRM_Mailing_Event_BAO_Queue', 'localizable' => 0, 'FKClassName' => 'CRM_Mailing_DAO_MailingJob', @@ -156,7 +156,7 @@ class CRM_Mailing_Event_DAO_Queue extends CRM_Core_DAO { 'where' => 'civicrm_mailing_event_queue.email_id', 'default' => NULL, 'table_name' => 'civicrm_mailing_event_queue', - 'entity' => 'Queue', + 'entity' => 'MailingEventQueue', 'bao' => 'CRM_Mailing_Event_BAO_Queue', 'localizable' => 0, 'FKClassName' => 'CRM_Core_DAO_Email', @@ -173,7 +173,7 @@ class CRM_Mailing_Event_DAO_Queue extends CRM_Core_DAO { 'required' => TRUE, 'where' => 'civicrm_mailing_event_queue.contact_id', 'table_name' => 'civicrm_mailing_event_queue', - 'entity' => 'Queue', + 'entity' => 'MailingEventQueue', 'bao' => 'CRM_Mailing_Event_BAO_Queue', 'localizable' => 0, 'FKClassName' => 'CRM_Contact_DAO_Contact', @@ -192,7 +192,7 @@ class CRM_Mailing_Event_DAO_Queue extends CRM_Core_DAO { 'size' => CRM_Utils_Type::HUGE, 'where' => 'civicrm_mailing_event_queue.hash', 'table_name' => 'civicrm_mailing_event_queue', - 'entity' => 'Queue', + 'entity' => 'MailingEventQueue', 'bao' => 'CRM_Mailing_Event_BAO_Queue', 'localizable' => 0, 'add' => NULL, @@ -205,7 +205,7 @@ class CRM_Mailing_Event_DAO_Queue extends CRM_Core_DAO { 'where' => 'civicrm_mailing_event_queue.phone_id', 'default' => NULL, 'table_name' => 'civicrm_mailing_event_queue', - 'entity' => 'Queue', + 'entity' => 'MailingEventQueue', 'bao' => 'CRM_Mailing_Event_BAO_Queue', 'localizable' => 0, 'FKClassName' => 'CRM_Core_DAO_Phone', diff --git a/api/v3/MailingEventQueue.php b/api/v3/MailingEventQueue.php index e7b3f6bc0c..9625809fdb 100644 --- a/api/v3/MailingEventQueue.php +++ b/api/v3/MailingEventQueue.php @@ -34,7 +34,7 @@ function civicrm_api3_mailing_event_queue_create($params) { ['job_id', 'contact_id'], FALSE ); - return _civicrm_api3_basic_create('CRM_Mailing_Event_BAO_Queue', $params, 'Queue'); + return _civicrm_api3_basic_create('CRM_Mailing_Event_BAO_Queue', $params, 'MailingEventQueue'); } /** diff --git a/tests/phpunit/api/v3/SyntaxConformanceTest.php b/tests/phpunit/api/v3/SyntaxConformanceTest.php index 1940039d40..98ec86bc84 100644 --- a/tests/phpunit/api/v3/SyntaxConformanceTest.php +++ b/tests/phpunit/api/v3/SyntaxConformanceTest.php @@ -878,7 +878,6 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase { $entitiesWithNamingIssues = [ 'SmsProvider' => 'Provider', 'AclRole' => 'ACLEntityRole', - 'MailingEventQueue' => 'Queue', 'Dedupe' => 'PrevNextCache', 'Exception' => 'DedupeException', 'RuleGroup' => 'DedupeRuleGroup', diff --git a/xml/schema/Mailing/Event/Queue.xml b/xml/schema/Mailing/Event/Queue.xml index 6449d51afe..491eddaa75 100644 --- a/xml/schema/Mailing/Event/Queue.xml +++ b/xml/schema/Mailing/Event/Queue.xml @@ -3,6 +3,7 @@ CRM/Mailing/EventQueue + MailingEventQueuecivicrm_mailing_event_queueA collection of all intended recipients of a jobtrue -- 2.25.1