Enable ability to require tags in profiles

[jmcclelland]

Overview

This PR enables the ability to make the Tag field required in a profile. For additional discussion, see this stack exchange post.

Before

If you:

• Create a profile with stand alone checked
• Include the Tags field
• Marks the Tags field as required

When you display the profile in create mode:

1. No red asterisk appears next to the Tags field
2. You are allowed to submit it without a Tag selected

After

A red asterisk appears when the form is displayed and you are not able to submit the form without entering at least one tag.

Technical Details

It seems that this has simply been overlooked and nobody noticed or decided it should be fixed.

Comments

I tried to write a test to ensure it continues to work, but alas, the Api V3 profile submit code does, in fact, enforce the tags requirement. But, create mode does not seem to use that Api v3 function. I'm open to suggestions on how to properly test this feature.

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

[demeritcowboy]

Can you just change param 5 from FALSE to $isRequired? I haven't tested but it seems like that would do the same thing as the if and addRule.

For unit testing you could try using $form = $this->getFormObject('CRM_Profile_Form_Edit', [params]). I don't know offhand if there's an existing test that is similar - sometimes you have to fiddle a bit with the params and $_GET to make it work for the given form, but then you can do stuff like call $form->buildForm(), $form->postProcess(), etc.

[jmcclelland]

@demeritcowboy Thanks for the tip on $isRequired - I just made that change.

But I'm banging my head against the wall with the test. I've added my work so far, but for some reason I can't seem to get the test for whether a required field is present to trigger.

The commented out formRule code was always coming back without errors.

Any suggestions?

[demeritcowboy]

I was thinking maybe adding $errors = $form->validate() here after buildQuickForm might do it but doesn't seem to. Hmm.

[demeritcowboy]

I see it. This form handles its own error handling slightly differently than other forms (because it's Civi!) It expects there to be an errorUrl param and then does a redirect. The return value from validate() is just a true/false here, so it actually does work to call $form->validate(), I was just expecting an array of error messages. So you can do $this->assertFalse($form->validate()); after the buildQuickForm(), and don't need the postProcess since then you're done with the test.

[jmcclelland]

@demeritcowboy Thank you!!! I was tearing my hair out as I spiraled down a recursive grep rabbit hole...
Now it all seems to work as expected (and I fixed a parse error I had introduced).