README.developers.txt in Lightweight Directory Access Protocol (LDAP) 8.2
General LDAP Project Notes
LDAP Servers is base module or api module. General LDAP functions belong in
LDAP Servers.
--------------------------------------------------------
Case Sensitivity and Character Escaping in LDAP Modules
--------------------------------------------------------
The function ldap_server_massage_text() should be used for dealing with case sensitivity
and character escaping consistently.
The general rule is codified in ldap_server_massage_text() which is:
- escape filter values and attribute values when querying ldap
- use unescaped, lower case attribute names when storing attribute names in arrays (as keys or values), databases, or object properties.
- use unescaped, mixed case attribute values when storing attribute values in arrays (as keys or values), databases, or object properties.
So a filter might be built as follows:
$username = ldap_server_massage_text($username, 'attr_value', LDAP_SERVER_MASSAGE_QUERY_LDAP)
$objectclass = ldap_server_massage_text($objectclass, 'attr_value', LDAP_SERVER_MASSAGE_QUERY_LDAP)
$filter = "(&(cn=$username)(objectClass=$objectclass))";
The following functions are also available:
ldap_pear_escape_dn_value()
ldap_pear_unescape_dn_value()
ldap_pear_unescape_filter_value()
ldap_pear_unescape_filter_value()
--------------------------------------------------------
common variables used in ldap_* and their structures
--------------------------------------------------------
!Structure of $ldap_user and $ldap_entry are different!
-----------
$ldap_user
-----------
@see LdapServer::userUserNameToExistingLdapEntry() return
-----------
$ldap_entry and $ldap_*_entry.
-----------
@see LdapServer::ldap_search() return array
--------------
$user_attr_key
key of form <attr_type>.<attr_name>[:<instance>] such as field.lname, property.mail, field.aliases:2
--------------
File
README.developers.txt
View source
-
- General LDAP Project Notes
-
- LDAP Servers is base module or api module. General LDAP functions belong in
- LDAP Servers.
-
- --------------------------------------------------------
- Case Sensitivity and Character Escaping in LDAP Modules
- --------------------------------------------------------
-
- The function ldap_server_massage_text() should be used for dealing with case sensitivity
- and character escaping consistently.
-
- The general rule is codified in ldap_server_massage_text() which is:
- - escape filter values and attribute values when querying ldap
- - use unescaped, lower case attribute names when storing attribute names in arrays (as keys or values), databases, or object properties.
- - use unescaped, mixed case attribute values when storing attribute values in arrays (as keys or values), databases, or object properties.
-
- So a filter might be built as follows:
-
- $username = ldap_server_massage_text($username, 'attr_value', LDAP_SERVER_MASSAGE_QUERY_LDAP)
- $objectclass = ldap_server_massage_text($objectclass, 'attr_value', LDAP_SERVER_MASSAGE_QUERY_LDAP)
- $filter = "(&(cn=$username)(objectClass=$objectclass))";
-
-
- The following functions are also available:
- ldap_pear_escape_dn_value()
- ldap_pear_unescape_dn_value()
- ldap_pear_unescape_filter_value()
- ldap_pear_unescape_filter_value()
-
-
- --------------------------------------------------------
- common variables used in ldap_* and their structures
- --------------------------------------------------------
-
- !Structure of $ldap_user and $ldap_entry are different!
-
- -----------
- $ldap_user
- -----------
- @see LdapServer::userUserNameToExistingLdapEntry() return
-
- -----------
- $ldap_entry and $ldap_*_entry.
- -----------
- @see LdapServer::ldap_search() return array
-
-
- --------------
- $user_attr_key
- key of form .[:] such as field.lname, property.mail, field.aliases:2
- --------------