You are here

function health_check_url_help in Health Check Url 8

Same name and namespace in other branches
  1. 8.3 health_check_url.module \health_check_url_help()
  2. 8.2 health_check_url.module \health_check_url_help()

Implements hook_help().

File

./health_check_url.module, line 14
Contains \Drupal\Routing\Form\RouteMatchInterface.

Code

function health_check_url_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.health_check_url':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Health Check url module is to provide health endpoint for load balancers from all type of cloud providers. the health endpoint will say to load balancers that everything is fine in the site') . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Configuring Health Check url') . '</dt>';
      $output .= '<dd>' . t('The Health Check url module provides page for configuring the string , endpoint, format  <a href=":config">Health Check URL settings</a>. Configure an endpoint & test  it by navigating to that path', [
        ':config' => Url::fromRoute('health_check_url.admin')
          ->toString(),
      ]) . '</dd>';
      $output .= '</dl>';
      return $output;
    case 'health_check_url.admin':
      return '<p>' . t('This page shows you all available administration tasks for Health Check URL module.') . '</p>';
  }
}