ldap_parse_result
(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)
ldap_parse_result — Extract information from result
說明
LDAP\Connection
$ldap,LDAP\Result
$result,int
&$error_code,string
&$matched_dn = null,string
&$error_message = null,array
&$referrals = null,array
&$controls = null): bool
Parses an LDAP search result.
參數
-
ldap 通過 ldap_connect() 返回的 LDAP\Connection 實例。
-
result 通過 ldap_list() 或者 ldap_search() 返回的 LDAP\Result 實例。
-
error_code A reference to a variable that will be set to the LDAP error code in the result, or
0if no error occurred.-
matched_dn A reference to a variable that will be set to a matched DN if one was recognised within the request, otherwise it will be set to
null.-
error_message A reference to a variable that will be set to the LDAP error message in the result, or an empty string if no error occurred.
-
referrals A reference to a variable that will be set to an array set to all of the referral strings in the result, or an empty array if no referrals were returned.
-
controls An array of LDAP Controls which have been sent with the response.
返回值
成功時返回 true， 或者在失敗時返回 false。
更新日誌
| 版本 | 說明 |
|---|---|
| 8.1.0 | 現在 ldap 參數接受 LDAP\Connection 實例，之前接受 資源(resource)。 |
| 8.1.0 | The result parameter expects an LDAP\Result instance now; previously, a 資源(resource) was expected. |
| 7.3.0 | Support for controls added |
範例
示例 #1 ldap_parse_result() example
<?php
$result = ldap_search($ldap, "cn=userref,dc=my-domain,dc=com", "(cn=user*)");
$errcode = $dn = $errmsg = $refs = null;
if (ldap_parse_result($ldap, $result, $errcode, $dn, $errmsg, $refs)) {
// do something with $errcode, $dn, $errmsg and $refs
}
?>