public function StreamingExpressionQueryHelper::setStreamingExpression in Search API Solr 4.x

Same name and namespace in other branches

1. 8.3 src/Utility/StreamingExpressionQueryHelper.php \Drupal\search_api_solr\Utility\StreamingExpressionQueryHelper::setStreamingExpression()
2. 8.2 src/Utility/StreamingExpressionQueryHelper.php \Drupal\search_api_solr\Utility\StreamingExpressionQueryHelper::setStreamingExpression()

Applies a streaming expression for a given Search API query.

Parameters

\Drupal\search_api\Query\QueryInterface $query: The Search API query.

\Drupal\search_api_solr\Utility\string $streaming_expression: The streaming expression to set for this query.

\Drupal\search_api_solr\Utility\string $comment: A comment of the streaming expression.

File

src/Utility/StreamingExpressionQueryHelper.php, line 39

Class

StreamingExpressionQueryHelper

Provides methods for creating streaming expressions.

Namespace

Drupal\search_api_solr\Utility

Code

public function setStreamingExpression(QueryInterface $query, string $streaming_expression, string $comment = '') {
  if ($comment) {
    $query
      ->setOption('solr_streaming_expression_comment', $comment);
  }
  $query
    ->setOption('solr_streaming_expression', $streaming_expression);
}