function apachesolr_drush_help in Apache Solr Search 8

Same name and namespace in other branches

1. 5.2 apachesolr.drush.inc \apachesolr_drush_help()
2. 6.3 drush/apachesolr.drush.inc \apachesolr_drush_help()
3. 6 drush/apachesolr.drush.inc \apachesolr_drush_help()
4. 6.2 drush/apachesolr.drush.inc \apachesolr_drush_help()
5. 7 drush/apachesolr.drush.inc \apachesolr_drush_help()

Implements hook_drush_help().

This function is called whenever a drush user calls 'drush help <name-of-your-command>'

Parameters

string $section: A string with the help section (prepend with 'drush:')

Return value

string A string with the help text for your command.

File

drush/apachesolr.drush.inc, line 185

drush integration for apachesolr.

Code

function apachesolr_drush_help($section) {
  switch ($section) {
    case 'drush:solr-delete-index':
      return dt("Used without parameters, this command deletes the entire Solr index.\n        Used with parameters for content type, it deletes just the content types that are specified.\n        After the index has been deleted, all content will be indexed again on future cron runs.");
    case 'drush:solr-mark-all':
      return dt("Used without parameters, this command marks all of the content in the Solr index for\n        reindexing. Used with parameters for content type, it marks just the content types that are specified.\n        Reindexing is different than deleting as the content is still searchable while it is in queue to be reindexed.\n        Reindexing is done on future cron runs.");
    case 'drush:solr-index':
      return dt("Reindexes content marked for (re)indexing. If you want to reindex all content or content\n         of a specific type, use solr-reindex first to mark that content.");
    case 'drush:solr-search':
      return dt('Executes a search against the site\'s Apache Solr search index and returns the results.');
    case 'error:APACHESOLR_ENV_ID_ERROR':
      return dt('Not a valid environment ID.');
  }
  return '';
}