Lit/écrit la valeur courante d'une option

# ldap_get_option

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

ldap_get_option — Lit/écrit la valeur courante d'une option

### Description

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

Définit la valeur `value` à l'option spécifiée.

### Liste de paramètres

`ldap`

  Soit une instance LDAP\Connection, retournée par ldap_connect(), pour obtenir l'option de cette connexion, ou `null` pour obtenir l'option globale.

`option`

  Le paramètre `option` peut prendre l'une des valeurs suivantes :

  Option | Type | Disponible depuis
  --- | --- | ---
  `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`

  Valeur à définir pour l'option.

### Valeurs de retour

Cette fonction retourne `true` en cas de succès ou `false` si une erreur survient.

### Historique

Version | Description
--- | ---
8.5.0 | `ldap` est désormais nullable.
8.1.0 | Le paramètre `ldap` attend désormais une instance de LDAP\Connection ; auparavant, une resource `ldap link` était attendue.

### Exemples

Exemple #1 Vérification de la version du protocole

    <?php
    // $ds doit être une instance de connexion LDAP\Connection valide
    if (ldap_get_option($ds, LDAP_OPT_PROTOCOL_VERSION, $version)) {
        echo "Nous utilisons le protocole version $version\n";
    } else {
        echo "Impossible de déterminer la version du protocole.\n";
    }
    ?>

### Notes

> Note:

> Cette fonction n'est disponible qu'avec OpenLDAP 2.x.x OU Netscape Directory SDK x.x, et a été ajoutée en PHP 4.0.4.

### Voir aussi

- ldap_set_option() - Modifie la valeur d'une option LDAP

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