function samlauth_help in SAML Authentication 4.x

Same name and namespace in other branches

1. 8.3 samlauth.module \samlauth_help()
2. 8 samlauth.module \samlauth_help()
3. 8.2 samlauth.module \samlauth_help()

Implements hook_help().

File

./samlauth.module, line 18

Allows users to authenticate against an external SAML identity provider.

Code

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

    // Main module help for the samlauth module.
    case 'help.page.samlauth':
      $module_path = \Drupal::moduleHandler()
        ->getModule('samlauth')
        ->getPath();
      $output = '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('Allows users to authenticate against an external SAML identity provider.') . '</p>';
      $output .= '<p>' . t('Most information on how to configure this module is in the <a href=":url">README.md file</a>.', [
        ':url' => Url::fromUri("base:{$module_path}/README.md")
          ->toString(),
      ]) . '</p>';
      return $output;
  }
}