interface SolrProcessorInterface in Search API Solr 8.2

Provides an interface for Search API Solr processor plugins.

Processors can act at many locations in the overall Search API process. These locations are subsumed under the label "Stages" and defined by the STAGE_* constants on this interface. A processor should take care to clearly define for which stages it should run, in addition to implementing the corresponding methods.

Hierarchy

• interface \Drupal\search_api\Plugin\HideablePluginInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface
  • interface \Drupal\search_api\Plugin\ConfigurablePluginInterface
    • interface \Drupal\search_api\Plugin\IndexPluginInterface
      • interface \Drupal\search_api\Processor\ProcessorInterface
        • interface \Drupal\search_api_solr\SolrProcessorInterface

See also

\Drupal\search_api\Annotation\SearchApiProcessor

\Drupal\search_api\Processor\ProcessorPluginManager

\Drupal\search_api\Processor\ProcessorPluginBase

Plugin API

3 files declare their use of SolrProcessorInterface

DoubleQuoteWorkaround.php in src/Plugin/search_api/processor/DoubleQuoteWorkaround.php

SearchApiSolrBackend.php in src/Plugin/search_api/backend/SearchApiSolrBackend.php

StreamingExpressionBuilder.php in src/Utility/StreamingExpressionBuilder.php

File

src/SolrProcessorInterface.php, line 21

Namespace

Drupal\search_api_solr

interface SolrProcessorInterface extends ProcessorInterface {

  /**
   * Encode a streaming expression value.
   *
   * @param string $value
   *
   * @return string|NULL
   */
  public function encodeStreamingExpressionValue(string $value);

  /**
   * Decode a streaming expression value.
   *
   * @param string $value
   *
   * @return string|NULL
   */
  public function decodeStreamingExpressionValue(string $value);

}

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
ConfigurablePluginInterface::getDescription	public	function	Returns the plugin's description.	1
ConfigurablePluginInterface::label	public	function	Returns the label for use on the administration pages.	1
ConfigurablePluginInterface::onDependencyRemoval	public	function	Informs the plugin that some of its dependencies are being removed.	1
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	112
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
DerivativeInspectionInterface::getBaseId	public	function	Gets the base_plugin_id of the plugin instance.	1
DerivativeInspectionInterface::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.	1
HideablePluginInterface::isHidden	public	function	Determines whether this plugin should be hidden in the UI.	1
IndexPluginInterface::getIndex	public	function	Retrieves the index this plugin is configured for.	1
IndexPluginInterface::setIndex	public	function	Sets the index this plugin is configured for.	1
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
ProcessorInterface::addFieldValues	public	function	Adds the values of properties defined by this processor to the item.	1
ProcessorInterface::alterIndexedItems	public	function	Alter the items to be indexed.	1
ProcessorInterface::getPropertyDefinitions	public	function	Retrieves the properties this processor defines for the given datasource.	1
ProcessorInterface::getWeight	public	function	Returns the weight for a specific processing stage.	1
ProcessorInterface::isLocked	public	function	Determines whether this processor should always be enabled.	1
ProcessorInterface::postprocessSearchResults	public	function	Postprocess search results before they are returned by the query.	1
ProcessorInterface::preIndexSave	public	function	Preprocesses the search index entity before it is saved.	1
ProcessorInterface::preprocessIndexItems	public	function	Preprocesses search items for indexing.	1
ProcessorInterface::preprocessSearchQuery	public	function	Preprocesses a search query.	1
ProcessorInterface::requiresReindexing	public	function	Determines whether re-indexing is required after a settings change.	1
ProcessorInterface::setWeight	public	function	Sets the weight for a specific processing stage.	1
ProcessorInterface::STAGE_ADD_PROPERTIES		constant	Processing stage: add properties.
ProcessorInterface::STAGE_ALTER_ITEMS		constant	Processing stage: alter indexed items.
ProcessorInterface::STAGE_POSTPROCESS_QUERY		constant	Processing stage: postprocess query.
ProcessorInterface::STAGE_PREPROCESS_INDEX		constant	Processing stage: preprocess index.
ProcessorInterface::STAGE_PREPROCESS_QUERY		constant	Processing stage: preprocess query.
ProcessorInterface::STAGE_PRE_INDEX_SAVE		constant	Processing stage: preprocess index.
ProcessorInterface::supportsIndex	public static	function	Checks whether this processor is applicable for a certain index.	1
ProcessorInterface::supportsStage	public	function	Checks whether this processor implements a particular stage.	1
SolrProcessorInterface::decodeStreamingExpressionValue	public	function	Decode a streaming expression value.	1
SolrProcessorInterface::encodeStreamingExpressionValue	public	function	Encode a streaming expression value.	1