Avoid e-notices on pages with tabs

[braders]

Overview

Avoid e-notices on pages with tabs, by ensuring tabHeader items contain the necessary keys.

Before

On pages with tabs (manage event, campaign conduce survey, etc) e-notices were frequently triggered from within TabHeader.tpl. These resulted from TabHeader.tpl trying to read tabHeader keys from each top-level array item.

After

The tabHeader array is re-assigned in CRM_Core_Form and CRM_Core_Page just before the template is rendered, with all keys defined for each tabHeader tab array.

Technical Details

This could have been resolved by changing the arrays assigned to tabHeader within induvidual pages. However, this centralises the logic incase new array keys are added in future, and will ensure notices are not caused by any extensions using TabHeader.tpl.

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

[demeritcowboy]

I wonder if just to keep things together if this should be up at line 162? It seems to get rid of the notices either way. Was there a reason to put it here? I don't have a strong opinion either way since I'm not aware of any situation where it would make a difference.

[braders]

@demeritcowboy This is intentional. Line 162 (i.e. where ensureVariablesAreAssigned is called) is within the constructor. That is fine for ensureVariablesAreAssigned, which is just setting default values to be overridden later.

That's not what we're doing in addExpectedTabHeaderKeys - here we're modifying assigned variables just before rendering, and so the page's run() function has to have run. Therefore running addExpectedTabHeaderKeys in the constructor would be too early.

There is probably an argument to moving ensureVariablesAreAssigned to line ~200, just before the new call to addExpectedTabHeaderKeys, but I have not looked closely to see if there would be side-effects to that change.