MessageTemplate - Deprecate valueName. Emphasize workflow. Consolidate converters.

[totten]

Overview

CRM_Core_BAO_MessageTemplate::sendTemplate() and ::renderTemplate() accept an argument called valueName. The the option has grown misleading -- if message templates will no longer be identified by OptionValue per se. Of course, the content is still important as it identifies the workflow step (a la civicrm_msg_template.workflow_name WorkflowMessage::WORKFLOW).

The primary change of this branch is to deprecate valueName in favor of workflow. Additionally, it does some cleanup for other fields that went through a similar change.

Before

• The fields contactId and disableSmarty are translated to tokenContext.contactId and tokenContext.smarty. However, these translations are sprinkled around.
• sendTemplate() and renderTemplate() use valueName
• WorkflowMessage and hook_alterMailParams use the same params as ^^ -- so they use valueName

After

• The translations for valueName, contactId, and disableSmarty all work the same way - and they've each been boiled down to 1-line call (CRM_Utils_Array::pathSync())
• sendTemplate() and renderTemplate() use workflow (with alias support for valueName)
• WorkflowMessage and hook_alterMailParams use the same params as ^^ -- so they use workflow (with alias support for valueName)

Comments

It's tempting to add an extra warning at the start of renderTemplateRaw(), although this would make the patch a longer (ie we'll get test-failures for old callers - and need to update each).

if ($badGuys = array_intersect(array_keys($params), ['valueName', 'disableSmarty', 'contactId'])) {
  \CRM_Core_Error::deprecatedWarning("renderTemplate() received deprecated option(s): " . implode(', ', $badGuys));
}

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