function search_api_federated_solr_help in Search API Federated Solr 8.2

Same name and namespace in other branches

1. 8.3 search_api_federated_solr.module \search_api_federated_solr_help()
2. 8 search_api_federated_solr.module \search_api_federated_solr_help()
3. 7.3 search_api_federated_solr.module \search_api_federated_solr_help()
4. 7 search_api_federated_solr.module \search_api_federated_solr_help()
5. 7.2 search_api_federated_solr.module \search_api_federated_solr_help()
6. 4.x search_api_federated_solr.module \search_api_federated_solr_help()

Implements hook_help().

File

./search_api_federated_solr.module, line 15

Contains hook implementations for the Federated Solr Search API Module.

Code

function search_api_federated_solr_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {

    // Main module help for the search_api_federated_solr module.
    case 'help.page.search_api_federated_solr':
      $text = '<p>' . t('This help text uses Markdown. Install the <a href="@markdown">Markdown module</a> or <a href="@readme">view it online</a> for easier reading', [
        '@markdown' => 'https://www.drupal.org/project/markdown',
        '@readme' => 'https://git.drupalcode.org/project/search_api_federated_solr',
      ]) . '</p>';
      $text .= file_get_contents(dirname(__FILE__) . '/README.md');
      if (!\Drupal::moduleHandler()
        ->moduleExists('markdown')) {
        return search_api_federated_solr_parse_help($text);
      }
      else {

        // Use the Markdown filter to render the README.
        $filter_manager = \Drupal::service('plugin.manager.filter');
        $settings = \Drupal::configFactory()
          ->get('markdown.settings')
          ->getRawData();
        $config = [
          'settings' => $settings,
        ];
        $filter = $filter_manager
          ->createInstance('markdown', $config);
        return $filter
          ->process($text, 'en');
      }
  }
  return NULL;
}