ldap_rename
(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)
ldap_rename — Modify the name of an entry
說明
ldap_rename(
LDAP\Connection
string
string
string
bool
?array
): bool
LDAP\Connection
$ldap,string
$dn,string
$new_rdn,string
$new_parent,bool
$delete_old_rdn,?array
$controls = null): bool
The entry specified by dn is renamed/moved.
參數
-
ldap 通過 ldap_connect() 返回的 LDAP\Connection 實例。
-
dn The distinguished name of an LDAP entity.
-
new_rdn The new RDN.
-
new_parent The new parent/superior entry.
-
delete_old_rdn If
truethe old RDN value(s) is removed, else the old RDN value(s) is retained as non-distinguished values of the entry.-
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 |
註釋
注意:
This function currently only works with LDAPv3. You may have to use ldap_set_option() prior to binding to use LDAPv3. This function is only available when using OpenLDAP 2.x.x OR Netscape Directory SDK x.x.
參見
- ldap_rename_ext() - Modify the name of an entry
- ldap_modify() - 別名 ldap_mod_replace