function ldap_servers_help in Lightweight Directory Access Protocol (LDAP) 8.3

Same name and namespace in other branches

1. 8.4 ldap_servers/ldap_servers.module \ldap_servers_help()
2. 8.2 ldap_servers/ldap_servers.module \ldap_servers_help()
3. 7.2 ldap_servers/ldap_servers.module \ldap_servers_help()
4. 7 ldap_servers/ldap_servers.module \ldap_servers_help()

Implements hook_help().

File

ldap_servers/ldap_servers.module, line 13

The ldap_servers module file.

Code

function ldap_servers_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.ldap_servers':
      $output = '<p>' . t('<em>LDAP Servers</em> stores LDAP server configurations so other modules can connect to them and leverage their data <em>LDAP Authentication</em> and <em>LDAP Authorization</em> are two such modules. Generally, only one LDAP Server configuration is needed.') . '</p>';
      $output .= '<p>' . t('When multiple LDAP server configurations are needed, each is not necessarily a separate physical LDAP server; they may have different binding users or some other configuration difference.') . ' </p>';
      return $output;
    case 'entity.ldap_server.collection':
      $output = '<p>' . t('More than one LDAP server configuration can exist for a physical LDAP server. Multiple configurations for the same physical LDAP server are useful in cases such as either different base DN for authentication and authorization or service accounts with different privileges for different purposes.') . '</p>';
      return $output;
  }
}