ldap_authentication.api.php in Lightweight Directory Access Protocol (LDAP) 7.2

Summary of hooks and other developer related functions.

File

ldap_authentication/ldap_authentication.api.php

<?php

/**
 * @file
 * Summary of hooks and other developer related functions.
 */

/**
 * Allow a custom module to check user's ldap details and refuse authentication.
 *
 * See also: http://drupal.org/node/1634930.
 *
 * @param array $ldap_user
 *   See README.developers.txt for structure.
 * @param string $name
 *   The drupal account name or proposed drupal account name if none exists yet.
 * @param bool $hook_result
 *   TRUE for allow, FALSE for deny.
 *   If set to TRUE or FALSE, another module has already set this and function
 *   should be careful about overriding this.
 */
function hook_ldap_authentication_allowuser_results_alter(array $ldap_user, $name, &$hook_result) {

  // Other module has denied user, should not override.
  if ($hook_result === FALSE) {
    return;
  }
  elseif ($hook_result === TRUE) {
    if (mymodule_dissapproves($ldap_user, $name)) {
      $hook_result = FALSE;
    }
  }
}

/**
 * Allow a custom module to alter $ldap_user.
 *
 * @param array $ldap_user
 *   See README.developers.txt for structure.
 * @param array $params
 *   Array of parameters. Includes account key with the Drupal account as value.
 */
function hook_ldap_entry_alter(array &$ldap_user, array $params) {
  $ldap_user['mail'] = '[e-mail]';
}

Functions

Name	Description
hook_ldap_authentication_allowuser_results_alter	Allow a custom module to check user's ldap details and refuse authentication.
hook_ldap_entry_alter	Allow a custom module to alter $ldap_user.