APIv4 - Add tableName to Entity.get output

[colemanw]

Overview

Adds another useful bit of output to APIv4 Entity.get. Improves flexibility for virtual entities.

Before

Relationship between entities and tables pretty much hard-coded.

After

More flexible, each entity can decide on its table name using dynamic logic if needed.

Comments

There is massive test coverage on this.

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[totten]

General patch makes sense.

What's the connection between Entity::getInfo()['table_name'] and the ability to join CustomGroup::create() to CustomField::save()? (I would have expected that the only magic in the chain is based on the FK between CG/CF.)

[colemanw]

@totten it turns out APIv4 only bothers to create a virtual entity from a custom field set if it contains fields. Which makes sense. So this test had been testing a scenario that wouldn't fully work.

[totten]

Here's a basic r-run sanity-check:

cv api4 Entity.get -T +s name,table_name
+------------------------+----------------------------------+
| name                   | table_name                       |
+------------------------+----------------------------------+
| ACL                    | civicrm_acl                      |
| ACLEntityRole          | civicrm_acl_entity_role          |
| ActionSchedule         | civicrm_action_schedule          |
| Activity               | civicrm_activity                 |
| ActivityContact        | civicrm_activity_contact         |
| Address                | civicrm_address                  |
| Afform                 |                                  |
| AfformSubmission       | civicrm_afform_submission        |
...
| CustomField            | civicrm_custom_field             |
| CustomGroup            | civicrm_custom_group             |
| Custom_Education       | civicrm_value_education_4        |
...
| SubscriptionHistory    | civicrm_subscription_history     |
| Survey                 | civicrm_survey                   |
| System                 |                                  |
| Tag                    | civicrm_tag                      |
...

This was interesting because it had realistic examples of many kinds of entities (eg core-dao, core-special, extension-dao, extension-special, custom-group). The table_name presented on all of them seemed appropriate.

[colemanw]

Thanks for the review @totten