Allow hidden elements to have array values

[lisandro-compucorp]

Overview

This PR solves the problem experienced by sending a WebForm associated with a Case. If the case has more than one tag associated, and the tag is a hidden field of the form, then only one of those values is preserved.

Before

In particular, for one of our customers, there is a first form, F1, in which the tags can be selected. The tag field is then rendered with the widget "Select options". After the Form is correctly saved, a Case is created with, for example, tags Tag1, Tag2, Tag3. If this same Case requires to get updated through another form, F3, in which the Tags should not be edited (therefore hidden), we observe that after submission Tag2 and Tag3 were removed.

• Result after form F1
• Result after form F3

After

The tags are all correctly preserved.

Technical Details

In the modified script, this code fragment is verifying if some value to be displayed does not allow multiple options, but is an array:

            if ($element['#type'] != 'checkboxes' && $element['#type'] != 'date'
              && empty($element['#multiple']) && is_array($val)) {
              // If there's more than one value for a non-multi field, pick the most appropriate
              if (!empty($element['#options'])) {
                foreach ($element['#options'] as $k => $v) {
                  if (in_array($k, $val)) {
                    $val = $k;
                    break;
                  }
                }
              }
              else {
                $val = array_pop($val);
              }
            }

I put emphasis on "to be displayed" part, because it is not considering the situation in which those values don't need to be presented. According to the documentation, and also with the observed during the test of the changes, the "#type" of the a hidden element is 'value': https://api.drupal.org/api/drupal/developer!topics!forms_api_reference.html/7.x#val then we avoid to reduce the options by filtering appropriately.

[KarinG]

We’ve done a lot of work re: checkboxes in our main branch: D8/D9 branch (8.x-5.x) recently and have added many automated tests. I’d really like to see fixes in the main branch first (with tests). Any ETA of when Compucorp may start developing for D8/D9? PS I tried CiviCase Compucorp last week on D9 and it broke CiviCRM menus.

[tunbola]

@KarinG , No ETA for now on when we would start developing for D8/D9, we'll try get this thoroughly QA'ed at our end so it can go in for D7. Does that work?

[KarinG]

Compucorp can sponsor our time on review/adding/writing tests for its D7 patches in D8/D9 and then backporting them to D7. We really are D8/D9 first now.