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 伺服器之後才能呼叫。