Add options to widget form - count, remove selected, autosubmit, use original keys

Patch dont work with latest dev:

patch < new-options_autosubmit_remove-active_act_single_2.patch
patching file facetapi_multiselect.module
patching file facetapi_multiselect_autosubmit.js
patching file facetapi_multiselect.inc
Hunk #1 FAILED at 27.
Hunk #2 FAILED at 68.
2 out of 2 hunks FAILED -- saving rejects to file facetapi_multiselect.inc.rej

as also mentioned here there's no js directory or files creted.

facetapi_multiselect.inc.rej:

--- facetapi_multiselect.inc
+++ facetapi_multiselect.inc
@@ -27,11 +27,14 @@
    * Builds an array of #options for our select element.
    */
   public function buildOptions($element) {
+    $settings = $this->settings->settings;
     $options = array();
     foreach ($element as $item) {
       if (empty($item['#item_children'])) {
-        $key = $this->getOptionKey($item);
-        $options[$key] = $item['#markup'];
+        if (!$item['#active'] || ($item['#active'] && !$settings['remove_selected'])) {
+          $key = $this->getOptionKey($item);
+          $options[$key] = $settings['add_count'] ? $item['#markup'] . ' (' . $item['#count'] . ')' : $item['#markup'];
+        }
       }
       else {
         // Recursively add any children of the item to the #options array (this
@@ -68,6 +71,56 @@
     // selected. We need to do it this way (rather than using $item['#query'])
     // so that multiple selections can be combined together in the form's
     // submit handler.
-    return $this->facet['field alias'] . ':' . $item['#indexed_value'];
+    return drupal_encode_path($this->facet['field alias']) . ':' . $item['#indexed_value'];
+  }
+
+  /**
+   * Allows the widget to provide additional settings to the form.
+   */
+  function settingsForm(&$form, &$form_state) {
+    $form['widget']['widget_settings']['links'][$this->id]['add_count'] = array(
+      '#type' => 'checkbox',
+      '#title' => t('Add count'),
+      '#description' => t('Add available item count in brackets.'),
+      '#default_value' => $this->settings->settings['add_count'],
+      '#states' => array(
+        'visible' => array(
+          'select[name="widget"]' => array('value' => $this->id),
+        ),
+      ),
+    );
+    $form['widget']['widget_settings']['links'][$this->id]['remove_selected'] = array(
+      '#type' => 'checkbox',
+      '#title' => t('Remove selected'),
+      '#description' => t('Remove selected options from select list.'),
+      '#default_value' => $this->settings->settings['remove_selected'],
+      '#states' => array(
+        'visible' => array(
+          'select[name="widget"]' => array('value' => $this->id),
+        ),
+      ),
+    );
+    $form['widget']['widget_settings']['links'][$this->id]['auto_submit'] = array(
+      '#type' => 'checkbox',
+      '#title' => t('Autosubmit'),
+      '#description' => t('Hide submit button and submit selection automatically.'),
+      '#default_value' => $this->settings->settings['auto_submit'],
+      '#states' => array(
+        'visible' => array(
+          'select[name="widget"]' => array('value' => $this->id),
+        ),
+      ),
+    );
+  }
+
+  /**
+   * Returns defaults for the settings this widget provides.
+   */
+  function getDefaultSettings() {
+    return array(
+      'add_count' => 0,
+      'remove_selected' => 0,
+      'auto_submit' => 0,
+    );
   }
 }

Tested the autosubmit functionality - works. Thanks!

#4 works for me, except for Date fields. But in general, Date fields don't work with this module at all. New issue to follow on *that* problem. For now, marking RTBC.

see #1974358: Date fields aren't supported for the Date issue.

Tested autosubmit : works but the other options in the dropdown list are removed after the refresh.

The patch applied correctly although with some notes:

patching file facetapi_multiselect.module
patching file js/facetapi_multiselect_autosubmit.js
patching file plugins/facetapi/facetapi_multiselect.inc
patch unexpectedly ends in middle of line
Hunk #2 succeeded at 71 with fuzz 2.

I only used the auosubmit option and will verify it works.

I got an error when I was trying to apply #4 because of the way the patch was formatted.

git apply -v < new-options_autosubmit_remove-active_act_single_2.patch
Checking patch facetapi_multiselect.module...
Checking patch js/facetapi_multiselect_autosubmit.js...
error: while searching for:

error: patch failed: js/facetapi_multiselect_autosubmit.js:0
error: js/facetapi_multiselect_autosubmit.js: patch does not apply
Checking patch plugins/facetapi/facetapi_multiselect.inc...

This patch worked for me with git apply -v.

This change in the options logic:

--- a/plugins/facetapi/facetapi_multiselect.inc
+++ b/plugins/facetapi/facetapi_multiselect.inc
@@ -27,11 +27,14 @@ class FacetapiMultiSelectWidget extends FacetapiWidgetLinks {
    * Builds an array of #options for our select element.
    */
   public function buildOptions($element) {
+    $settings = $this->settings->settings;
     $options = array();
     foreach ($element as $item) {
       if (empty($item['#item_children'])) {
-        $key = $this->getOptionKey($item);
-        $options[$key] = $item['#markup'];
+        if (!$item['#active'] && $settings['remove_selected']) {
+          $key = $this->getOptionKey($item);
+          $options[$key] = $settings['add_count'] ? $item['#markup'] . ' (' . $item['#count'] . ')' : $item['#markup'];
+        }
       }
       else {
         // Recursively add any children of the item to the #options array (this

Made all my options disappear completely. The rest of #11 works perfectly for me. I don't understand the logic - only show items if "remove selected" is checked?

Same as dafeder, patch from #11 made my options disappears.

I guess that the "remove selected" just removes the options from the list/active item when they selected, which is not the default behaviour.

I've changed a bit the logic there and fix the missing options.

New patch attached.

Great features! I'm using patch #14 for counts and autosubmit. Working nicely, thanks.

Great features! Work perfect for me.

Optgroups don't work well at all with taxonomies deeper than 2 levels, so I added an option to not use optgroups and instead prepend the options with hyphens like Drupal core does.

Could use some additional review.

Forgot to include the new javascript file from the earlier patches.

Patch from #19 works nicely here!

While using patch#19 and selected to display hierarchy with dashes (Nest hierarchical facets in optgroups - unchecked) and when you select a term for example 2 or 3 level deeper in hierarchy after submitting the form in the input is shown not only this term, but all his parents in the hierarchy.
With the following patch only the ones selected are displayed.

Forgot the autosubmit js file in the patch here is the patch with it.

Just installed #22. Works well! :)

Patch #22 works for me too

#22 is mostly working for me as well. The "Act as single select element" seems to be broken when multiple facets are selected. Maybe we should remove this option for now to get the reste committed ?
I mark this one as Needs work because of the above.

The array is not initialized in buildDefaultValue and I'm receiving notices because of this.

I also was receiving the following error after applying #22 patch: Undefined variable: default_value in FacetapiMultiSelectWidget->buildDefaultValue()...

I then applied #26 patch and error went away. Thanks.

Hello
Did you find a solution for the "connected fields" multiselect issue? I really need this feature but I don't know how to make it work. The option "Act as single select element" does not work properly.
Even a hint on where I should start would really be appreciated. Do you know if it is possible to build a different path for connected fields without using ':' but eventually another safe character?

Patch in #26 seems to handle Issues: 1, 2, 3 well.

However, autosubmit seems to hide all submit buttons on multiselect fields. It was what I wanted but some people might be adverse to it.

Patch #26 works for issues 1, 2
I did not test it for issue 3

For issue 4: the problem is in the encoding of the value field of the select options
The values are for a connected field facet name field1:field2:value
It should be field1%3Afield2:value

So when the form is submitted, this string sould be double-encoded like the links widget : field1%253Afield2%3Avalue

In facetapi_multiselect/plugins/facetapi/facetapi_multiselect.inc
Line 86
I added an urlencode() for the field alias.

return urlencode($this->facet['field alias']) . ':' . $item['#indexed_value'];

It solved my problem

I had to add another urlencode.
If you are not using the "remove selected", you should add urlencode() also to the function buildDefaultValue()

Here is the complete code with precedent issue :

  /**
   * Builds a #default_value array for our select element.
   */
  public function buildDefaultValue($element) {
    $active_items = $this->facet->getAdapter()->getActiveItems($this->facet->getFacet());
    $default_value = array();
    foreach($active_items as $id=>$values) {
      $default_value[] = urlencode($values['field alias']). ":" . $id;
    }
    return $default_value;
  }


  /**
   * Gets the key to use for an item in the select element #options array.
   */
  protected function getOptionKey($item) {
    $settings = $this->settings->settings;
    if ($settings['act_single'] && isset($item['#query']['f'])) {
      return implode('&', $item['#query']['f']);
    }
    // Set the key to the filter that will appear in the URL if this item is
    // selected. We need to do it this way (rather than using $item['#query'])
    // so that multiple selections can be combined together in the form's
    // submit handler.
    return urlencode($this->facet['field alias']) . ':' . $item['#indexed_value'];
  }

@Alec-Serval your code needs some changes, as you can see at #2198337-2: URL encode for multi select values

This attached patch implements what is brought up in #31 using the logic from #2198337-2: URL encode for multi select values. Seems like everything works now that I need.

Great thing!
Unfortunately: Autosubmit seems not to work with chosen.

Edit: no wonder: it looks like the autosubmit js from #26 is not in #33.

This patch takes #33 and re-adds js from #26.

Please test and rtbc.

Memo: It would be quite useful if the js also disables other submit buttons on autosubmit.

I just discovered an issue with this patch and the auto-submit functionality. iOS has a bug in how it handles changes to multiselect fields. It considers the action of clicking into the field a change, so it fire's the jQuery .change() event and submits the form before you ever have a chance to select filters. The solution here is to use .blur() instead of .change(), as that will wait until the facet loses focus before submitting. Attaching an updated patch based on #36

After more testing, my patch seems to break autosubmit functionality with the chosen module...

So we're back to testing #36 i suppose.

The issue with #36 is how iOS handles multi select lists. Just clicking into the list to begin selecting options picks the first option, and fires the change event. So when the autosubmit option is enabled, it's impossible to actually use the filters on those devices. I found a solution that seems to work for me, but admittedly it's a little hacky since Drupal doesn't allow you to add option outside of `value` and `selected` on `options`.

The fix is based on this: http://stackoverflow.com/questions/34985606/ios-9-2-select-list-multiple.... Basically I'm adding an empty option to the beginning of the options list, and setting `value="disabled"`. Then in `#post_render` calling a function that parses the rendered select element, finds one with a value of disabled, removed the `value` attribute and sets the `disabled` attribute.

The drawbacks I've seen so far is that some browsers don't seem to hide the disabled option by default. Adding the following to my CSS fixes that.

option[disabled]:empty { display: none; }

The other one using "disabled" as the option value. That could create some naming conflicts, but I think the likelyhood of that is slim.

@All, the above patch is working perfectly fine but it doesn't support special characters.

Please find the attached patch - this patch would allow special characters and working perfectly fine.

Let me know if anyone have any queries/concern for the same.

Thanks!

Comments at #2835107: Invalid HTML is generated and #2836051: Hard coded XMl (which were filed as separate issues but are actually about the most recent patch in this issue, specifically about the changes that were introduced as part of #41 above) suggest that maybe this needs more work?

Attached patch modifies the patch to solve #2835107: Invalid HTML is generated and #2836051: Hard coded XML.

(Deleted)

+1 for the patch from #44.

Updated version of patch from #44 to include "data-placeholder" element for integration with Chosen module. Maybe it should be default HTML5 "placeholder" attribute, please advise.

The widget doesn't render on some server configurations.

Since LIBXML_HTML_NOIMPLIED and LIBXML_HTML_NODEFDTD were introduced in version 2.7.8 of that extension, calling these constants is problematic. It can result in errors like these:

Notice: Use of undefined constant LIBXML_HTML_NODEFDTD - assumed 'LIBXML_HTML_NODEFDTD' in _facetapi_multiselect_disable_options()
Notice: Use of undefined constant LIBXML_HTML_NOIMPLIED - assumed 'LIBXML_HTML_NODEFDTD' in _facetapi_multiselect_disable_options()
Warning: DOMDocument::loadHTML() expects parameter 2 to be long, string given in _facetapi_multiselect_disable_options()

A simple fix is to just statically check the libxml/PHP version and ignore these optional constants if it's unlikely they'll be defined. Relevant code:

// Check PHP and libxml version.
  static $new_libxml;
  if (!isset($new_libxml)) {
    $new_libxml = version_compare(PHP_VERSION, '5.4', '>=') && defined('LIBXML_HTML_NOIMPLIED') && defined('LIBXML_HTML_NODEFDTD');
  }

...

  if ($new_libxml) {
    $select->loadHTML(utf8_decode($content), LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD);
  }
  else {
    $select->loadHTML(utf8_decode($content));
  }

Patch included - tested on CentOS 6.8 with PHP 5.6 and libxml 2.7.6, which has the undefined constants.

Another patch to improve Chosen theming – the facet counts really shouldn't appear on selected items, since Chosen will prepopulate them above the search results dropdown. Interacts correctly with add_count option.

Another option would be to add a tag around the counts and do it with CSS, but I think that's only a good idea if the user is using Chosen, since it's not HTML-correct to have other tags inside the element.

Fixed broken logic from last patch, wasn't removing/adding counts correctly.

One more option for this module: allow showing empty facets as disabled, which will let Chosen consequently handle them that way.

Fixed some notices from the patch in #51.

Hi, I've got troubles to apply the latest patch. Firestonej, could you provide a patched tarball of the module?
Thanks, Marc

Small addition to allow translating the placeholder label. The patch applies cleanly to the latest commit in the development branch.

A.

@marcmueller: Please take a look at https://www.drupal.org/project/facetapi_multiselect/git-instructions

Thank you, NWOM. I've been using Netbean's apply patch function. Via git its working now.
Also, thanks to all of you contributors!

I just noticed an added line accidentally and one coding standards violation, but otherwise I think this patch should really be committed by now.

I think this project is in need of another co-maintainer so I'll fill out another ticket with that as we have this module in a major production site.

Hello all -
Thanks to all who contributed to this patch. This was such a great combined effort that it would have been a shame not to make sure everybody got credit for the work they did.

I did my best to divide up the patch and make sure the commit was attributed to the actual code people changed.

Thanks everybody!

Any issues with the new codebase should now all be filed in separate tickets.