(PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)
ldap_set_option — 指定したオプションの値を設定する
指定したオプションの値を value に設定します。
ldap 特定の接続に対してオプションを設定する場合は、 ldap_connect() が返す、 LDAP\Connection クラスのインスタンス。 オプションをグローバルに設定する場合は、 null を設定します。
option パラメータ option は以下のいずれかとなります。
LDAP_OPT_SERVER_CONTROLS および LDAP_OPT_CLIENT_CONTROLS はコントロールのリストが必要です。 つまり、値がコントロールの配列である必要があるということです。 コントロールは、そのコントロールの ID である oid、オプションの value、オプションのフラグ criticality からなります。PHP において、 コントロールはキーが oid で値が文字列、 二つのオプションの要素からなる配列で指定されます。オプションの要素は、 キーが value で値が文字列、そしてキーが iscritical で値が論理値となります。 iscritical を省略した場合のデフォルトは false です。詳細は » draft-ietf-ldapext-ldap-c-api-xx.txt を参照ください。また以下の二番目の例も参照ください。
value 指定したオプション option の新しい値。
| バージョン | 説明 |
|---|---|
| 8.1.0 | 引数 ldap は、LDAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、有効な ldap linkリソース を期待していました。 |
例1 プロトコルバージョンの設定
<?php
// $ds はディレクトリサーバーへの LDAP\Connection のインスタンス
if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) {
echo "LDAPv3 を使用します";
} else {
echo "プロトコルバージョンを 3 に設定できませんでした";
}
?>例2 サーバーコントロールの設定
<?php
// $ds は値を持たないディレクトリサーバーコントロールへの LDAP\Connection のインスタンスです。
$ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true);
// iscritical のデフォルトは、FALSE です。
$ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic");
// 両方のコントロールを試します
if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) {
echo "サーバーコントロールの設定に失敗しました。";
}
?>注意:
この関数は、OpenLDAP 2.x.x または Netscape Directory SDK x.x を使用している場合のみ利用可能です。