MailingEventQueue - Use consistent short/camel-name.
authorTim Otten <totten@civicrm.org>
Thu, 30 Dec 2021 03:35:29 +0000 (21:35 -0600)
committerTim Otten <totten@civicrm.org>
Thu, 13 Jan 2022 20:58:07 +0000 (12:58 -0800)
commitc8bc30181b5b15622359dc020346e90d3149d539
treecef7a8a9ae0cb8d8e5ae7b1c22f4e24f09aa5c25
parent587261c312214bd2d3afca83134f1acee3977d74
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
CRM/Mailing/Event/DAO/Queue.php
api/v3/MailingEventQueue.php
tests/phpunit/api/v3/SyntaxConformanceTest.php
xml/schema/Mailing/Event/Queue.xml