dev/core#682 Add basic contact filters to Summary Contributions Report

[francescbassas]

Overview

Contributions of deleted contacts are shown on Summary Contributions Report. Adding basic contact filters to the Summary Contributions Report will prevent these "deleted" contributions from being included. In addition it will enable new possibilities when applying contact filters to the report.

Before

After

Comments

As a summary report we are interested to include deceased contacts. For these reason we add a new param to the getBasicContactFilters() function.

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

[colemanw]

@francescbassas thanks for the PR. But I'm confused. Your description and your code don't seem to match. From your description you are adding filters, but your code isn't doing that, it's just changing the default value for is_deceased

[francescbassas]

Thanks @colemanw for reviewing. Filters added on line 84 at CRM/Report/Form/Contribute/Summary.php using the funcion getBasicContactFilters.

[colemanw]

Sorry I missed that.
@francescbassas what is the reason for passing NULL as the default value for deceased?

[francescbassas]

Its purpose is to avoid the default behavior of the function getBasicContactFilters (exclude deceased contacts). Setting to NULL report not filter for is_deceased field. In general, in a contribution report, you are interested in showing all contributions regardless of whether or not you are dealing with deceased contacts or not.

I found a related discussion in this dismissed PR #11244.

[colemanw]

Ok that makes sense. A more forward-looking solution might be to have the function take an array of $defaults (which defaults to an empty array if not supplied).

Then the line could read

'is_deceased' => array(
    'title' => ts('Deceased'),
    'type' => CRM_Utils_Type::T_BOOLEAN,
    'default' => CRM_Utils_Array::value('deceased', $defaults, 0),
  ),

[francescbassas]

And in this case be called something like 'filters' => $this->getBasicContactFilters(array('deceased' => NULL)?

[colemanw]

Yes that's my idea.

[francescbassas]

Ok @colemanw suggestions applied. There is a failing test that I find difficult to digest. You see what the problem is?

[colemanw]

@civicrm-builder retest this please

[alifrumin]

I tested this and it looks great to me. I think it is ready to be merged.

[seamuslee001]

Merging as per @alifrumin Review and everything else looks fine to me me

[colemanw]

Nice work everyone.

[francescbassas]

Thanks all!