public function BackendSpecificInterface::removeIndex in Search API 8
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.
2 methods override BackendSpecificInterface::removeIndex()
- BackendPluginBase::removeIndex in src/
Backend/ BackendPluginBase.php - Removes an index from this server.
- Server::removeIndex in src/
Entity/ Server.php - Removes an index from this server.
File
- src/
Backend/ BackendSpecificInterface.php, line 160
Class
- BackendSpecificInterface
- Defines methods common to search servers and backend plugins.
Namespace
Drupal\search_api\BackendCode
public function removeIndex($index);