LDAP Class

Properties   Methods   Events   Configuration Settings   Errors  

The LDAP Component is used to search, manage, and maintain Internet Directory (LDAP) servers.

Class Name

IPWorks_LDAP

Procedural Interface

 ipworks_ldap_open();
 ipworks_ldap_close($res);
 ipworks_ldap_register_callback($res, $id, $function);
 ipworks_ldap_get_last_error($res);
 ipworks_ldap_get_last_error_code($res);
 ipworks_ldap_set($res, $id, $index, $value);
 ipworks_ldap_get($res, $id, $index);
 ipworks_ldap_do_abandon($res, $messageid);
 ipworks_ldap_do_add($res);
 ipworks_ldap_do_attr($res, $attrtype);
 ipworks_ldap_do_bind($res);
 ipworks_ldap_do_compare($res);
 ipworks_ldap_do_config($res, $configurationstring);
 ipworks_ldap_do_delete($res);
 ipworks_ldap_do_doevents($res);
 ipworks_ldap_do_extendedrequest($res, $requestname, $requestvalue);
 ipworks_ldap_do_interrupt($res);
 ipworks_ldap_do_modify($res);
 ipworks_ldap_do_modifyrdn($res, $newrdn);
 ipworks_ldap_do_movetodn($res, $newsuperior);
 ipworks_ldap_do_search($res, $searchfilter);
 ipworks_ldap_do_unbind($res);

Remarks

The LDAP Class implements a standard LDAP client as specified in RFC 1777, 2251, and other LDAP RFCs. Support for both LDAP v2 and v3 is provided.

The first step in using the class is specifying the ServerName, a DN (Distinguished Name) to bind as, and optionally a Password. Then you can call one or more of the class methods to act upon the server. Server responses are normally received through the Result event. The only exceptions are search requests which result in one or more SearchResult events, followed by a final SearchComplete event.

Attributes are set and returned through the Attributes properties. Other command arguments are specified through other properties. These are specified in detail in each method.

Search filters are to be specified as string arguments to the Search method. The format must be a standard LDAP search string as specified in RFC 1558. Other search attributes are set in properties such as SearchScope, SearchTimeLimit, SearchSizeLimit, SearchReturnValues, and SearchDerefAliases.

The class operates synchronously by default (waits for a response before returning control to the caller), however, the class may also operate asynchronously (return control immediately), by setting Timeout to 0. Please refer to the Timeout property for more information.