You are here

public static function Stemmer::supportsIndex in Search API 8

Checks whether this processor is applicable for a certain index.

This can be used for hiding the processor on the index's "Filters" tab. To avoid confusion, you should only use criteria that are more or less constant, such as the index's datasources. Also, since this is only used for UI purposes, you should not completely rely on this to ensure certain index configurations and at least throw an exception with a descriptive error message if this is violated on runtime.

Parameters

\Drupal\search_api\IndexInterface $index: The index to check for.

Return value

bool TRUE if the processor can run on the given index; FALSE otherwise.

Overrides ProcessorPluginBase::supportsIndex

1 call to Stemmer::supportsIndex()
StemmerTest::testSupportsIndex in tests/src/Unit/Processor/StemmerTest.php
Tests the supportsIndex() method.

File

src/Plugin/search_api/processor/Stemmer.php, line 53

Class

Stemmer
Stems search terms.

Namespace

Drupal\search_api\Plugin\search_api\processor

Code

public static function supportsIndex(IndexInterface $index) : bool {
  $languages = \Drupal::languageManager()
    ->getLanguages();

  // Make processor available only if English is one of the site languages.
  foreach ($languages as $language) {
    if (substr($language
      ->getId(), 0, 2) === 'en') {
      return TRUE;
    }
  }
  return FALSE;
}