class SearchApiGranular in Facets 8

Basic support for numeric facets grouping by a granularity value.

Requires the facet widget to set configuration value keyed with granularity.

Plugin annotation


@FacetsQueryType(
  id = "search_api_granular",
  label = @Translation("Numeric query with set granularity"),
)

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\QueryType\QueryTypeRangeBase
    class \Drupal\facets\Plugin\facets\query_type\SearchApiGranular

Expanded class hierarchy of SearchApiGranular

1 file declares its use of SearchApiGranular

SearchApiGranularTest.php in tests/src/Unit/Plugin/query_type/SearchApiGranularTest.php

File

src/Plugin/facets/query_type/SearchApiGranular.php, line 19

Namespace

Drupal\facets\Plugin\facets\query_type

View source

class SearchApiGranular extends QueryTypeRangeBase {

  /**
   * {@inheritdoc}
   */
  public function calculateRange($value) {
    return [
      'start' => $value,
      'stop' => (int) $value + $this
        ->getGranularity(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function build() {

    // If there were no results or no query object, we can't do anything.
    if (empty($this->results)) {
      return $this->facet;
    }
    $supportedFeatures = array_flip($this->query
      ->getIndex()
      ->getServerInstance()
      ->getBackend()
      ->getSupportedFeatures());

    // Range grouping is supported.
    if (isset($supportedFeatures['search_api_granular'])) {
      $query_operator = $this->facet
        ->getQueryOperator();
      $facet_results = [];
      foreach ($this->results as $result) {
        if ($result['count'] || $query_operator == 'or') {
          $result_filter = trim($result['filter'], '"');
          $facet_results[] = new Result($this->facet, $result_filter, $result_filter, $result['count']);
        }
      }
      $this->facet
        ->setResults($facet_results);
      return $this->facet;
    }
    return parent::build();
  }

  /**
   * {@inheritdoc}
   */
  public function calculateResultFilter($value) {
    assert($this
      ->getGranularity() > 0);
    $min_value = (int) $this
      ->getMinValue();
    $max_value = $this
      ->getMaxValue();
    $granularity = $this
      ->getGranularity();
    if ($value < $min_value || !empty($max_value) && $value > $max_value + $granularity - 1) {
      return FALSE;
    }
    return [
      'display' => $value - fmod($value - $min_value, $this
        ->getGranularity()),
      'raw' => $value - fmod($value - $min_value, $this
        ->getGranularity()),
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function getFacetOptions() {
    return $this->facet
      ->getProcessors()['granularity_item']
      ->getConfiguration() + parent::getFacetOptions();
  }

  /**
   * Looks at the configuration for this facet to determine the granularity.
   *
   * Default behaviour an integer for the steps that the facet works in.
   *
   * @return int
   *   If not an integer the inheriting class needs to deal with calculations.
   */
  protected function getGranularity() {
    return $this->facet
      ->getProcessors()['granularity_item']
      ->getConfiguration()['granularity'];
  }

  /**
   * Looks at the configuration for this facet to determine the min value.
   *
   * Default behaviour an integer for the minimum value of the facets.
   *
   * @return mixed
   *   It can be a number or an empty value.
   */
  protected function getMinValue() {
    return $this->facet
      ->getProcessors()['granularity_item']
      ->getConfiguration()['min_value'];
  }

  /**
   * Looks at the configuration for this facet to determine the max value.
   *
   * Default behaviour an integer for the maximum value of the facets.
   *
   * @return mixed
   *   It can be a number or an empty value.
   */
  protected function getMaxValue() {
    return $this->facet
      ->getProcessors()['granularity_item']
      ->getConfiguration()['max_value'];
  }

}

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::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
QueryTypeRangeBase::execute	public	function	Adds facet info to the query using the backend native query object. Overrides QueryTypeInterface::execute
SearchApiGranular::build	public	function	Builds the facet information, so it can be rendered. Overrides QueryTypeRangeBase::build
SearchApiGranular::calculateRange	public	function	Calculate the range for a given facet filter value. Overrides QueryTypeRangeBase::calculateRange
SearchApiGranular::calculateResultFilter	public	function	Calculate the grouped facet filter for a given value. Overrides QueryTypeRangeBase::calculateResultFilter
SearchApiGranular::getFacetOptions	protected	function	Builds facet options that will be send to the backend. Overrides QueryTypePluginBase::getFacetOptions
SearchApiGranular::getGranularity	protected	function	Looks at the configuration for this facet to determine the granularity.
SearchApiGranular::getMaxValue	protected	function	Looks at the configuration for this facet to determine the max value.
SearchApiGranular::getMinValue	protected	function	Looks at the configuration for this facet to determine the min value.
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

class SearchApiGranular in Facets 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation