class ApacheSolrFacetapiAdapter in Apache Solr Search 8

Facet API adapter for the Apache Solr Search Integration module.

Hierarchy

• class \ApacheSolrFacetapiAdapter extends \FacetapiAdapter

1 string reference to 'ApacheSolrFacetapiAdapter'

apachesolr_facetapi_adapters in ./apachesolr.module

Implements hook_facetapi_adapters().

File

plugins/facetapi/adapter.inc, line 11

Classes used by the Facet API module.

class ApacheSolrFacetapiAdapter extends FacetapiAdapter {

  /**
   * Returns the path to the admin settings for a given realm.
   *
   * @param string $realm_name
   *   The name of the realm.
   *
   * @return string
   *   The path to the admin settings.
   */
  public function getPath($realm_name) {
    $path = 'admin/config/search/apachesolr/settings';

    // $adapter will be an instance of class FacetapiAdapter
    if ($adapter = menu_get_object('facetapi_adapter', 4)) {

      // Get the environment ID from the machine name of the searcher.
      $env_id = ltrim(strstr($adapter
        ->getSearcher(), '@'), '@');
      $path .= '/' . $env_id . '/facets';

      // Add the realm name to the path if it is not the first one in the list.
      if (key(facetapi_get_realm_info()) != $realm_name) {
        $path .= '/' . $realm_name;
      }
    }
    return $path;
  }

  /**
   * Allows the backend to initialize its query object before adding the facet
   * filters.
   *
   * @param mixed $query
   *   The backend's native object.
   */
  function initActiveFilters($query) {
    $enabled_facets = facetapi_get_enabled_facets($this->info['name']);
    if ($enabled_facets) {
      $query
        ->addParam('facet', 'true');
      $query
        ->addParam('facet.sort', 'count');
      $query
        ->addParam('facet.mincount', '1');
    }
  }

  /**
   * Returns a boolean flagging whether $this->_searcher executed a search.
   */
  public function searchExecuted() {

    // Initial check - has ANY solr query run in our environment.
    $env_id = $this->info['instance'];
    $this_has_searched = apachesolr_has_searched($env_id);

    // Secondary check - do we have results for this searcher?
    $this_has_searched = $this_has_searched && apachesolr_static_response_cache($this
      ->getSearcher());
    return $this_has_searched;
  }

  /**
   * Suppress output of the realm
   *
   * @param string $realm_name
   *
   * @return bool $flag
   *   Returns if it was suppressed or not
   */
  public function suppressOutput($realm_name) {
    $flag = FALSE;
    if ($realm_name == 'block') {
      $env_id = $this->info['instance'];
      $flag = apachesolr_suppress_blocks($env_id);
    }
    return $flag || !$this
      ->searchExecuted();
  }

  /**
   * Returns the search keys.
   *
   * @return string
   */
  public function getSearchKeys() {
    if (NULL === $this->keys) {
      $env_id = $this->info['instance'];
      if ($query = apachesolr_current_query($env_id)) {
        return $query
          ->getParam('q');
      }
    }
    else {
      return $this->keys;
    }
    return FALSE;
  }

  /**
   * Returns the search path.
   *
   * @return string
   *   A string containing the search path.
   *
   * @todo D8 should provide an API function for this.
   */
  public function getSearchPath() {
    $env_id = $this->info['instance'];
    $query = apachesolr_current_query($env_id);
    if (!$query || NULL === $this->searchPath && NULL === $query
      ->getPath()) {
      if ($path = module_invoke($this->info['module'] . '_search', 'search_info')) {
        $this->searchPath = 'search/' . $path['path'];
        if (!isset($_GET['keys']) && ($keys = $this
          ->getSearchKeys())) {
          $this->searchPath .= '/' . $keys;
        }
      }
    }
    if (!$query || NULL === $query
      ->getPath()) {
      return $this->searchPath;
    }
    else {
      return $query
        ->getPath();
    }
  }

  /**
   * Returns the number of total results found for the current search.
   *
   * @return bool|int
   *   Number of results or false if no search response was found
   */
  public function getResultCount() {
    $response = apachesolr_static_response_cache($this
      ->getSearcher());
    if ($response) {
      return $response->response->numFound;
    }
    return FALSE;
  }

  /**
   * Allows for backend specific overrides to the settings form.
   *
   * @param array $form
   * @param array $form_state
   */
  public function settingsForm(&$form, &$form_state) {
    $form['#validate'][] = 'apachesolr_facet_form_validate';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ApacheSolrFacetapiAdapter::getPath	public	function	Returns the path to the admin settings for a given realm.
ApacheSolrFacetapiAdapter::getResultCount	public	function	Returns the number of total results found for the current search.
ApacheSolrFacetapiAdapter::getSearchKeys	public	function	Returns the search keys.
ApacheSolrFacetapiAdapter::getSearchPath	public	function	Returns the search path.
ApacheSolrFacetapiAdapter::initActiveFilters		function	Allows the backend to initialize its query object before adding the facet filters.
ApacheSolrFacetapiAdapter::searchExecuted	public	function	Returns a boolean flagging whether $this->_searcher executed a search.
ApacheSolrFacetapiAdapter::settingsForm	public	function	Allows for backend specific overrides to the settings form.
ApacheSolrFacetapiAdapter::suppressOutput	public	function	Suppress output of the realm