ldap_get_entries

(PHP 3, PHP 4, PHP 5)

ldap_get_entries -- Get all result entries

Description

array ldap_get_entries ( resource link_identifier, resource result_identifier )

Returns a complete result information in a multi-dimensional array on success and FALSE on error.

ldap_get_entries() function is used to simplify reading multiple entries from the result, specified with result_identifier, and then reading the attributes and multiple values. The entire information is returned by one function call in a multi-dimensional array. The structure of the array is as follows.

The attribute index is converted to lowercase. (Attributes are case-insensitive for directory servers, but not when used as array indices.)

return_value["count"] = number of entries in the result
return_value[0] : refers to the details of first entry

return_value[i]["dn"] =  DN of the ith entry in the result

return_value[i]["count"] = number of attributes in ith entry
return_value[i][j] = jth attribute in the ith entry in the result

return_value[i]["attribute"]["count"] = number of values for 
                                        attribute in ith entry
return_value[i]["attribute"][j] = jth value of attribute in ith entry

See also ldap_first_entry() and ldap_next_entry().


add a note add a note User Contributed Notes
markus dot schabel at tgm dot ac dot at
21-Feb-2006 04:20
When you like to get the entry from LDAP in the same style as ldap_add(), then you can use the following function to convert this entry.

<?php
/**
 * Take an LDAP and make an associative array from it.
 *
 * This function takes an LDAP entry in the ldap_get_entries() style and
 * converts it to an associative array like ldap_add() needs.
 *
 * @param array $entry is the entry that should be converted.
 *
 * @return array is the converted entry.
 */
function cleanUpEntry( $entry ) {
  
$retEntry = array();
   for (
$i = 0; $i < $entry['count']; $i++ ) {
      
$attribute = $entry[$i];
       if (
$entry[$attribute]['count'] == 1 ) {
          
$retEntry[$attribute] = $entry[$attribute][0];
       } else {
           for (
$j = 0; $j < $entry[$attribute]['count']; $j++ ) {
              
$retEntry[$attribute][] = $entry[$attribute][$j];
           }
       }
   }
   return
$retEntry;
}
?>
reuben dot helms at gmail dot com
07-Feb-2006 05:13
Helmuts programming example is incorrect.

PHP arrays start from zero, so your first entry is $entry[0] and your last entry is $entry[$entry["count"] - 1].

$entry[$entry["count"]] will never exist, thus his usage of is_null.

Helmuts usage of is_null is not elegant, its just poor understanding of arrays.

Save some confusion and remove Helmuts entry and this one.
Jim Granger <tenor at jimgranger.com>
25-Jun-2005 05:27
Another way of ignoring the last null entry would be to subtract one from the iteration count like this:

for($i = 0; $i < count($result_array) - 1; $i++)
{
     ...
}

Helmut's method is far more elegant on its own but what I do is combine the above with the null test that he suggested. It may seem like overkill, but better safe than sorry.
helmut dot patay at scandio dot de
22-Apr-2004 06:57
If you loop over the entries, like
$entries = ldap_get_entries( $ds, $sr );
watch out!
you have to check with is_null the last entry
because you will get one entry more than the search found,
but the last one will be null
so you are safe if you do:
for ( $i = 0; $i < count( $entries ); $i++ ) {
   if ( is_null( $entries[ $i ] ) ) continue;
   ...
}
Ovidiu Geaboc <ogeaboc at rdanet.com>
13-Nov-2003 11:59
I have found that ldap_get_entries() function doesn't handle binary data correctly.  I had to write my own using ldap_get_values_len().

// will use ldap_get_values_len() instead and build the array
// note: it's similar with the array returned by
// ldap_get_entries() except it has no "count" elements
$i=0;
$entry = ldap_first_entry($this->conn, $this->srchRslt);
do {
     $attributes = ldap_get_attributes($this->conn, $entry);
     for($j=0; $j<$attributes['count']; $j++) {
       $values = ldap_get_values_len($this->conn, $entry,$attributes[$j]);
       $this->rawData[$i][$attributes[$j]] = $values;
     }         
     $i++;               
   }
while ($entry = ldap_next_entry($this->conn, $entry));
//we're done
return ($this->rawData);
mackstann / mack%at%incise%dot%org
05-Sep-2003 02:50
I find the ["count"] items in these arrays highly annoying, so I made a function to remove them recursively:

