[函数]ldap_get_option()函数—用法及示例

函数名：ldap_get_option()

适用版本：PHP 4, PHP 5, PHP 7

函数描述：ldap_get_option() 函数用于获取指定 LDAP 连接选项的值。

语法：ldap_get_option(resource $ldap, int $option, mixed &$retval)

参数：

• $ldap：LDAP 连接标识符，通过 ldap_connect() 函数获取。
• $option：要获取的选项，可以是以下常量之一：
  • LDAP_OPT_DEREF：指定在搜索过程中如何处理别名。可以是以下常量之一：
    • LDAP_DEREF_NEVER：不解引用别名。
    • LDAP_DEREF_SEARCHING：解引用别名，但在搜索过程中不返回别名。
    • LDAP_DEREF_FINDING：解引用别名，同时在搜索过程中返回别名。
    • LDAP_DEREF_ALWAYS：总是解引用别名。
  • LDAP_OPT_SIZELIMIT：指定返回搜索结果的最大条目数。
  • LDAP_OPT_TIMELIMIT：指定搜索操作的最大执行时间（以秒为单位）。
  • LDAP_OPT_PROTOCOL_VERSION：指定要使用的 LDAP 协议版本。
  • LDAP_OPT_ERROR_NUMBER：获取上一个操作的错误代码。
  • LDAP_OPT_REFERRALS：指定是否自动跟随引用。
• &$retval：获取选项的返回值。

返回值：如果成功，则返回 TRUE，否则返回 FALSE。

示例：

// 连接到 LDAP 服务器
$ldap = ldap_connect("ldap.example.com");

// 设置 LDAP 连接选项
ldap_set_option($ldap, LDAP_OPT_PROTOCOL_VERSION, 3);
ldap_set_option($ldap, LDAP_OPT_REFERRALS, 0);

// 获取 LDAP 连接选项的值
$protocolVersion = 0;
$referrals = 0;
ldap_get_option($ldap, LDAP_OPT_PROTOCOL_VERSION, $protocolVersion);
ldap_get_option($ldap, LDAP_OPT_REFERRALS, $referrals);

// 输出 LDAP 连接选项的值
echo "LDAP Protocol Version: " . $protocolVersion . PHP_EOL;
echo "LDAP Referrals: " . $referrals . PHP_EOL;

// 关闭 LDAP 连接
ldap_close($ldap);

以上示例中，我们首先通过 ldap_connect() 函数建立与 LDAP 服务器的连接。然后，使用 ldap_set_option() 函数设置了两个 LDAP 连接选项：LDAP_OPT_PROTOCOL_VERSION 设置为 3，表示使用 LDAP 协议版本 3；LDAP_OPT_REFERRALS 设置为 0，表示禁用自动跟随引用。

接下来，我们使用 ldap_get_option() 函数获取了这两个选项的值，并将其分别存储在 $protocolVersion 和 $referrals 变量中。最后，我们通过 echo 语句将这两个选项的值输出到屏幕上。

请注意，ldap_get_option() 函数需要在成功连接到 LDAP 服务器之后才能调用。