public static function ProcessorInterface::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.
1 method overrides ProcessorInterface::supportsIndex()
- ProcessorPluginBase::supportsIndex in src/
Processor/ ProcessorPluginBase.php - Checks whether this processor is applicable for a certain index.
File
- src/
Processor/ ProcessorInterface.php, line 87
Class
- ProcessorInterface
- Provides an interface for Search API processor plugins.
Namespace
Drupal\search_api\ProcessorCode
public static function supportsIndex(IndexInterface $index);