closes #3745 Fixes Rewrite of Multi-Select Token in Search Kit

[brienneK]

Overview

The Rewrite option for editing a display in a saved Search Kit search had a bug so that the token would only return the first value of a multi-select (i.e. multiple values) field.

Replication steps are available on the lab.civicrm issue

Before

Before this fix, if a token was used on the Rewrite option for a multi-select custom field, the display would only return the first value .

After

With the fix, the Search Kit display returns all values of the multi-select field when a token is used via the Rewrite option.

Technical Details

The bug was rooted in the replaceToken() function. $index had a default argument of 0 in the function's parameters and with the way that $replacement was being set on line 738, the function was only returning the first index of an array. This fix replaces the default argument with NULL and puts the assignment of $replacement as it was originally written within an if statement that accounts for an $index that is not NULL.

Comments

A unit test is included as part of this PR.

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

@briennekordis thanks for the PR. Apologies that I am just now seeing it.
Your analysis is good and the fix looks correct, and it's great that you've added a unit test.

General note: the unit test is difficult to read & understand due to being a bit verbose (a lot of irrelevant array data in there not strictly necessary to construct a simple search display) and due to the arrays being formatted in an older style. In the future consider using the APIv4 explorer to format entity arrays for you, like this: