class ApacheSolrFacetapiTerm in Apache Solr Search 6.3

Plugin for "term" query types.

Hierarchy

• class \FacetapiQueryType
  • class \ApacheSolrFacetapiTerm implements FacetapiQueryTypeInterface

1 string reference to 'ApacheSolrFacetapiTerm'

apachesolr_facetapi_query_types in ./apachesolr.module

Implements hook_facetapi_query_types().

File

plugins/facetapi/query_type_term.inc, line 11

Term query type plugin for the Apache Solr adapter.

class ApacheSolrFacetapiTerm extends FacetapiQueryType implements FacetapiQueryTypeInterface {

  /**
   * Returns the query type associated with the plugin.
   *
   * @return string
   *   The query type.
   */
  public static function getType() {
    return 'term';
  }

  /**
   * Adds the filter to the query object.
   *
   * @param DrupalSolrQueryInterface $query
   *   An object containing the query in the backend's native API.
   */
  public function execute($query) {
    $settings = $this->adapter
      ->getFacet($this->facet)
      ->getSettings();

    // Adds the operator parameter.
    $operator = $settings->settings['operator'];
    $ex = FACETAPI_OPERATOR_OR != $operator ? '' : "{!ex={$this->facet['field']}}";
    $query
      ->addParam('facet.field', $ex . $this->facet['field']);
    if (!empty($settings->settings['facet_missing'])) {
      $query
        ->addParam('f.' . $this->facet['field'] . '.facet.missing', 'true');
    }

    // Adds "hard limit" parameter to prevent too many return values.
    $limit = empty($settings->settings['hard_limit']) ? 20 : (int) $settings->settings['hard_limit'];
    $query
      ->addParam('f.' . $this->facet['field'] . '.facet.limit', $limit);

    // Adds "facet mincount" parameter to limit the number of facets.
    if (isset($settings->settings['facet_mincount'])) {
      $count = $settings->settings['facet_mincount'];
      $query
        ->addParam('f.' . $this->facet['field'] . '.facet.mincount', $count);
    }
    $active = $this->adapter
      ->getActiveItems($this->facet);

    // Adds filter based on the operator.
    if (FACETAPI_OPERATOR_OR != $operator) {
      foreach ($active as $value => $item) {

        // Handle facet missing:
        if ($value === '_empty_' && !empty($settings->settings['facet_missing'])) {
          $query
            ->addFilter($this->facet['field'], '[* TO *]', TRUE);
        }
        elseif (strlen($value)) {
          $query
            ->addFilter($this->facet['field'], $value);
        }
      }
    }
    else {

      // OR facet.
      $local = "tag={$this->facet['field']}";
      $values = array_keys($active);
      if ($values) {

        // Quote any values that have white space or colons.
        foreach ($values as &$v) {
          if (preg_match('/[:\\s]/', $v) || strlen($v) == 0) {
            $v = '"' . $v . '"';
          }
        }
        $query
          ->addFilter($this->facet['field'], '(' . implode(' OR ', $values) . ')', FALSE, $local);
      }
    }
  }

  /**
   * Initializes the facet's build array.
   *
   * @return array
   *   The initialized render array.
   */
  public function build() {
    $build = array();
    if ($response = apachesolr_static_response_cache($this->adapter
      ->getSearcher())) {
      $settings = $this->adapter
        ->getFacet($this->facet)
        ->getSettings();
      if (isset($response->facet_counts->facet_fields->{$this->facet['field']})) {
        $values = (array) $response->facet_counts->facet_fields->{$this->facet['field']};
        foreach ($values as $value => $count) {

          // Facet missing may return 0 even if mincount is 1.
          if (empty($settings->settings['facet_mincount']) || $count) {
            $build[$value] = array(
              '#count' => $count,
            );
          }
        }
      }
    }
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ApacheSolrFacetapiTerm::build	public	function	Initializes the facet's build array. Overrides FacetapiQueryTypeInterface::build
ApacheSolrFacetapiTerm::execute	public	function	Adds the filter to the query object. Overrides FacetapiQueryTypeInterface::execute
ApacheSolrFacetapiTerm::getType	public static	function	Returns the query type associated with the plugin. Overrides FacetapiQueryTypeInterface::getType
FacetapiQueryType::$adapter	protected	property	The adapter object.
FacetapiQueryType::$facet	protected	property	The facet definition.
FacetapiQueryType::extract	public	function	Allows additional information to be added to the active items.	2
FacetapiQueryType::getActiveItems	public	function	Returns the facet's active items.
FacetapiQueryType::getSettings	public	function	Returns settings.
FacetapiQueryType::__construct	public	function		1