class SearchApiRpt in Search API Location 8

Provides support for location facets within the Search API scope.

This query type supports SpatialRecursivePrefixTree data type. This specific implementation of the query type supports a generic solution of adding an interactive map facets showing clustered heatmap.

Plugin annotation


@FacetsQueryType(
  id = "search_api_rpt",
  label = @Translation("RecursivePrefixTree Type"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\facets\QueryType\QueryTypePluginBase implements ConfigurableInterface, DependentPluginInterface, QueryTypeInterface uses DependencyTrait
    class \Drupal\facets_map_widget\Plugin\facets\query_type\SearchApiRpt

Expanded class hierarchy of SearchApiRpt

1 file declares its use of SearchApiRpt

SearchApiRptTest.php in modules/facets_map_widget/tests/src/Unit/Plugin/query_type/SearchApiRptTest.php

File

modules/facets_map_widget/src/Plugin/facets/query_type/SearchApiRpt.php, line 20

Namespace

Drupal\facets_map_widget\Plugin\facets\query_type

View source

class SearchApiRpt extends QueryTypePluginBase {

  /**
   * {@inheritdoc}
   */
  public function execute() {
    $query = $this->query;
    $field_identifier = $this->facet
      ->getFieldIdentifier();

    // Set the options for the actual query.
    $options =& $query
      ->getOptions();
    $options['search_api_facets'][$field_identifier] = [
      'field' => $field_identifier,
      'limit' => $this->facet
        ->getHardLimit(),
      'operator' => $this->facet
        ->getQueryOperator(),
      'min_count' => $this->facet
        ->getMinCount(),
      'missing' => FALSE,
    ];

    // Bounding box coordinates which dynamically updated by panning or zooming
    // the map. By default its value is bounding box coordinates of whole world.
    $geom_value = '["-180 -90" TO "180 90"]';
    if (!empty($this->facet
      ->getActiveItems())) {
      $geom_value = reset($this->facet
        ->getActiveItems());
      $geom_value = str_replace([
        '(geom:',
        ')',
      ], [
        '',
        '',
      ], $geom_value);
    }
    $options['search_api_rpt'][$field_identifier] = [
      'field' => $field_identifier,
      'geom' => $geom_value,
      'gridLevel' => '2',
      'maxCells' => '35554432',
      'distErrPct' => '',
      'distErr' => '',
      'format' => 'ints2D',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $query_operator = $this->facet
      ->getQueryOperator();
    if (empty($this->results)) {
      return $this->facet;
    }
    $facet_results = [];
    foreach ($this->results as $key => $result) {
      if ($result['count'] || $query_operator == 'or') {
        $count = $result['count'];
        $result = new Result($this->facet, $result['filter'], "heatmap", $count);
        $facet_results[] = $result;
      }
    }
    $this->facet
      ->setResults($facet_results);
    return $this->facet;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
QueryTypePluginBase::$facet	protected	property	The facet that needs the query type.
QueryTypePluginBase::$linkGenerator	protected	property	The injected link generator.
QueryTypePluginBase::$query	protected	property	The backend native query object.
QueryTypePluginBase::$results	protected	property	The results for the facet.
QueryTypePluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
QueryTypePluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
QueryTypePluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
QueryTypePluginBase::getFacetOptions	protected	function	Builds facet options that will be send to the backend.	1
QueryTypePluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
QueryTypePluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	1
SearchApiRpt::build	public	function	Builds the facet information, so it can be rendered. Overrides QueryTypeInterface::build
SearchApiRpt::execute	public	function	Adds facet info to the query using the backend native query object. Overrides QueryTypeInterface::execute
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here