CiviCampaign - Refactor civicrm_survey.recontact_interval

[colemanw]

Overview

Refactors out a thoroughly strange data structure in CiviSurvey.

Before

Each option value in a survey result option group has an associated recontact_interval, which is an integer storing the number of days before the respondent should be recontacted. e.g.

• Status: "Left Message" Recontact Interval: 3
• Status: "Not Home" Recontact Interval: 1

For some reason, this data was being stored in a serialized array on the Survey entity, with keys matching the option_value label!!

So in order to retrieve a complete list of options, you needed to fetch all the option_values, unserialize the survey's
recontact_interval data, and then match the option labels to the keys in the unserialized array.

After

There was an unused integer column, civicrm_option_value.filter which works fine for storing the number directly in each option_value with no messy mapping needed.

To retrieve a complete set of options, just fetch the option values.

Technical Details

The label-based mapping would be quite problematic for any multilingual sites, or any scenario when the label gets updated. Storing all the data together will make it easier to use SearchKit with CiviSurvey.

[civibot]

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...

• If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
• A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
• A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
• If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
• Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
• A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
• To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
• For more information about contributing, see CONTRIBUTING.md.

Quick links for reviewers...

• ➡️ PR Demo site (can be rebuilt with the command test this please).
• 📖 Review standards
• 🗒️ Review template (brief or verbose)

➡️ Online demo of this PR 🔗

[colemanw]

Heads up @jmcclelland in case you have any custom code that wrangles this weird serialized field.

[jmcclelland]

@colemanw thanks for the heads up - fortunately I haven't had to touch that code. Thanks for the clean up!