class CurrentSearchItemActive in Facet API 7

Current search item plugin that displays the active facet items.

It is a common use case that active items be displayed in the Current Search block as opposed to inline with the facets. This plugin displays the active items in the Current Search block. Administrators can optionally use Token replacements to prefix values with the human readalbe label of the facet that the item belongs to.

Hierarchy

• class \CurrentSearchItem
  • class \CurrentSearchItemActive

1 string reference to 'CurrentSearchItemActive'

current_search_current_search_items in contrib/current_search/current_search.module

Implements hook_current_search_items().

File

contrib/current_search/plugins/current_search/item_active.inc, line 17

The active current search item plugin class.

class CurrentSearchItemActive extends CurrentSearchItem {

  /**
   * Implements CurrentSearchItem::execute().
   */
  public function execute(FacetapiAdapter $adapter) {
    $items = array();

    // Makes sure facet builds are initialized.
    $adapter
      ->processFacets();

    // Initializes links attributes, adds rel="nofollow" if configured.
    $attributes = $this->settings['nofollow'] ? array(
      'rel' => 'nofollow',
    ) : array();
    $attributes += array(
      'class' => array(),
    );

    // Gets the translated pattern with token replacements in tact.
    $pattern = $this
      ->translate('pattern', $this->settings['pattern']);

    // Adds the keywords if any were passed.
    $keys = $adapter
      ->getSearchKeys();
    $keys_link = isset($this->settings['keys_link']) ? $this->settings['keys_link'] : FALSE;
    if ($this->settings['keys'] && !$keys_link && $keys) {
      $items[] = theme('current_search_keys', array(
        'keys' => $keys,
        'adapter' => $adapter,
      ));
    }
    elseif ($this->settings['keys'] && $keys_link && $keys) {
      $active_items = $adapter
        ->getAllActiveItems();
      if (count($active_items) > 0) {
        $item = reset($active_items);
        $item['adapter'] = $adapter;
        if (!isset($item['name'])) {
          $item['name'] = $item['field alias'];
        }
        $item['adapter'] = $adapter;
        $path = $adapter
          ->getUrlProcessor()
          ->getFacetPath($item, $this
          ->getItemValues($item, $adapter), 0);
        $params = $adapter
          ->getUrlProcessor()
          ->getQueryString($item, $this
          ->getItemValues($item, $adapter), 0);
      }
      else {
        $path = $adapter
          ->getSearchPath();
        $params = $adapter
          ->getUrlProcessor()
          ->getParams();
      }

      // Remove the keywords param if one is configured.
      if ($target_param = $this->settings['keys_param']) {
        unset($params[$target_param]);
      }
      elseif (strpos($path, $keys) !== FALSE) {
        $parts = array_filter(explode('/', $path));
        if ($keys == end($parts)) {
          $part = key($parts);
          unset($parts[$part]);
          $path = implode('/', $parts);
        }
      }
      $variables = array(
        'text' => theme('current_search_keys', array(
          'keys' => $keys,
          'adapter' => $adapter,
        )),
        'path' => $path,
        'options' => array(
          'attributes' => $attributes,
          'html' => TRUE,
          'query' => $params,
        ),
      );
      $items[] = theme('current_search_link_active', $variables);
    }

    // Adds active facets to the current search block.
    foreach ($adapter
      ->getAllActiveItems() as $item) {

      // Adds adapter to the active item for token replacement.
      $item['adapter'] = $adapter;

      // Builds variables to pass to theme function.
      $data = array(
        'facetapi_active_item' => $item,
      );
      $variables = array(
        'text' => token_replace($pattern, $data),
        'path' => $this
          ->getFacetPath($item, $adapter),
        'options' => array(
          'attributes' => $attributes,
          'html' => TRUE,
          'query' => $this
            ->getQueryString($item, $adapter),
        ),
      );

      // Renders the active link.
      $row['data'] = theme('current_search_link_active', $variables);
      $row['class'][] = 'active';
      $items[] = $row;
    }

    // If there are items, return the render array.
    if ($items) {
      $classes = $this->settings['css'] ? current_search_get_classes($this->settings['classes']) : array();
      return array(
        '#theme' => 'item_list__facetapi__current_search_item_active',
        '#items' => $items,
        '#attributes' => array(
          'class' => $classes,
        ),
      );
    }
  }

