ldap_user.api.php in Lightweight Directory Access Protocol (LDAP) 8.3

Hooks and functions relevant to developers.

File

ldap_user/ldap_user.api.php

<?php

/**
 * @file
 * Hooks and functions relevant to developers.
 */

/**
 * Hook_ldap_user_attrs_alter().
 *
 * Alter list of available Drupal user targets (fields, properties, etc.)
 *   for ldap_user provisioning mapping form (admin/config/people/ldap/user)
 *
 * @param array $available_user_attrs
 *   User attributes in the form of:
 *   [<field_type>.<field_name>] => array(
 *     'name' => string for user friendly name for the UI,
 *     'source' => LDAP attribute (even if target of sync.  this should be
 *       refactored at some point to avoid confusion)
 *     'configurable' =>
 *     'configurable_to_drupal'  0 | 1, is this configurable?
 *     'configurable_to_ldap' =>  0 | 1, is this configurable?
 *     'user_tokens' => <user_tokens>
 *     'convert' => 1 | 0 convert from binary to string for storage and
 *       comparison purposes
 *     'direction' => LdapUserAttributesInterface::PROVISION_TO_DRUPAL or
 *       LdapUserAttributesInterface::PROVISION_TO_LDAP
 *       leave empty if configurable
 *     'config_module' => module providing syncing configuration.
 *     'prov_module' => module providing actual syncing of attributes.
 *     'prov_events' => array( )
 * @param array $params
 *   Parameters.
 */
function hook_ldap_user_attrs_list_alter(array &$available_user_attrs, array &$params) {

  // Search for _ldap_user_attrs_list_alter for good examples the general trick
  // to implementing this hook is make sure to specify config and sync module if
  // its configurable by ldap_user module, don't specify convert user_tokens,
  // direction.  these will be set by UI and stored values be sure to merge with
  // existing values as ldap_user configured values will already exist in
  // $available_user_attrs.
}

/**
 * Alter the user object in the context of an LDAP entry during synchronization.
 *
 * @param User $account
 *   The edit array (see hook_user_insert). Make changes to this object as
 *   required.
 * @param array $ldap_user
 *   The LDAP user object relating to the Drupal user.
 *   For structure @see LdapServer::matchUsernameToExistingLdapEntry()
 * @param array $context
 *   Contains ldap_server and provisioning events.
 */
function hook_ldap_user_edit_user_alter(User &$account, array &$ldap_user, array $context) {
  $tokenProcessor = \Drupal::service('ldap.token_processor');
  $value = $tokenProcessor
    ->tokenReplace($ldap_user['attr'], '[sn]', 'ldap_entry');
  $account
    ->set('myfield', $value);
}

Functions

Name	Description
hook_ldap_user_attrs_list_alter	Hook_ldap_user_attrs_alter().
hook_ldap_user_edit_user_alter	Alter the user object in the context of an LDAP entry during synchronization.