ldap_count_entries

(PHP 4, PHP 5, PHP 7, PHP 8)

ldap_count_entriesCount the number of entries in a search

Description

ldap_count_entries(LDAP\Connection $ldap, LDAP\Result $result): int

Returns the number of entries stored in the result of previous search operations.

Parameters

ldap

An LDAP\Connection instance, returned by ldap_connect().

result

An LDAP\Result instance, returned by ldap_list() or ldap_search().

Return Values

Returns number of entries in the result, or false on failure.

Changelog

Version Description
8.1.0 The ldap parameter expects an LDAP\Connection instance now; previously, a valid ldap link resource was expected.
8.1.0 The result parameter expects an LDAP\Result instance now; previously, a valid ldap result resource was expected.

Examples

Example #1 ldap_count_entries() example

Retrieve number of entries in the result.

// $ds is a valid LDAP\Connection instance for a directory server

$dn = 'ou=example,dc=org';
$filter = '(|(sn=Doe*)(givenname=John*))';
$justthese = array('ou', 'sn', 'givenname', 'mail');

$sr = ldap_search($ds, $dn, $filter, $justthese);

var_dump(ldap_count_entries($ds, $sr));

The above example will output something similar to:

     int(1)
     

add a note add a note

User Contributed Notes 1 note

up
0
martin dot keckeis1 at gmail dot com
9 years ago
If your search result is larger then the directory limit, it will just show you the maximum number of return entries possible by the directory (.e.g 2000 in some ActiveDirectories)
To Top