public function SearchApiAlgoliaBackend::removeIndex in Search API Algolia 8

Same name and namespace in other branches

1. 3.0.x src/Plugin/search_api/backend/SearchApiAlgoliaBackend.php \Drupal\search_api_algolia\Plugin\search_api\backend\SearchApiAlgoliaBackend::removeIndex()
2. 2.0.x src/Plugin/search_api/backend/SearchApiAlgoliaBackend.php \Drupal\search_api_algolia\Plugin\search_api\backend\SearchApiAlgoliaBackend::removeIndex()

Removes an index from this server.

This might mean that the index has been deleted, or reassigned to a different server. If you need to distinguish between these cases, inspect $index->getServerId().

If the index wasn't added to the server previously, the method call should be ignored.

Implementations of this method should also check whether $index->isReadOnly() and don't delete any indexed data if it is.

Parameters

\Drupal\search_api\IndexInterface|string $index: Either an object representing the index to remove, or its ID (if the index was completely deleted).

Throws

\Drupal\search_api\SearchApiException Thrown if an error occurred while removing the index.

Overrides BackendPluginBase::removeIndex

File

src/Plugin/search_api/backend/SearchApiAlgoliaBackend.php, line 185

Class

SearchApiAlgoliaBackend

Class SearchApiAlgoliaBackend.

Namespace

Drupal\search_api_algolia\Plugin\search_api\backend

Code

public function removeIndex($index) {

  // Only delete the index's data if the index isn't read-only.
  if (!is_object($index) || empty($index
    ->get('read_only'))) {
    $this
      ->deleteAllIndexItems($index);
  }
}