ldap_rename

(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)

ldap_renameエントリ名を修正する

説明

ldap_rename(
    LDAP\Connection $ldap,
    string $dn,
    string $new_rdn,
    string $new_parent,
    bool $delete_old_rdn,
    ?array $controls = null
): bool

dn で指定したエントリについて、 名前の変更または移動を行います。

パラメータ

ldap

ldap_connect() が返す LDAP\Connection クラスのインスタンス。

dn

LDAP エンティティの識別名。

new_rdn

新しい RDN。

new_parent

新しい親エントリ。

delete_old_rdn

true の場合は古い RDN 値を削除します。それ以外の場合は古い RDN 値がそのエントリの non-distinguished 値として残されます。

controls

リクエストと一緒に送信する LDAP コントロール の配列

戻り値

成功した場合に true を、失敗した場合に false を返します。

変更履歴

バージョン 説明
8.1.0 引数 ldap は、LDAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、リソース を期待していました。
8.0.0 controls は、nullable になりました。 これより前のバージョンでは、デフォルト値が [] でした。
7.3 controls のサポートが追加されました。

注意

注意:

この関数は、現在、LDAPv3 でのみ動作します。LDAPv3 でバインドする前に ldap_set_option() を使用する必要があるかもしれません。 この関数は、OpenLDAP 2.x.x または Netscape Directory SDK x.x を使用している場合にのみ使用可能です。

参考

関連キーワード:  エントリ, 修正, rename, new, rdn, controls, 関数, バージョン, Connection, RDN