dev/core#2162: allow reports to filter multi-select fields and find entities with multiple selections

[AsylumSeekersCentre]

Currently, Reports which filter on multi-select fields will only find entities with single selections. The generated SQL syntax is not compatible with the storage format of multi-select custom fields.

Overview

Here is the issue which this fix addresses:
https://lab.civicrm.org/dev/core/-/issues/2162

The detailed description and reproduction steps are documented there.

Before

Contacts with multiple selections in a multi-select custom field would never appear in a Report which filters on that custom field. I believe this is a regression, though I haven't worked out exactly when it changed.

After

With this change, reports can filter correctly on these fields.

Technical Details

The addCustomDataToColumns function constructs a $customDAO object, which is then used to determine the operator (among other things). It wasn't fetching the civicrm_custom_field.serialize field when it constructed this object, so it concluded that custom fields are never serialized.

By fetching this field, it appears to function as intended.

Comments

When I wrote the initial issue description, I was under the impression that the change may have been deliberate. I now think that it was probably accidental, and reports filtering for "is one of" a multi-select field should find entities with more than one selection.

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

@colemanw this looks right to me does it look right to you? @eileenmcnaughton

[eileenmcnaughton]

Yes that makes sense.

[eileenmcnaughton]

(I think I made a similar change in extended reports)