CRM-20545 - port extended reports metadata approach to adding columns

[eileenmcnaughton]

Overview

Port extended reports approach to metadata for fields alternative to #11244. Note that the ticket suggested is_deleted filtering should be added - this does it but it can be unset. Filtering by is_deleted probably DOES make sense, but not by is_deceased

Before

Contribution detail report not filtered by is deleted or is_deceased

After

Contribution detail report not filtered by is deceased but is filtered by deleted - but that can be altered in the report by the user. Extended reports metadata method exists

Technical Details

@colemanw this is what the extended reports approach looks like - obviously it seems quite long but the idea is that on the individual reports you don't define all the fields - although you can define special treatment of them - in this case overriding the default order by (display-name - although perhaps sort_name makes more sense), the default fields (to be the same as the existing report), to specify not to display id & to require it & to specify a filter.

The no_field_disambiguation I added - normally a common error in reports is ambiguity between 2 reports fields - ie. 'status_id' on case and on activity or something. This causes a tonne of issues so normally I append a string to disambiguate, but it would change the saved field names, so erring on the side of existing behaviour.

Note this code is the basis for the reports allowing details about 2 contacts in one report - because of the 'prefix' stuff

($this->getColumns('Contact', array(
      'order_bys_defaults' => array('sort_name ASC'),
      'fields_defaults' => array('sort_name'),
      'fields_excluded' => array('id'),
      'fields_required' => array('id'),
      'filters_defaults' => array('is_deleted' => FALSE),
      'no_field_disambiguation' => TRUE,
    )

---

• CRM-20545: contact report lists contacts that have been 'soft' deleted (placed in Trash)

[eileenmcnaughton]

test this please

[colemanw]

@eileenmcnaughton did you mean to say it is filtered by is_deleted? It looks from your code like it is set to exclude deleted contacts.

[eileenmcnaughton]

@colemanw I have updated the description - I see it was incorrect about what the pr was doing. Also have rebased against master (not stale but good practice to do intermittantly IMHO)