ldap_set_option

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

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

    Описание

    ldap_set_option(?LDAP\Connection$ldap, int$option, array|string|int|bool$value): bool

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

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

    ldap

    Либо экземпляр LDAP\Connection, возвращаемый функцией ldap_connect() для установки опции для этого соединения, либо null для установки опции глобально.

    option

    Опция option может быть одной из:

    ОпцияТипДоступна с
    LDAP_OPT_DEREFint 
    LDAP_OPT_SIZELIMITint 
    LDAP_OPT_TIMELIMITint 
    LDAP_OPT_NETWORK_TIMEOUTint 
    LDAP_OPT_PROTOCOL_VERSIONint 
    LDAP_OPT_ERROR_NUMBERint 
    LDAP_OPT_REFERRALSbool 
    LDAP_OPT_RESTARTbool 
    LDAP_OPT_HOST_NAMEstring 
    LDAP_OPT_ERROR_STRINGstring 
    LDAP_OPT_DIAGNOSTIC_MESSAGEstring 
    LDAP_OPT_MATCHED_DNstring 
    LDAP_OPT_SERVER_CONTROLSarray 
    LDAP_OPT_CLIENT_CONTROLSarray 
    LDAP_OPT_X_KEEPALIVE_IDLEintPHP 7.1.0
    LDAP_OPT_X_KEEPALIVE_PROBESintPHP 7.1.0
    LDAP_OPT_X_KEEPALIVE_INTERVALintPHP 7.1.0
    LDAP_OPT_X_TLS_CACERTDIRstringPHP 7.1.0
    LDAP_OPT_X_TLS_CACERTFILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_CERTFILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_CIPHER_SUITEstringPHP 7.1.0
    LDAP_OPT_X_TLS_CRLCHECKintPHP 7.1.0
    LDAP_OPT_X_TLS_CRLFILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_DHFILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_KEYFILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_PROTOCOL_MINintPHP 7.1.0
    LDAP_OPT_X_TLS_RANDOM_FILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_REQUIRE_CERTintPHP 7.0.5

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

    value

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

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

    Возвращает true в случае успешного выполнения или false, если возникла ошибка.

    Список изменений

    ВерсияОписание
    8.1.0 Параметр ldap теперь ожидает экземпляр класса LDAP\Connection; раньше параметр ждал ресурс (resource) ldap link .

    Примеры

    Пример #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() - Получить текущее значение данной опции
    To Top