Allow facet search block to have children always show

Subscribe ... definitely need this for a project that we are working on.

Here's some standard usability situations that I was thinking about.

* Term Parent
** Sub-term
** Sub-term

Scenario 1: If users check top parent term

* Term Parent (Checked)
** Sub-term (Checked)
** Sub-term (Checked)

Scenario 2: If user unchecks one sub-term (from above) then parent becomes unchecked
* Term Parent
** Sub-term (checked)
** Sub-term

Scenario 3: If users check any sub-term (after looking at child terms)

* Term Parent
** Sub-term
** Sub-term (checked)

After a first analysis, the good news is that the search work well if we give it the good parameters (only the children tids but not the parent tids gives the good search result).

So we need to change the following :
* add a parameter in the solr facet block - something like a checkbox "Hierarchical behavior" (only for hierarchical taxonomy ?)
* change the classes / javascript in the facet block so it only checked the good box (not the parent if we select only some of the child)
* change the href links in the facet block so it gives the good parameters to the search (exclude the parent from the search if we select only some of the child)
* change the display of the Current search block so it display in a way we can understand exactly what we are searching

I'm actually looking for the same thing, specifically to roll a Javascript fly-out menu to show the hierarchical choices. It would look similar to the screenshot on the nice menus module, where the children are visible on mouseover.
http://drupal.org/project/nice_menus

I don't think we are going to do that afterall. If someone is interested to work on this, please go.

Just to reiterate what I'm trying to do, I'm working with taxonomy facet blocks and my taxonomies have hierarchy. I'd like the block to show the entire hierarchy upon rendering, then use CSS to hide the children. The ultimate goal is to allow a javascript effect to do a fly-out menu to see and facet on any of the children. This is similar in concept to the existing "see more" functionality inside of theme_apachesolr_facet_list().

One of the first issues is just getting the child terms to show up. They aren't rendered in the block unless you are faceted on a parent term. This seems to relate specifically to apachesolr_search.module, inside the function apachesolr_search_taxonomy_facet_block(). The child terms are returned in the SELECT statement but are subsequently removed with this inside of the while/do:

      foreach ($facets as $tid => $field) {
        if (!empty($field['#parent'])) {
          // We will render it via its parent.
          unset($facets[$tid]);
        }
      }

If you simply remove the unset, the terms will show up on output but they won't be properly indented by hierarchy. I'll keep digging, but in the meanwhile I'm certainly open to thoughts and suggestions.

Nope, I'm wrong. Ignore #5. It's actually pretty easy to output all terms, including children, that have not been clicked.

apachesolr_search.module, function apachesolr_search_nested_facet_items(), you will see an if statement towards the bottom that looks like this:

    // We don't display children unless the parent is clicked.
    if (!empty($field['#children']) && $field['#active'] == TRUE) {
      $link['children'] = apachesolr_search_nested_facet_items($query, $field['#children'], $num_found, $sort);
      $link['class'] = "expanded-facet";
    }
    elseif (!empty($field['#has_children'])) {
      $link['class'] = "collapsed";
    }

I simply modified that as follows:

    // We don't display children unless the parent is clicked.
    if (!empty($field['#children']) && $field['#active'] == TRUE) {
      $link['children'] = apachesolr_search_nested_facet_items($query, $field['#children'], $num_found, $sort);
      $link['class'] = "expanded-facet";
    }
    elseif (!empty($field['#has_children'])) {
      $link['children'] = apachesolr_search_nested_facet_items($query, $field['#children'], $num_found, $sort);
      $link['class'] = "collapsed";
    }

Now it always prints out the entire hierarchy. This seems to be step 1, now it's a matter of tying that up into a block configuration element controlled by a variable.

Changing title to better reflect the issue. If we can get the entire taxonomy to print in the block, you should be able to manipulate it with JS/jQuery pretty easily.

For one of my sites, I want to simply show the entire taxonomy, parents and children together, as I want to be able to facet by individual forums in a heirarchical forum vocabulary.

