Установить значение данной опции

Описание

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

Устанавливает значение указанной опции в newval.

Список параметров

link_identifier

Идентификатор ссылки LDAP, возвращенный ldap_connect().

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 требуют список элементов управления. Это означает, что значение должно быть массивом элементов управления. Элемент управления состоит из oid, определяющего элемент управления, опционального значения, и дополнительного флага для критичности. В PHP элемент управления задается массивом, содержащим элемент с ключом oid и строковым значением, и двумя необязательными элементами. Необязательные элементы являются ключом value со строковым значением и ключом iscritical с логическим значением. iscritical по умолчанию установается в FALSE, если не указан. Для более подробной информации смотрите » draft-ietf-ldapext-ldap-c-api-xx.txt. Смотрите также второй пример, расположенный ниже.

newval

Новое значение для указанной option (опции).

Возвращаемые значения

Возвращает TRUE в случае успешного завершения или FALSE в случае возникновения ошибки.

Примеры

Пример #1 Устанавливает версию протокола


<?php
// $ds является действительным идентификатором связи с LDAP-сервером
if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) {
    echo "Используется LDAPv3";
} else {
    echo "Не удалось установить версию протокола в 3";
}
?>

Пример #2 Устанавливает управление сервером


<?php
// $ds является действительным идентификатором связи с LDAP-сервером
// элемент управления с отсутствующим значением
$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() - Получить текущее значение данной опции