ldap_modify_batch
(PHP 5.4 >= 5.4.26, PHP 5.5 >= 5.5.10, PHP 5.6 >= 5.6.0, PHP 7, PHP 8)
ldap_modify_batch — Batch and execute modifications on an LDAP entry
說明
LDAP\Connection
$ldap,string
$dn,array
$modifications_info,?array
$controls = null): bool
Modifies an existing entry in the LDAP directory. Allows detailed specification of the modifications to perform.
參數
-
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:
attribmaps to the name of the attribute to modify,modtypemaps to the type of modification to perform, and (depending on the type of modification)valuesmaps to an array of attribute values relevant to the modification.Possible values for
modtypeinclude:-
LDAP_MODIFY_BATCH_ADD Each value specified through
valuesis added (as an additional value) to the attribute named byattrib.-
LDAP_MODIFY_BATCH_REMOVE Each value specified through
valuesis removed from the attribute named byattrib. Any value of the attribute not contained in thevaluesarray will remain untouched.-
LDAP_MODIFY_BATCH_REMOVE_ALL All values are removed from the attribute named by
attrib. Avaluesentry must not be provided.-
LDAP_MODIFY_BATCH_REPLACE All current values of the attribute named by
attribare replaced with the values specified throughvalues.
Note that any value for
attribmust be a string, any value forvaluesmust be an array of strings, and any value formodtypemust be one of the LDAP_MODIFY_BATCH_* constants listed above.-
-
controls Array of LDAP Controls to send with the request.
返回值
成功時返回 true， 或者在失敗時返回 false。
更新日誌
| 版本 | 說明 |
|---|---|
| 8.1.0 | 現在 ldap 參數接受 LDAP\Connection 實例，之前接受 資源(resource)。 |
| 8.0.0 | controls is nullable now; previously, it defaulted to []. |
| 7.3.0 | Support for controls added |
範例
示例 #1 Add a telephone number to a contact
<?php
$dn = "cn=John Smith,ou=Wizards,dc=example,dc=com";
$modifs = [
[
"attrib" => "telephoneNumber",
"modtype" => LDAP_MODIFY_BATCH_ADD,
"values" => ["+1 555 555 1717"],
],
];
ldap_modify_batch($connection, $dn, $modifs);
?> 示例 #2 Rename a user
<?php
$dn = "cn=John Smith,ou=Wizards,dc=example,dc=com";
$modifs = [
[
"attrib" => "sn",
"modtype" => LDAP_MODIFY_BATCH_REPLACE,
"values" => ["Smith-Jones"],
],
[
"attrib" => "givenName",
"modtype" => LDAP_MODIFY_BATCH_REPLACE,
"values" => ["Jack"],
],
];
ldap_modify_batch($connection, $dn, $modifs);
ldap_rename($connection, $dn, "cn=Jack Smith-Jones", NULL, TRUE);
?> 示例 #3 Add two e-mail addresses to a user
<?php
$dn = "cn=Jack Smith-Jones,ou=Wizards,dc=example,dc=com";
$modifs = [
[
"attrib" => "mail",
"modtype" => LDAP_MODIFY_BATCH_ADD,
"values" => [
"jack.smith@example.com",
"jack.smith-jones@example.com",
],
],
];
ldap_modify_batch($connection, $dn, $modifs);
?> 示例 #4 Change a user's password
<?php
$dn = "cn=Jack Smith-Jones,ou=Wizards,dc=example,dc=com";
$modifs = [
[
"attrib" => "userPassword",
"modtype" => LDAP_MODIFY_BATCH_REMOVE,
"values" => ["Tr0ub4dor&3"],
],
[
"attrib" => "userPassword",
"modtype" => LDAP_MODIFY_BATCH_ADD,
"values" => ["correct horse battery staple"],
],
];
ldap_modify_batch($connection, $dn, $modifs);
?> 示例 #5 Change a user's password (Active Directory)
<?php
function adifyPw($pw)
{
return iconv("UTF-8", "UTF-16LE", '"' . $pw . '"');
}
$dn = "cn=Jack Smith-Jones,ou=Wizards,dc=ad,dc=example,dc=com";
$modifs = [
[
"attrib" => "unicodePwd",
"modtype" => LDAP_MODIFY_BATCH_REMOVE,
"values" => [adifyPw("Tr0ub4dor&3")],
],
[
"attrib" => "unicodePwd",
"modtype" => LDAP_MODIFY_BATCH_ADD,
"values" => [adifyPw("correct horse battery staple")],
],
];
ldap_modify_batch($connection, $dn, $modifs);