The slam-dunk fix would be to have a checkbox in the block configuration for taxonomy facets that says "always show child terms" (see screenshot for a better idea of what I'm suggesting). Then I could have my block the way I want it, and @rjbrown99 could have the markup to manipulate with CSS/JS.

I'm done with my stuff now :)

I did a MYMODULE_nested_facet_items to print out all terms per #6 above. That was a good start. I then did a theme_apachesolr_facet_list to add some CSS classes, theme_apachesolr_facet_link to add more CSS classes, and theme_apachesolr_unclick_link to to the same thing. It took a bit of time to slog through it all but it wasn't terribly difficult. It was actually harder trying to retrofit the nice menus CSS classes to the menu than it was to modify the php code.

You can see it here if you like - look at the first block on the left side for Category.

Very nice! I will have to look into doing it this way... and hopefully being able to modify the core module to provide this as a configurable option.

Subscribing.

This is great progress although it still doesn't solve the initial issue. Mainly, that when you select a child node it actually chooses all the terms down to the child node.

What happens when you have...

Fruit
* Apples
** Red Delicious
* Bananas
** Manzano Banana
** Plantain

If I select Red Delicious then I am selecting all the terms in the tree which isn't the behaviour that we were trying to discover here. Mainly how to we go about doing an OR of terms so that a person could select 'Red Delicious' and 'Plaintain'. This would then would search for those term ID's specifically.

Or if they selected the parent Fruit it would select the entire Tree of terms.

Looks like we might be able to change the limits displayed in apachesolr_search.module around line 724?

    $items = apachesolr_search_nested_facet_items($query, $facets, $response->response->numFound);
    // Process all terms into an item list
    if ($items && ($response->response->numFound > 1 || $contains_active)) {
      $initial_limits = variable_get('apachesolr_facet_query_initial_limits', array());
      $limit = isset($initial_limits['apachesolr_search'][$delta]) ? $initial_limits['apachesolr_search'][$delta] : variable_get('apachesolr_facet_query_initial_limit_default', 10);
      return array(
        'subject' => t('Filter by @name', array('@name' => $vocab->name)),
        'content' => theme('apachesolr_facet_list', $items, $limit),
      );
    }

Additionally, we could modify the theme function for the facet list, perhaps... (this is in apachesolr.module, around line 1812... which is a great overture)

function theme_apachesolr_facet_list($items, $display_limit = 0) {
  // theme('item_list') expects a numerically indexed array.
  $items = array_values($items);
  // If there is a limit and the facet count is over the limit, hide the rest.
  if (($display_limit > 0) && (count($items) > $display_limit)) {
    // Show/hide extra facets.
    drupal_add_js(drupal_get_path('module', 'apachesolr') . '/apachesolr.js');
    // Split items array into displayed and hidden.
    $hidden_items = array_splice($items, $display_limit);
    foreach ($hidden_items as $hidden_item) {
      if (!is_array($hidden_item)) {
        $hidden_item = array('data' => $hidden_item);
      }
      $hidden_item['class'] = isset($hidden_item['class']) ? $hidden_item['class'] . ' apachesolr-hidden-facet' : 'apachesolr-hidden-facet';
      $items[] = $hidden_item;
    }
  }
  $admin_link = '';
  if (user_access('administer search')) {
    $admin_link = l(t('Configure enabled filters'), 'admin/settings/apachesolr/enabled-filters');
  }
  return theme('item_list', $items) . $admin_link;
}

I don't have a lot of time right now to work on this, but I'm posting these two snippets for reference, since I'll probably not get back to working on this issue for a bit of time!

Based on #6 and #7

Will review...

This patch works great! RTBC, for sure! (ignore the attachment... was confused by a 6.x-2.x feature)

Added uninstall hook. Renamed variable to apachesolr_facet_show_children. Changed help text in block config. Need to be ported to other versions after commit here.

Reviewed and gets the thumbs up from me (not tested though)

Moved variable_get out of for-loop. Added isset. Committed to 6.1, 6.2 and 7.
#791916 by Network | jpmckinney: Allow facet search block to have children always show

Thanks!

this doesn't work, it checks for $field_name, but this variable isn't set..

patch fixes it (drupal 6)