ldap_modify_batch
LDAP\Connection$ldap,
string$dn,
array$modifications_info,
[array|null$controls = null]
): bool
Modifies an existing entry in the LDAP directory. Allows detailed specification of the modifications to perform.
Parameters
- ldap
-
An LDAP resource, returned by ldap_connect.
- dn
-
The distinguished name of an LDAP entity.
- modifications_info
-
An array that specifies the modifications to make. Each entry in this array is an associative array with two or three keys: attrib maps to the name of the attribute to modify, modtype maps to the type of modification to perform, and (depending on the type of modification) values maps to an array of attribute values relevant to the modification.
Possible values for modtype include:
- LDAP_MODIFY_BATCH_ADD
-
Each value specified through values is added (as an additional value) to the attribute named by attrib.
- LDAP_MODIFY_BATCH_REMOVE
-
Each value specified through values is removed from the attribute named by attrib. Any value of the attribute not contained in the values array will remain untouched.
- LDAP_MODIFY_BATCH_REMOVE_ALL
-
All values are removed from the attribute named by attrib. A values entry must not be provided.
- LDAP_MODIFY_BATCH_REPLACE
-
All current values of the attribute named by attrib are replaced with the values specified through values.
Note that any value for attrib must be a string, any value for values must be an array of strings, and any value for modtype must be one of the LDAP_MODIFY_BATCH_* constants listed above.
- controls
-
Array of LDAP Controls to send with the request.
Return Values
Returns true on success or false on failure.
Changelog
| Version | Description |
| 8.1.0 | The ldap parameter expects an LDAP\Connection instance now; previously, a resource was expected. |
| 8.0.0 | controls is nullable now; previously, it defaulted to []. |
| 7.3 | Support for controls added |