Fix metadata on member export

[eileenmcnaughton]

Overview

This fixes the lack of headings on some fields when exporting memberships

Before

No headings for

member_is_override
membership_recur_id
max_related

After

Headings for exported fields

Technical Details

I added uniquenames to match the export / query fields but am having misgivings about membership_recur_id - I wonder if I should instead change it to membership_contribution_recur_id - but there is more to change / more risk then

Comments

I did some testing to see if the renaming would cause issues & found

1. there are api tests covering get & create on is_override
2. it's not possible to add is_overide or contribution_recur id to a profile (ie the 2 I added uniquenames for)

3) I had to change the tests for import for is_override but this doesn't require a db update as (somewhat tragically) the LABELS are stored in the mapping (I might look to change that as a follow up)

4. after the change I edited a membership through the back office form to be override - all good

5. I DID find that I need to update smart groups based on search builder for this for is_override. recur id is already no exportable

[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]

@eileenmcnaughton why not make auto_renew exportable?

[eileenmcnaughton]

@seamuslee001 it's not a real field - the WHERE code is pretty complex & I'm not even really sure what it means

[seamuslee001]

@eileenmcnaughton i thought it was the field that had the referece to civicrm_contribution_recur in it? but maybe not

[eileenmcnaughton]

@seamuslee001 well it does refer to that field but not as just a number - see the where

      case 'member_auto_renew':
        $op = '=';
        $where = $qill = [];
        foreach ($value as $val) {
          if ($val == 1) {
            $where[] = ' civicrm_membership.contribution_recur_id IS NULL';
            $qill[] = ts('Membership is NOT Auto-Renew');
          }
          elseif ($val == 2) {
            $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ' . CRM_Contact_BAO_Query::buildClause(
                'ccr.contribution_status_id',
                $op,
                array_search(
                  'In Progress',
                  CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
                ),
                'Integer'
              );
            $qill[] = ts('Membership is Auto-Renew and In Progress');
          }
          elseif ($val == 3) {
            $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ' .
              CRM_Contact_BAO_Query::buildClause(
                'ccr.contribution_status_id',
                $op,
                array_search(
                  'Failed',
                  CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
                ),
                'Integer'
              );
            $qill[] = ts('Membership is Auto-Renew and Failed');
          }
          elseif ($val == 4) {
            $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ' .
              CRM_Contact_BAO_Query::buildClause(
                'ccr.contribution_status_id',
                $op,
                array_search(
                  'Cancelled',
                  CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
                ),
                'Integer'
              );
            $qill[] = ts('Membership is Auto-Renew and Cancelled');
          }
          elseif ($val == 5) {
            $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL AND ccr.end_date IS NOT NULL AND ccr.end_date < NOW()';
            $qill[] = ts('Membership is Auto-Renew and Ended');
          }
          elseif ($val == 6) {
            $where[] = ' civicrm_membership.contribution_recur_id IS NOT NULL';
            $qill[] = ts('Membership is Auto-Renew');
          }
        }

[eileenmcnaughton]

OTOH the select has NADA for it but it DOES offer up the civicrm_membership.contribution_recur_id field

[eileenmcnaughton]

related test failure noise - that's a good thing! It tells me we have useful cover on this

[eileenmcnaughton]

@seamuslee001 I pulled autorenew out . to #14956

[eileenmcnaughton]

@seamuslee001 I also finally got this passing - my goal is to ensure metadata is defined for all exportable fields & then we won't get new ones added with inadequate info / random handling because the tests will e-notice away like mad once I can remove the lenient lines - I think there are only really simple ones left after this

[jitendrapurohit]

Tested the export screen, search forms, membership recur contribution, auto-renew functionality, etc and have not yet seen any problems in the functioning of the same.

I was able to replicate the main issue of not printing the headers in the export file and confirm that this pr fixes the display of 3 headers - member_is_override, membership_recur_id, max_related.

I feel this is good to be merged.

[eileenmcnaughton]

thanks @jitendrapurohit