Extra deprecation for clarity on token function convertPseudoConstantsUsingMetadata

[eileenmcnaughton]

Overview

Extra deprecation for clarity on token function

Before

The only function this is called from is, itself, noisily deprecated. However, you have to do a search to find out this is deprecated

After

Deprecation is more obvious, not much change for anything that hits this path as there is already a warning

Technical Details

Comments

[civibot]

(Standard links)

• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[totten]

+1 for the @deprecated flag. It discourages new calls and helps to show the progression of the phase-out.

But for the logging... you're saying there's already a logged notice. So instead of generating 1 log-notice, it generates 2 notices? (Or, actually, n-many -- because the call from getContactTokenReplacement() has a loop around convertPseudoConstantsUsingMetadata().) And the person who reads the notice shouldn't/can't do anything about convertPseudoConstantsUsingMetadata(). It's just generally amplifying the noise?

[eileenmcnaughton]

@totten yeah it may amplify the noise - but I doubt anyone will notice since they are already getting noise

The bigger thing is that when looking at the function it is easy to see that it is progressing well on it's way out. We spend a lot of time grepping to see if functions are called & my goal is once one has decided there is no undeprecated path to call a function no-one else ever has to do that grep again

[eileenmcnaughton]

& yeah having both makes a big difference in that calculation - cos you still have to do the grep next time if only the comment is present - eg. I want to know what undeprecated paths call CRM_Contact_BAO_Contact::exportableFields & I really need to find out when deciding that if they are quietly or noisily deprecated so there is that extra grep