public function ProcessorPluginBase::requiresReindexing in Search API 8

Determines whether re-indexing is required after a settings change.

Enabling a processor, or changing it's settings, isn't always an action that requires an index to be reindexed. This method should return FALSE if re-indexing is not necessary and TRUE if it is.

Parameters

array|null $old_settings: NULL if the processor is being enabled. Otherwise, an associative array containing the old user settings for the processor. The processor-specific configuration is available under key "settings", while "weights" contains the respective weights for the different stages which this processor supports.

array|null $new_settings: NULL if the processor is being disabled. Otherwise, an associative array containing the new user settings for the processor. The processor-specific configuration is available under key "settings", while "weights" contains the respective weights for the different stages which this processor supports.

Return value

bool TRUE if this change means the index should be scheduled for re-indexing; FALSE otherwise.

Overrides ProcessorInterface::requiresReindexing

File

src/Processor/ProcessorPluginBase.php, line 185

Class

ProcessorPluginBase

Defines a base class from which other processors may extend.

Namespace

Drupal\search_api\Processor

Code

public function requiresReindexing(array $old_settings = NULL, array $new_settings = NULL) {

  // Only require re-indexing for processors that actually run during the
  // indexing process.
  return $this
    ->supportsStage(ProcessorInterface::STAGE_PREPROCESS_INDEX);
}