ldap_set_option

(PHP 4 >= 4.0.4, PHP 5)

ldap_set_option — 指定したオプションの値を設定する

説明

bool ldap_set_option ( resource $link_identifier , int $option , mixed $newval )

指定したオプションの値を newval に設定します。

パラメータ

link_identifier

ldap_connect() が返す LDAP リンク ID。

option

パラメータ option は以下のいずれかとなります。

オプション	型	～以降で使用可能
`LDAP_OPT_DEREF`	integer
`LDAP_OPT_SIZELIMIT`	integer
`LDAP_OPT_TIMELIMIT`	integer
`LDAP_OPT_NETWORK_TIMEOUT`	integer	PHP 5.3.0
`LDAP_OPT_PROTOCOL_VERSION`	integer
`LDAP_OPT_ERROR_NUMBER`	integer
`LDAP_OPT_REFERRALS`	bool
`LDAP_OPT_RESTART`	bool
`LDAP_OPT_HOST_NAME`	string
`LDAP_OPT_ERROR_STRING`	string
`LDAP_OPT_MATCHED_DN`	string
`LDAP_OPT_SERVER_CONTROLS`	array
`LDAP_OPT_CLIENT_CONTROLS`	array

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 を参照ください。また以下の二番目の例も参照ください。

newval

指定したオプション option の新しい値。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

例

例1 プロトコルバージョンの設定


<?php
// $ds はディレクトリサーバーへの有効なリンクIDです
if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) {
    echo "LDAPv3 を使用します";
} else {
    echo "プロトコルバージョンを 3 に設定できませんでした";
}
?>

例2 サーバーコントロールの設定


<?php
// $ds は値を持たないディレクトリサーバーコントロールへの有効なリンクID
// です。
$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 を使用している場合のみ利用可能です。

参考

ldap_get_option() - 指定したオプションの現在の値を得る

ldap_set_rebind_proc

ldap_search

[edit] Last updated: Fri, 25 May 2012

add a note User Contributed Notes ldap_set_option

Anonymous 19-Nov-2010 01:56


LDAP options description





http://publib.boulder.ibm.com/infocenter/iseries/v5r3/index.jsp?topic=%2Fapis%2Fldap_set_option.htm

technosophos 07-Mar-2007 02:00


The following flags are valid integer values for the LDAP_OPT_DEREF (as taken from the documentation for ldap_read()):



LDAP_DEREF_NEVER (int 0) - (default) aliases are never dereferenced.



LDAP_DEREF_SEARCHING (int 1) - aliases should be dereferenced during the search but not when locating the base object of the search.



LDAP_DEREF_FINDING (int 2) - aliases should be dereferenced when locating the base object but not during the search.



LDAP_DEREF_ALWAYS (int 3) - aliases should be dereferenced always.



Example:

<?php

ldap_set_option($ds, LDAP_OPT_DEREF, LDAP_DEREF_ALWAYS);

?> 



These are defined in the draft C API (presumably from the original LDAP API). See draft-ietf-ldapext-ldap-c-api-xx.txt included in the OpenLDAP source code distribution.

hansfn at gmail dot com 23-May-2006 04:23


Luckily you can turn on debugging before you open a connection:



  ldap_set_option(NULL, LDAP_OPT_DEBUG_LEVEL, 7);



This way you at least can see in the logs if the connection fails...

minusf at gmail dot com 31-Oct-2005 01:59


it seems that ldap_set_option returns 1 for bogus ldap_connect -ions also.

ldap_connect always returns a resource (documented in the

comments of ldap_connect) so it is not possible to check if the

ldap server is there or alive or what.  and because ldap_set_option

must be between ldap_connect and ldap_bind, there seems to

be no sense in checking the return value.



it is a bit strange that ldap_bind is the first function which can

really check if a ldap resource is usable because it is the third

function in line to use when working with openldap.



<?php

$connect = ldap_connect("whatever");

$set = ldap_set_option($connect, LDAP_OPT_PROTOCOL_VERSION, 3);

echo $set;

?>

soulbros at yahoo dot com 26-Feb-2002 03:56


As john.hallam@compaq.com above mentioned ,one  has to set option LDAP_OPT_PROTOCOL_VERSION=3

ldap_set_option($ds,LDAP_OPT_PROTOCOL_VERSION,3);

to use the ldap_rename function.



However, the ldap_set_option() line has to be written immediately after ldap_connect() and before ldap_bind() statements.



Christos Soulios

john dot hallam at compaq dot com 28-Jan-2002 10:00


To get this to work I had to set the LDAP version to 3 using ldap_set_option. Here is an example that might help:



$TheDN = "cn=john smith,ou=users,dc=acme,dc=com";

$newRDN = "cn=bill brown";

$newParent = "ou=users,dc=acme,dc=com";

ldap_set_option($ds,LDAP_OPT_PROTOCOL_VERSION,3);

@$result = ldap_rename($ds, $TheDN, $newRDN, $newParent, TRUE);

add a note