Получить текущее значение данной опции

# ldap_get_option

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

ldap_get_option — Получить текущее значение данной опции

### Описание

function ldap_get_option(?LDAP\Connection `$ldap`, int `$option`, array|string|int `&$value` = `null`): bool

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

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

`ldap`

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

`option`

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

  Опция | Тип | Начиная с версии
  --- | --- | ---
  `LDAP_OPT_DEREF` | int |
  `LDAP_OPT_SIZELIMIT` | int |
  `LDAP_OPT_TIMELIMIT` | int |
  `LDAP_OPT_NETWORK_TIMEOUT` | int |
  `LDAP_OPT_PROTOCOL_VERSION` | int |
  `LDAP_OPT_ERROR_NUMBER` | int |
  `LDAP_OPT_DIAGNOSTIC_MESSAGE` | string |
  `LDAP_OPT_REFERRALS` | int |
  `LDAP_OPT_RESTART` | int |
  `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_X_KEEPALIVE_IDLE` | int | 7.1
  `LDAP_OPT_X_KEEPALIVE_PROBES` | int | 7.1
  `LDAP_OPT_X_KEEPALIVE_INTERVAL` | int | 7.1
  `LDAP_OPT_X_TLS_CACERTDIR` | string | 7.1
  `LDAP_OPT_X_TLS_CACERTFILE` | string | 7.1
  `LDAP_OPT_X_TLS_CERTFILE` | string | 7.1
  `LDAP_OPT_X_TLS_CIPHER_SUITE` | string | 7.1
  `LDAP_OPT_X_TLS_CRLCHECK` | int | 7.1
  `LDAP_OPT_X_TLS_CRL_NONE` | int | 7.1
  `LDAP_OPT_X_TLS_CRL_PEER` | int | 7.1
  `LDAP_OPT_X_TLS_CRL_ALL` | int | 7.1
  `LDAP_OPT_X_TLS_CRLFILE` | string | 7.1
  `LDAP_OPT_X_TLS_DHFILE` | string | 7.1
  `LDAP_OPT_X_TLS_KEYFILE` | string | 7.1
  `LDAP_OPT_X_TLS_PACKAGE` | string | 7.1
  `LDAP_OPT_X_TLS_PROTOCOL_MIN` | int | 7.1
  `LDAP_OPT_X_TLS_PROTOCOL_MAX` | int | 8.4
  `LDAP_OPT_X_TLS_RANDOM_FILE` | string | 7.1
  `LDAP_OPT_X_TLS_REQUIRE_CERT` | int |

`value`

  Будет установлен в значение опции.

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

Функция возвращает `true`, если выполнилась успешно, или `false`, если возникла ошибка.

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

Версия | Описание
--- | ---
8.5.0 | Параметр `ldap` теперь допускает значение `null`.
8.1.0 | Параметр `ldap` теперь принимает объект LDAP\Connection; раньше параметр ждал ресурс (resource) `ldap link` .

### Примеры

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

    <?php
    // $ds допустимый экземпляр LDAP\Connection
    if (ldap_get_option($ds, LDAP_OPT_PROTOCOL_VERSION, $version)) {
        echo "Используется версия протокола $version\n";
    } else {
        echo "Невозможно определить версию протокола\n";
    }
    ?>

### Примечания

> Замечание:

> Эта функция доступна только когда используется OpenLDAP 2.x.x или Netscape Directory SDK x.x.

### Смотрите также

- ldap_set_option() - Устанавливает значение опции

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open