  /**
   * Implements CurrentSearchItem::settingsForm().
   */
  public function settingsForm(&$form, &$form_state) {
    $form['pattern'] = array(
      '#type' => 'textfield',
      '#title' => t('Pattern'),
      '#default_value' => $this->settings['pattern'],
      '#description' => t('The pattern used to render active items in the list. Token replacement patterns are allowed.'),
      '#maxlength' => 255,
    );
    $form['keys'] = array(
      '#type' => 'checkbox',
      '#title' => t('Append the keywords passed by the user to the list'),
      '#default_value' => isset($this->settings['keys']) ? $this->settings['keys'] : TRUE,
    );
    $form['keys_link'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display the keywords as a link to remove them from the search'),
      '#default_value' => isset($this->settings['keys_link']) ? $this->settings['keys_link'] : TRUE,
      '#states' => array(
        'visible' => array(
          ':input[name="plugin_settings[' . $this->name . '][keys]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $form['keys_param'] = array(
      '#type' => 'textfield',
      '#title' => t('Keywords parameter'),
      '#default_value' => isset($this->settings['keys_param']) ? $this->settings['keys_param'] : '',
      '#description' => t('Provide the URL parameter used for search keywords. For example, enter "query" if the search URL is "search/books?query={keywords}". If no parameter is provided, it is assumed that keywords are the last part of the path.'),
      '#states' => array(
        'visible' => array(
          ':input[name="plugin_settings[' . $this->name . '][keys]"]' => array(
            'checked' => TRUE,
          ),
          ':input[name="plugin_settings[' . $this->name . '][keys_link]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $form['css'] = array(
      '#type' => 'checkbox',
      '#title' => t('Add CSS classes to wrapper element'),
      '#default_value' => $this->settings['css'],
    );
    $form['classes'] = array(
      '#type' => 'textfield',
      '#title' => t('CSS classes'),
      '#default_value' => $this->settings['classes'],
      '#description' => t('A comma separated list of CSS classes.'),
      '#maxlength' => 128,
      '#states' => array(
        'visible' => array(
          ':input[name="plugin_settings[' . $this->name . '][css]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $form['nofollow'] = array(
      '#type' => 'checkbox',
      '#title' => t('Prevent crawlers from following active item links'),
      '#default_value' => $this->settings['nofollow'],
      '#description' => t('Add the <code>rel="nofollow"</code> attribute to active item links to maximize SEO by preventing crawlers from indexing duplicate content and getting stuck in loops.'),
    );

    // Adds token tree.
    $form['tokens'] = $this
      ->getTokenTree(array(
      'facetapi_active',
    ));
  }

  /**
   * Implements CurrentSearchItem::getDefaultSettings().
   */
  public function getDefaultSettings() {
    return array(
      'pattern' => '[facetapi_active:active-value]',
      'keys' => FALSE,
      'css' => FALSE,
      'classes' => '',
      'nofollow' => 1,
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CurrentSearchItem::$configName	protected	property	The machine readable name of current search block configuration.
CurrentSearchItem::$itemValues	protected	property	An array keyed by item position to its value and all its children.
CurrentSearchItem::$name	protected	property	The machine readable name of the current search item plugin.
CurrentSearchItem::$settings	protected	property	An array of the current search item's settings.
CurrentSearchItem::getFacetPath	public	function	Helper function that returns a facet's path.
CurrentSearchItem::getItemValues	public	function	Helper function that returns the item's value and its children.
CurrentSearchItem::getQueryString	public	function	Helper function that returns a facet's query string.
CurrentSearchItem::getTokenTree	public	function	Returns the token tree element.
CurrentSearchItem::translate	public	function	Helper function for translating strings.
CurrentSearchItem::wrapperDefaults	public	function	Returns defaults for the wrapper HTML elements.
CurrentSearchItem::wrapperForm	public	function	Returns form elements that allow users to add wrapper HTML around items.
CurrentSearchItem::__construct	public	function	Constructs a CurrentSearchItem object.
CurrentSearchItemActive::execute	public	function	Implements CurrentSearchItem::execute(). Overrides CurrentSearchItem::execute
CurrentSearchItemActive::getDefaultSettings	public	function	Implements CurrentSearchItem::getDefaultSettings(). Overrides CurrentSearchItem::getDefaultSettings
CurrentSearchItemActive::settingsForm	public	function	Implements CurrentSearchItem::settingsForm(). Overrides CurrentSearchItem::settingsForm