function hook_ldap_user_attrs_list_alter in Lightweight Directory Access Protocol (LDAP) 8.2

Same name and namespace in other branches

1. 8.3 ldap_user/ldap_user.api.php \hook_ldap_user_attrs_list_alter()
2. 7.2 ldap_user/ldap_user.api.php \hook_ldap_user_attrs_list_alter()

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)

return array with elements of the form: [<field_type>.<field_name>] => array( 'name' => string for user friendly name for the UI, 'source' => ldap attribute (even if target of synch. 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' => LDAP_USER_PROV_DIRECTION_TO_DRUPAL_USER or LDAP_USER_PROV_DIRECTION_TO_LDAP_ENTRY leave empty if configurable 'config_module' => module providing synching configuration. 'prov_module' => module providing actual synching of attributes. 'prov_events' => array( of LDAP_USER_EVENT_* constants indicating during which synch actions field should be synched)

• four permutations available to ldap: LDAP_USER_EVENT_CREATE_LDAP_ENTRY, LDAP_USER_EVENT_SYNCH_TO_LDAP_ENTRY, to drupal: LDAP_USER_EVENT_CREATE_DRUPAL_USER, LDAP_USER_EVENT_SYNCH_TO_DRUPAL_USER

)

where 'field_type' is one of the following: 'property' (user property such as mail, picture, timezone that is not a field) 'field' (any field attached to the user such as field_user_lname) 'profile2' (profile2 fields) 'data' ($user->data array. field_name will be used as key such as $user->data[<field_name>] = mapped value 'field_name' machine name of property, field, profile2 field, or data associative array key

4 functions implement hook_ldap_user_attrs_list_alter()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

ldap_authorization_drupal_role_ldap_user_attrs_list_alter in ldap_authorization/ldap_authorization_drupal_role/ldap_authorization_drupal_role.module

Implements hook_ldap_user_attrs_list_alter().

ldap_authorization_ldap_user_attrs_list_alter in ldap_authorization/ldap_authorization.module

Implements hook_ldap_user_attrs_list_alter().

ldap_servers_ldap_user_attrs_list_alter in ldap_servers/ldap_servers.module

Implements hook_ldap_user_attrs_list_alter().

ldap_user_ldap_user_attrs_list_alter in ldap_user/ldap_user.module

Implements hook_ldap_user_attrs_list_alter().

1 invocation of hook_ldap_user_attrs_list_alter()

LdapUserConf::setSynchMapping in ldap_user/LdapUserConf.class.php

derive mapping array from ldap user configuration and other configurations. if this becomes a resource hungry function should be moved to ldap_user functions and stored with static variable. should be cached also.

File

ldap_user/ldap_user.api.php, line 42

Hooks and functions relevant to developers

Code

function hook_ldap_user_attrs_list_alter(&$available_user_attrs, &$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 synch 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
   */
}