function rCountRemover($arr) {
  foreach($arr as $key=>$val) {
   # (int)0 == "count", so we need to use ===
   if($key === "count")
     unset($arr[$key]);
   elseif(is_array($val))
     $arr[$key] = rCountRemover($arr[$key]);
  }
  return $arr;
}
reaper at sci dot fi
18-Jun-2003 09:09
If you're dealing with Active Directory and need to get values like 'lastlogon', 'pwdlastset' or similar, you'll notice that AD gives the values as Windows FILETIME timestamps. That means, the values are 100-nanosecond units passed since 1.1.1600 00:00:00.

 To convert these to unix timestamps which PHP's date functions understand, one easy way would be the following :

function win_filetime_to_timestamp ($filetime) {

  $win_secs = substr($filetime,0,strlen($filetime)-7); // divide by 10 000 000 to get seconds
  $unix_timestamp = ($win_secs - 11644473600); // 1.1.1600 -> 1.1.1970 difference in seconds
  return $unix_timestamp;
}
matt.s(remove)at(remove)aptalaska.net
17-Apr-2002 04:36
I noticed the same thing Ron did, except I couldn't get php to return the attribute values using numerical pointers at all.  I ended up using an eval() to pass in the associative name:

$ds=ldap_connect("ldapserver");

if ($ds) {

   $r=ldap_bind($ds); #bind to directory
   $sr=ldap_search($ds,"dc=domain,dc=net", "uid=user"); #search for user
  
   print  "Number of entires returned is " .ldap_count_entries($ds,$sr)."<p>";

   $info = ldap_get_entries($ds, $sr); #get the result
  
   print "Data for ".$info["count"]." items returned:<p>";

   for ($i=0; $i<$info["count"]; $i++) {  #loop though ldap search result
    
     print "dn: " . $info[$i]["dn"] . "<br>"; #print dn
  
     for ($ii=0; $ii<$info[$i]["count"]; $ii++) { #loop though attributes in this dn
       print "&nbsp;&nbsp;" . $info[$i][$ii] . ": "; #print attribute name
       $attrib = $info[$i][$ii]; #set attribute
       eval("print \$info[\$i][\"$attrib\"][0];"); #print attribute value

       print "<br>";
     }
    
     print "<br>";
   }
  
   ldap_close($ds);
  
} else {
   echo "<h4>Unable to connect to LDAP server</h4>";
}
pmichaud at pobox dot com
10-Feb-2002 10:43
Actually, the fact that ldap_get_entries returns attribute names as lowercase is really annoying, because ldap_get_attributes apparently does not.  This is really annoying, especially when having arrays of attribute names and having to worry about which call was used to retrieve entries from LDAP.
c dot green at its dot uq dot edu dot au
17-Aug-2001 07:25
In response to the first message ldap_get_entries, I think there is some confusion with the dynamic typing of php.

If the result is a string doing $foo[0] will return the first character of the string.

In the case of an array $foo[0] will return the entire first element.

Its not to do with the 'dn' in particular, rather the fact that the dn is a scalar value (ie a string) rather than an array, and the indexing works differently in either case.

For debugging purposes I would recommend using something like :

$value = is_array($foo) ? $foo[0] : $foo;

or

$value = is_array($foo) ? implode($foo, $delimiter) : $foo;
oscara at hinux dot hin dot no
16-May-2001 12:51
Note: ldap_get_entries returns true even if no results are found, like this:

echo $entries=ldap_get_entries(...);

will print Array.

You have to check for number of row in the Array like this:

if($entries["count"]==0) return false;

Hope this helped someone...
john at petbrain dot com
21-Dec-2000 02:24
<p>Just a note: an multidemnsional array is like an array with in an array.... you have myArray[2]-> can refer to something like dc=americas,dc=icm,dc=org

<p>Basically you have more elements that are buried with in one element of the parent array[], myArray[2]

<p>So, thats why you see myArray[1]["dn"][0] ... pulling out the first element in myArray[1] and rollover the first element in it.
cbrent at orix dot com dot au
18-Apr-2000 01:03
Note that ldap_get_entries return an associative array with the attributes in lower case.  So for example the givenName ldap attribute is associated with $ldap[0]["givenname"][0] (for the first given name for the first result) this is a little confusing at first.
ron at opus1 dot com
24-Feb-2000 09:17
Note that when you are using loops to search through attributes, you must handle [dn] separately, otherwise each iteration of the loop will only return each character of the dn, left to right, and  the array for dn of "cn=boo" would be:
dn [0]="c"
dn [1]="n"
dn [2]="="
dn [3]="b"
dn [4]="o"
dn [5]="o"
Not much fun to debug. ;-)