You are here

public function Server::isAvailable in Search API 8

Returns a boolean with the availability of the backend.

This can implement a specific call to test if the backend is available for reading. For SOLR or elasticsearch this would be a "ping" to the server to test if it's online. If this is a db-backend that is running on a separate server, this can also be a ping. When it's a db-backend that runs in the same database as the drupal installation; just returning TRUE is enough.

Return value

bool The availability of the backend.

Overrides BackendSpecificInterface::isAvailable

File

src/Entity/Server.php, line 197

Class

Server
Defines the search server configuration entity.

Namespace

Drupal\search_api\Entity

Code

public function isAvailable() {
  return $this
    ->hasValidBackend() ? $this
    ->getBackend()
    ->isAvailable() : FALSE;
}