REF Convert forms to standard customData template

[mattwire]

Overview

This converts ALL forms that are adding customData in a similar way to use the CRM/common/customDataBlock.tpl file which was added as part of the entityForm work last year.

Before

Each form adds custom data to the form in a similar way but using a copy of the code.

After

Each form adds custom data in exactly the same way.

Technical Details

The eventual goal is to convert all of these forms to use the entityFormTrait but that requires a significant amount of work on each form and is likely to introduce bugs requiring significant testing.
The change here standardizes the addition of customData across those forms, adding standard "getters" where necessary which will help with the eventual conversion to entityform.

In all cases, we are removing a few lines of code from each form which will make future maintenance easier and we can be sure that certain variables are assigned to each of the templates.

Comments

@eileenmcnaughton @seamuslee001 @lcdservices @alifrumin I realise this is quite a big PR and I could split out some of the commits into separate PRs - but I didn't want to flood the PR queue... As each of the form changes are self-contained perhaps you could test a couple each, and if there are any that cause issues, I'll pull them out as separate PRs for further work?

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

[seamuslee001]

Jenkins re test this please

[colemanw]

Code review looks good. User testing:

• Activities
• Cases
• Campaigns
• Petitions
• Surveys
• Case activities
• Contributions
• Recurring contributions
• Events
• Grants
• Memberships

[colemanw]

@mattwire - found this problem while testing Surveys and Petitions:

To reproduce:

• Create a survey

Result:

Fatal error: Call to undefined method CRM_Campaign_Form_Survey_Main::getEntitySubTypeId() in /home/jenkins/bknix-dfl/build/core-13412-4bl1l/sites/all/modules/civicrm/CRM/Custom/Form/CustomData.php on line 58

• Create a petition

Result:

Call to undefined method CRM_Campaign_Form_Petition::getEntitySubTypeId() in /home/jenkins/bknix-dfl/build/core-13412-4bl1l/sites/all/modules/civicrm/CRM/Custom/Form/CustomData.php on line 58

[mattwire]

Thanks @colemanw I've just pushed 2c024dc which fixes the issue with surveys/petitions along with a code comment explaining why.

[colemanw]

• General standards
  • (r-explain) Pass
  • (r-user) Pass: No user impact
  • (r-doc) Pass
  • (r-run) Pass: See checklist above
• Developer standards
  • (r-tech) Pass: Less code, more consistency.
  • (r-code) Pass
  • (r-maint) Pass
  • (r-test) Pass

[seamuslee001]

Merging as per @colemanw 's review and tag

[eileenmcnaughton]

@agileware I'm pretty sure you hit a bug on custom data - maybe on event info & this is a follow up to a short term revert on that? Maybe you could do some testing of master in your scenario/s