Home/ Manual/ ldap / functions/ ldap_parse_result

ldap_parse_result

PHP function Edit on GitHub ✎

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

Extract information from result

Description

ldap_parse_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.

Parameters

ldap: Ldap
result: Result
error_code: A reference to a variable that will be set to the LDAP error code in the result, or 0 if 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.

Return Values

Success

Changelog

Version	Description
7.3.0	Support for `controls` added

Examples

ldap_parse_result() example

php

<?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
}
?>

Source: reference/ldap/functions/ldap-parse-result.xml · from the official PHP manual (php/doc-en)