ldap_mod_replace

属性を新規の値に置換する

説明

bool ldap_mod_replace(
    LDAP\Connection $ldap,
    string $dn,
    array $entry,
    arraynull $controls = null
)

指定した dn でひとつあるいは複数の属性の置換を行います。 この関数は、属性の追加や削除も行えます。

パラメータ

ldap

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

dn

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

entry

置き換える属性を一覧にした連想配列。 空の配列を送ると、属性そのものが削除されます。 一方で、属性が存在していない値を送ると追加されます。

controls

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

戻り値

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

変更履歴

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

注意

注意: この関数はバイナリデータに対応しています。

参考

  • ldap_mod_replace_ext
  • ldap_mod_del
  • ldap_mod_add
  • ldap_modify_batch