Move DAO function to DAO class, call it from Merge class

[eileenmcnaughton]

Overview

Moves a function to a more logical place, deprecates a specific old hook usage (hook merge in cidRefs context)

Before

Code works & test CRM_Dedupe_MergerTest::getCidRefs passes. Code is less logical

After

Code works & test CRM_Dedupe_MergerTest::getCidRefs passes. Code is more logical. Poorly thought out hook call is deprecated and that same hook is no longer called from an unrelated context.

Technical Details

This change is primarily moving most of the contents of cidRefs (which is well tested already) to CRM_Core_DAO::getReferencesToContactTable. In addition addCustomTablesExtendingContactsToCidRefs is moved to CRM_Core_DAO (since otherwise the 'self::' call doesn't work.

The CRM_Dedupe_Merger::cidRefs function is retained as, in addition to calling the new function,
it calls the hook

CRM_Utils_Hook::merge('cidRefs', $contactReferences); 

That hook is poorly thought out as the merge hook is called in different contexts with completely different expectations. In this context the entityTypes hook is preferred. After a number releases with it deprecated we can remove the whole function.

In the meantime the unrelated function CRM_Logging_Schema::getLogTablesForContact() no longer calls that hook

Comments

[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).

[eileenmcnaughton]

test this please

[eileenmcnaughton]

@totten so I'm curious about converting this to a cache call

In theory the things that would change the list of tables here are

1. a new custom table being created
2. a change to core schema
3. a change to hook-declared entity types.

3 breaks down into
a) new extension installed
b) new extension uninstalled
c) extension upgrade WITH upgrade extension script run
d) extension upgrade without any script run
e) main civicrm upgrade script runs and hooks are called in upgrade mode - causing the list of cached extension functions to be built without extension hooks being called and hence to be missing some

[eileenmcnaughton]

(note I think this PR is mergeable regardless of my tangent)

[eileenmcnaughton]

@monishdeb @jitendrapurohit @seamuslee001 any of you up to review this - it's simpler than it looks - just moving code around

[jitendrapurohit]

Manually tested the dedupe merge process and looks good to me. +1 fom me in merging this PR.

[eileenmcnaughton]

thanks @jitendrapurohit