Wrap "not you" message in crmRegion

[mattwire]

Overview

On both contribution pages and registration pages there is a "Not you, do you want to register for someone else" message. I've had requests from various clients to hide this and you can generally do it with javascript. But it's not ideal, it often "flashes" on screen before disappearing, if there is a javascript error it doesn't disappear, if you don''t load the javascript (eg. when a contribution is inserted via shortcode on wordpress).

This wraps the message in a crmRegion so that it can be removed/replaced via the buildForm hook before it reaches the browser. Example:

/**
 * Intercept form functions
 * @param string $formName
 * @param \CRM_Core_Form $form
 */
function bafamembers_civicrm_buildForm($formName, &$form) {
  switch ($formName) {
    case 'CRM_Contribute_Form_Contribution_Main':
      CRM_Core_Region::instance('contribution-main-not-you-block')
        ->update('default', ['disabled' => TRUE]);
      break;

    case 'CRM_Event_Form_Registration_Register':
      CRM_Core_Region::instance('event-register-not-you-block')
        ->update('default', ['disabled' => TRUE]);
      break;
  }
}

Before

Described above.

After

No change. By implementing code you can modify/remove the message div from the form.

Technical Details

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

[mattwire]

I'll add documentation here once merged: https://docs.civicrm.org/dev/en/latest/framework/region/

[colemanw]

Is there any reason to give them different names?
I perceive them as the same region on different forms, so I would give both regions the same name.

[mattwire]

@colemanw Yes, last time I added a region to both I was asked to name them differently. My first thought was to name them the same and I'd be happy to do so - can you confirm which you'd prefer and I'll update?

[colemanw]

Hmm, which region was that?

[mattwire]

Looks like it was this one: civicrm/civicrm-dev-docs@bff90ee#diff-58e14f7bedd129b99f44ffce86365618

[colemanw]

Ok, I'm not sure why regions would have to have different names if they are the same region on different forms, since you can target a particular form in your hook if you wish.
@eileenmcnaughton ?

[eileenmcnaughton]

@colemanw I believe it was consistency with the others that already existed at that time

[demeritcowboy]

For what it's worth the doclink referenced has a naming conventions section that says make them match the file path. But reasoning is not stated. https://docs.civicrm.org/dev/en/latest/framework/region/#naming-conventions

[colemanw]

Ok whatever.