ldap_search
LDAP options description
http://publib.boulder.ibm.com/infocenter/iseries/v5r3/index.jsp?topic=%2Fapis%2Fldap_set_option.htm
ldap_set_option
(PHP 4 >= 4.0.4, PHP 5)
ldap_set_option — Set the value of the given option
Description
Sets the value of the specified option to be newval.
Parameters
-
link_identifier -
An LDAP link identifier, returned by ldap_connect().
-
option -
The parameter
optioncan be one of:Option Type Available since LDAP_OPT_DEREFinteger LDAP_OPT_SIZELIMITinteger LDAP_OPT_TIMELIMITinteger LDAP_OPT_NETWORK_TIMEOUTinteger PHP 5.3.0 LDAP_OPT_PROTOCOL_VERSIONinteger LDAP_OPT_ERROR_NUMBERinteger LDAP_OPT_REFERRALSbool LDAP_OPT_RESTARTbool LDAP_OPT_HOST_NAMEstring LDAP_OPT_ERROR_STRINGstring LDAP_OPT_MATCHED_DNstring LDAP_OPT_SERVER_CONTROLSarray LDAP_OPT_CLIENT_CONTROLSarray LDAP_OPT_SERVER_CONTROLSandLDAP_OPT_CLIENT_CONTROLSrequire a list of controls, this means that the value must be an array of controls. A control consists of an oid identifying the control, an optional value, and an optional flag for criticality. In PHP a control is given by an array containing an element with the key oid and string value, and two optional elements. The optional elements are key value with string value and key iscritical with boolean value. iscritical defaults toFALSEif not supplied. See » draft-ietf-ldapext-ldap-c-api-xx.txt for details. See also the second example below. -
newval -
The new value for the specified
option.
Return Values
Returns TRUE on success or FALSE on failure.
Examples
Example #1 Set protocol version
<?php
// $ds is a valid link identifier for a directory server
if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) {
echo "Using LDAPv3";
} else {
echo "Failed to set protocol version to 3";
}
?>
Example #2 Set server controls
<?php
// $ds is a valid link identifier for a directory server
// control with no value
$ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true);
// iscritical defaults to FALSE
$ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic");
// try to set both controls
if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) {
echo "Failed to set server controls";
}
?>
Notes
Note:
This function is only available when using OpenLDAP 2.x.x OR Netscape Directory SDK x.x.
add a note
User Contributed Notes
ldap_set_option - [6 notes]
Anonymous ¶
2 years ago
technosophos ¶
6 years ago
The following flags are valid integer values for the LDAP_OPT_DEREF (as taken from the documentation for ldap_read()):
LDAP_DEREF_NEVER (int 0) - (default) aliases are never dereferenced.
LDAP_DEREF_SEARCHING (int 1) - aliases should be dereferenced during the search but not when locating the base object of the search.
LDAP_DEREF_FINDING (int 2) - aliases should be dereferenced when locating the base object but not during the search.
LDAP_DEREF_ALWAYS (int 3) - aliases should be dereferenced always.
Example:
<?php
ldap_set_option($ds, LDAP_OPT_DEREF, LDAP_DEREF_ALWAYS);
?>
These are defined in the draft C API (presumably from the original LDAP API). See draft-ietf-ldapext-ldap-c-api-xx.txt included in the OpenLDAP source code distribution.
hansfn at gmail dot com ¶
6 years ago
Luckily you can turn on debugging before you open a connection:
ldap_set_option(NULL, LDAP_OPT_DEBUG_LEVEL, 7);
This way you at least can see in the logs if the connection fails...
minusf at gmail dot com ¶
7 years ago
it seems that ldap_set_option returns 1 for bogus ldap_connect -ions also.
ldap_connect always returns a resource (documented in the
comments of ldap_connect) so it is not possible to check if the
ldap server is there or alive or what. and because ldap_set_option
must be between ldap_connect and ldap_bind, there seems to
be no sense in checking the return value.
it is a bit strange that ldap_bind is the first function which can
really check if a ldap resource is usable because it is the third
function in line to use when working with openldap.
<?php
$connect = ldap_connect("whatever");
$set = ldap_set_option($connect, LDAP_OPT_PROTOCOL_VERSION, 3);
echo $set;
?>
soulbros at yahoo dot com ¶
11 years ago
As john.hallam@compaq.com above mentioned ,one has to set option LDAP_OPT_PROTOCOL_VERSION=3
ldap_set_option($ds,LDAP_OPT_PROTOCOL_VERSION,3);
to use the ldap_rename function.
However, the ldap_set_option() line has to be written immediately after ldap_connect() and before ldap_bind() statements.
Christos Soulios
john dot hallam at compaq dot com ¶
11 years ago
To get this to work I had to set the LDAP version to 3 using ldap_set_option. Here is an example that might help:
$TheDN = "cn=john smith,ou=users,dc=acme,dc=com";
$newRDN = "cn=bill brown";
$newParent = "ou=users,dc=acme,dc=com";
ldap_set_option($ds,LDAP_OPT_PROTOCOL_VERSION,3);
@$result = ldap_rename($ds, $TheDN, $newRDN, $newParent, TRUE);