class Terms in Search API 8

Represents a parse mode that parses the input into multiple words.

Plugin annotation


@SearchApiParseMode(
  id = "terms",
  label = @Translation("Multiple words"),
  description = @Translation("The query is interpreted as multiple keywords separated by spaces. Keywords containing spaces may be ""quoted"". Quoted keywords must still be separated by spaces. Keywords can be negated by prepending a minus sign (-) to them."),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\search_api\Plugin\HideablePluginBase implements HideablePluginInterface
    class \Drupal\search_api\ParseMode\ParseModePluginBase implements ParseModeInterface
    class \Drupal\search_api\Plugin\search_api\parse_mode\Terms

Expanded class hierarchy of Terms

2 files declare their use of Terms

SearchApiQuery.php in src/Plugin/views/query/SearchApiQuery.php
TermsParseModeTest.php in tests/src/Unit/TermsParseModeTest.php

2 string references to 'Terms'

AddHierarchyTest::setUp in tests/src/Kernel/Processor/AddHierarchyTest.php: Performs setup tasks before each individual test method is run.
ProcessorIntegrationTest::setUp in tests/src/Functional/ProcessorIntegrationTest.php

File

src/Plugin/search_api/parse_mode/Terms.php, line 16

Namespace

Drupal\search_api\Plugin\search_api\parse_mode

View source

class Terms extends ParseModePluginBase {

  /**
   * {@inheritdoc}
   */
  public function parseInput($keys) {

    // Split the keys into tokens. Any whitespace is considered as a delimiter
    // for tokens. This covers ASCII white spaces as well as multi-byte "spaces"
    // which for example are common in Japanese.
    $tokens = preg_split('/\\s+/u', $keys);
    $quoted = FALSE;
    $negated = FALSE;
    $phrase_contents = [];
    $ret = [
      '#conjunction' => $this
        ->getConjunction(),
    ];
    foreach ($tokens as $token) {

      // Ignore empty tokens. (Also helps keep the following code simpler.)
      if ($token === '') {
        continue;
      }

      // Check for negation.
      if ($token[0] === '-' && !$quoted) {
        $token = ltrim($token, '-');

        // If token is empty after trimming, ignore it.
        if ($token === '') {
          continue;
        }
        $negated = TRUE;
      }

      // Depending on whether we are currently in a quoted phrase, or maybe just
      // starting one, act accordingly.
      if ($quoted) {
        if (substr($token, -1) === '"') {
          $token = substr($token, 0, -1);
          $phrase_contents[] = trim($token);
          $phrase_contents = array_filter($phrase_contents, 'strlen');
          $phrase_contents = implode(' ', $phrase_contents);
          if ($phrase_contents !== '') {
            $ret[] = $phrase_contents;
          }
          $quoted = FALSE;
        }
        else {
          $phrase_contents[] = trim($token);
          continue;
        }
      }
      elseif ($token[0] === '"') {
        $len = strlen($token);
        if ($len > 1 && $token[$len - 1] === '"') {
          $ret[] = substr($token, 1, -1);
        }
        else {
          $phrase_contents = [
            trim(substr($token, 1)),
          ];
          $quoted = TRUE;
          continue;
        }
      }
      else {
        $ret[] = $token;
      }

      // If negation was set, change the last added keyword to be negated.
      if ($negated) {
        $i = count($ret) - 2;
        $ret[$i] = [
          '#negation' => TRUE,
          '#conjunction' => 'AND',
          $ret[$i],
        ];
        $negated = FALSE;
      }
    }

    // Take care of any quoted phrase missing its closing quotation mark.
    if ($quoted) {
      $phrase_contents = implode(' ', array_filter($phrase_contents, 'strlen'));
      if ($phrase_contents !== '') {
        $ret[] = $phrase_contents;
      }
    }
    return $ret;
  }

}

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
HideablePluginBase::isHidden	public	function	Determines whether this plugin should be hidden in the UI. Overrides HideablePluginInterface::isHidden	1
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
ParseModePluginBase::$conjunction	protected	property	The default conjunction to use when parsing keywords.
ParseModePluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ParseModePluginBase::getConjunction	public	function	Retrieves the default conjunction. Overrides ParseModeInterface::getConjunction
ParseModePluginBase::getDescription	public	function	Returns the description of the parse mode. Overrides ParseModeInterface::getDescription
ParseModePluginBase::label	public	function	Returns the label of the parse mode. Overrides ParseModeInterface::label
ParseModePluginBase::setConjunction	public	function	Sets the default conjunction. Overrides ParseModeInterface::setConjunction
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.
Terms::parseInput	public	function	Parses search keys input by the user. Overrides ParseModeInterface::parseInput

You are here

class Terms in Search API 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation