interface SolrProcessorInterface in Search API Solr 4.x

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_solr\SolrProcessorInterface extends \Drupal\search_api\Processor\ProcessorInterface

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 {

  /**
   * Encodes a streaming expression value.
   *
   * @param string $value
   *   The string to be encoded.
   *
   * @return string|null
   *   The encoded string.
   */
  public function encodeStreamingExpressionValue(string $value);

  /**
   * Decodes a streaming expression value.
   *
   * @param string $value
   *   The string to be decoded.
   *
   * @return string|null
   *   The decoded string.
   */
  public function decodeStreamingExpressionValue(string $value);

}

Members

Name	Modifiers	Type	Description	Overrides
SolrProcessorInterface::decodeStreamingExpressionValue	public	function	Decodes a streaming expression value.	1
SolrProcessorInterface::encodeStreamingExpressionValue	public	function	Encodes a streaming expression value.	1