class FacetapiAjaxWidgetSelect in Ajax facets 7.2

Widget that renders facets as a list of clickable links.

Links make it easy for users to narrow down their search results by clicking on them. The render arrays use theme_item_list() to generate the HTML markup.

Hierarchy

• class \FacetapiAjaxWidget extends \FacetapiWidgetCheckboxLinks
  • class \FacetapiAjaxWidgetSelect

1 string reference to 'FacetapiAjaxWidgetSelect'

ajax_facets_facetapi_widgets in ./ajax_facets.module

Implements hook_facetapi_widgets().

File

plugins/facetapi/ajax_widget_select.inc, line 14

The facetapi_links and facetapi_checkbox_links widget plugin classes.

class FacetapiAjaxWidgetSelect extends FacetapiAjaxWidget {

  /**
   * Overrides FacetapiWidgetCheckboxLinks::init().
   */
  public function init() {
    parent::init();
    drupal_add_js(array(
      'facetapi' => array(
        'ajax_select_box' => array(
          'default_value' => t('Select'),
        ),
      ),
    ), 'setting');
    ajax_facets_add_ajax_js($this->facet);
  }

  /**
   * Overrides FacetapiWidget::getDefaultSettings().
   */
  function getDefaultSettings() {
    return array(
      'selectbox_update_results' => 1,
      'selectbox_show_reset_link' => 0,
    );
  }

  /**
   * Transforms the render array for use with theme_item_list().
   *
   * The recursion allows this function to act on the various levels of a
   * hierarchical data set.
   *
   * @param array $build
   *   The items in the facet's render array being transformed.
   *
   * @return array
   *   The "items" parameter for theme_item_list().
   */
  function buildListItems($build, $level = 0) {

    // Builds rows.
    $items = array();

    // Add default item only once.
    if ($level == 0) {
      $items['values'][0] = t('Select');
    }
    $prefix = str_repeat('-', $level);
    $level++;
    $active_items = array();
    $have_active = FALSE;
    foreach ($build as $value => $item) {

      // Respect current selection.
      if ($item['#active']) {
        $items['active_value'] = $value;
        $have_active = TRUE;
        $active_items[] = $this->key . ':' . $item['#markup'];
      }
      $items['values'][$item['#indexed_value']] = $prefix . $item['#markup'] . theme('facetapi_count', array(
        'count' => $item['#count'],
      ));
      if (!empty($item['#item_children'])) {
        $childrens = $this
          ->buildListItems($item['#item_children'], $level);
        if (!empty($childrens['active_value'])) {
          $items['active_value'] = $childrens['active_value'];
        }
        $items['values'] = $items['values'] + $childrens['values'];
      }
    }
    $this->jsSettings['haveActiveSelection'] = $this->settings->settings['have_active_selection'] = $have_active;
    sort($active_items);
    $this->jsSettings['activeItems'] = $active_items;

    // Generate reset path on server side to make possible to use aliases.
    if ($have_active) {
      $this->jsSettings['resetPath'] = ajax_facets_facet_build_reset_path($this->facet
        ->getFacet(), $this->facet
        ->getAdapter());
    }
    return $items;
  }

  /**
   * Implements FacetapiWidget::execute().
   *
   * Transforms the render array into something that can be themed by
   * theme_item_list().
   *
   * @see FacetapiWidgetLinks::setThemeHooks()
   * @see FacetapiWidgetLinks::buildListItems()
   */
  public function execute() {
    $element =& $this->build[$this->facet['field alias']];
    $items = $this
      ->buildListItems($element);

    // If name is empty - use label.
    if (empty($items['name'])) {
      $facet = $this->facet
        ->getFacet();
      $items['name'] = $facet['label'];
    }
    $select = array(
      '#type' => 'select',
      '#title' => $this->build['#title'],
      '#options' => $items['values'],
      '#id' => 'ajax-facets-selectbox-' . str_replace(array(
        '_',
        ' ',
        ':',
      ), '-', $this->settings->facet),
      '#name' => urlencode($this->settings->facet),
      '#attributes' => array(
        'data-facet' => $this->settings->facet,
      ),
    );
    if (!empty($items['active_value'])) {
      $select['#value'] = $items['active_value'];
    }
    $reset_link = '';
    if (!empty($this->settings->settings['show_reset_link']) && $this->settings->settings['show_reset_link']) {
      $reset_link = '<a class="reset-link" href="#">' . t('Reset filter') . '</a>';
    }
    $element = array(
      '#markup' => '<div class="facet-wrapper-selectbox ' . $this->build['#attributes']['id'] . '">' . $reset_link . render($select) . '</div>',
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FacetapiAjaxWidget::settingsForm		function	Overrides FacetapiWidget::settingsForm().	1
FacetapiAjaxWidgetSelect::buildListItems		function	Transforms the render array for use with theme_item_list().
FacetapiAjaxWidgetSelect::execute	public	function	Implements FacetapiWidget::execute().
FacetapiAjaxWidgetSelect::getDefaultSettings		function	Overrides FacetapiWidget::getDefaultSettings().
FacetapiAjaxWidgetSelect::init	public	function	Overrides FacetapiWidgetCheckboxLinks::init().