function ldap_profile_help in Lightweight Directory Access Protocol (LDAP) 7

Implements hook_help().

File

ldap_profile/ldap_profile.module, line 34

This module provides the LDAP package the ability populate drupal profile fields with ldap entry data such as last name, first name, etc.

Code

function ldap_profile_help($path, $arg) {
  $url = url('admin/config/people/accounts/fields', array(
    'absolute' => TRUE,
  ));
  $link = '<a id="profileFieldEdit" href="' . $url . '" rel="' . $url . '">' . t('edit profile fields') . '</a>';
  $profile_help = t('LDAP Profile Mapping is used to automatically populate user profile fields ( !link ) such as last name based on their LDAP Entry.', array(
    '!link' => $link,
  )) . t('This is done each time the user logons to Drupal.') . '<br/><br/>' . t('To add attributes that are contained in an LDAP entry to a profile field, you can use tokens ' . 'such as "[sn].[givenname]@myorg.com" or use the LDAP attribute name, such as "givenname" (all without ' . 'quotes).') . '<br/><br/>' . t('The <em>LDAP field to derive from</em> allows you to perform a search ' . 'from a given LDAP attribute that contains a DN, and then get ' . 'attribute data based off that search, rather than the current ' . 'user\'s attributes (i.e. - If you wanted to get a user\'s ' . 'manager information, you can set the <em>LDAP Field to Derive ' . 'from</em> textbox to "manager" and put a check-mark next ' . 'to <em>Derive from DN Search</em>, and then put in the ' . 'subsequent field to gather from there.).');
  switch ($path) {
    case 'admin/config/people/ldap/profile':
      $output = '<p>' . $profile_help . '</p>';
      return $output;
  }
}