interface PreQueryProcessorInterface in Facets 8

Processor runs before the query is executed.

Hierarchy

• interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\facets\Processor\ProcessorInterface
    • interface \Drupal\facets\Processor\PreQueryProcessorInterface

5 files declare their use of PreQueryProcessorInterface

DefaultFacetManager.php in src/FacetManager/DefaultFacetManager.php

InvalidQT.php in tests/facets_custom_widget/src/Plugin/facets/processor/InvalidQT.php

RangeSliderProcessor.php in modules/facets_range_widget/src/Plugin/facets/processor/RangeSliderProcessor.php

TestPreQuery.php in tests/facets_custom_widget/src/Plugin/facets/processor/TestPreQuery.php

UrlProcessorHandler.php in src/Plugin/facets/processor/UrlProcessorHandler.php

File

src/Processor/PreQueryProcessorInterface.php, line 10

Namespace

Drupal\facets\Processor

interface PreQueryProcessorInterface extends ProcessorInterface {

  /**
   * Runs before the query is executed.
   *
   * Uses the queryType and the facetSource implementation to make sure the
   * alteration to the query was added before the query is executed in the
   * backend?
   *
   * @param \Drupal\facets\FacetInterface $facet
   *   The facet being changed.
   */
  public function preQuery(FacetInterface $facet);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
PreQueryProcessorInterface::preQuery	public	function	Runs before the query is executed.	4
ProcessorInterface::buildConfigurationForm	public	function	Adds a configuration form for this processor.	2
ProcessorInterface::getDefaultWeight	public	function	Returns the default weight for a specific processing stage.	2
ProcessorInterface::getDescription	public	function	Retrieves the processor description.	2
ProcessorInterface::getQueryType	public	function	Picks the preferred query type for this widget.	1
ProcessorInterface::isHidden	public	function	Determines whether this processor should be hidden from the user.	2
ProcessorInterface::isLocked	public	function	Determines whether this processor should always be enabled.	2
ProcessorInterface::STAGE_BUILD		constant	Processing stage: build.
ProcessorInterface::STAGE_POST_QUERY		constant	Processing stage: post_query.
ProcessorInterface::STAGE_PRE_QUERY		constant	Processing stage: pre_query.
ProcessorInterface::STAGE_SORT		constant	Processing stage: sort.
ProcessorInterface::supportsFacet	public	function	Checks if the facet is supported by this widget.	1
ProcessorInterface::supportsStage	public	function	Checks whether this processor implements a particular stage.	2
ProcessorInterface::validateConfigurationForm	public	function	Validates a configuration form for this processor.	2