function search_api_help in Search API 8

Same name and namespace in other branches

1. 7 search_api.module \search_api_help()

Implements hook_help().

File

./search_api.module, line 35

Provides a rich framework for creating searches.

Code

function search_api_help($route_name) {
  switch ($route_name) {
    case 'search_api.overview':
      $message = t('Below is a list of indexes grouped by the server they are associated with. A server is the definition of the actual indexing, querying and storage engine (for example, an Apache Solr server, the database, …). An index defines the indexed content (for example, all content and all comments on "Article" posts).');
      $search_module_warning = _search_api_search_module_warning();
      if ($search_module_warning) {
        $message = "<p>{$message}</p><p>{$search_module_warning}</p>";
      }
      return $message;
  }
  return NULL;
}