class RptMapWidget in Search API Location 8

A widget class that provides a map interface to narrow down facet results.

Plugin annotation

@FacetsWidget(
  id = "rpt",
  label = @Translation("Interactive map showing the clustered heatmap"),
  description = @Translation("A configurable widget that builds an location array with results."),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\facets\Widget\WidgetPluginBase implements WidgetPluginInterface
      • class \Drupal\facets_map_widget\Plugin\facets\widget\RptMapWidget

1 file declares its use of RptMapWidget

RptMapWidgetTest.php in modules/facets_map_widget/tests/src/Unit/Plugin/widget/RptMapWidgetTest.php

File

modules/facets_map_widget/src/Plugin/facets/widget/RptMapWidget.php, line 17

Namespace

Drupal\facets_map_widget\Plugin\facets\widget

class RptMapWidget extends WidgetPluginBase {

  /**
   * {@inheritdoc}
   */
  public function build(FacetInterface $facet) {

    /** @var \Drupal\facets\Result\Result[] $results */
    $results = $facet
      ->getResults();
    $build['map'] = [
      '#type' => 'html_tag',
      '#tag' => 'div',
      '#attributes' => [
        'class' => [
          'facets-map',
        ],
        'id' => $facet
          ->id(),
      ],
    ];
    $build['#attached']['library'][] = 'facets_map_widget/facets_map';
    $build['#attached']['drupalSettings']['facets']['map'] = [
      'id' => $facet
        ->id(),
      'url' => $results[0]
        ->getUrl()
        ->toString(),
      'results' => json_encode($results[0]
        ->getRawValue()),
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function isPropertyRequired($name, $type) {
    if ($name === 'rpt' && $type === 'processors') {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getQueryType() {
    return 'search_api_rpt';
  }

}

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
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.
RptMapWidget::build	public	function	Builds the facet widget for rendering. Overrides WidgetPluginBase::build
RptMapWidget::getQueryType	public	function	Picks the preferred query type for this widget. Overrides WidgetPluginBase::getQueryType
RptMapWidget::isPropertyRequired	public	function	Checks is a specific property is required for this widget. Overrides WidgetPluginBase::isPropertyRequired
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.
WidgetPluginBase::$facet	protected	property	The facet the widget is being built for.
WidgetPluginBase::$showNumbers	protected	property	Show the amount of results next to the result.
WidgetPluginBase::buildConfigurationForm	public	function	Provides a configuration form for this widget. Overrides WidgetPluginInterface::buildConfigurationForm	3
WidgetPluginBase::buildListItems	protected	function	Builds a renderable array of result items.	1
WidgetPluginBase::buildResultItem	protected	function	Builds a facet result item.
WidgetPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
WidgetPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	3
WidgetPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
WidgetPluginBase::getFacetItemListThemeHook	protected	function	Provides a full array of possible theme functions to try for a given hook.
WidgetPluginBase::prepareLink	protected	function	Returns the text or link for an item.
WidgetPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
WidgetPluginBase::supportsFacet	public	function	Checks if the facet is supported by this processor. Overrides WidgetPluginInterface::supportsFacet	1
WidgetPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct