ldap_read

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

ldap_read — Leer una entrada

Descripción

ldap_read(
    resource $link_identifier,
    string $base_dn,
    string $filter,
    array $attributes = ?,
    int $attrsonly = ?,
    int $sizelimit = ?,
    int $timelimit = ?,
    int $deref = ?
): resource

Realiza la búsqueda de un filter en específico en el directorio con el alcance de LDAP_SCOPE_BASE. Lo que es equivalente a leer una entrada del directorio.

Parámetros

link_identifier

Un enlace identificador de LDAP, devuelto por ldap_connect().

base_dn

El DN base para el directorio.

filter

No se permite un filtro vacío. Si quieres devolver absolutamente toda la información de esta entrada, utiliza un filtro como este objectClass=*. Si sabes qué tipos de entradas se utilizan en el servidor de directorio, podrías utilizar un filtro apropiado tal como objectClass=inetOrgPerson.

attributes

Un array de los atributos requeridos, por ejemplo, array("mail", "sn", "cn"). Nótese que el "dn" siempre se devuelve independientemente de qué tipos de atributos son requeridos.

Utilizar este parámetro es mucho más eficiente que la acción predeterminada (la cual es devolver todos los atributos y sus valores asociados). El uso de este parámetro debería ser, por lo tanto, considerado una buena práctica.

attrsonly

Debería ser establecido a 1 si solamente se buscan los tipos de atributos. Si se establece a 0, ambos los tipos de atributos y los valores de los atributos son extraídos como es el comportamiento predeterminado.

sizelimit

Permite limitar la cuenta de entradas extraídas. Establecer esto a 0 significa que no hay límite.

Nota:
Este parámetro NO puede prevalecer al límite de tamaño preestablecido en el lado del servidor. Aunque puedes establecerlo al más bajo.

Algunos equipos servidores de directorio serán configurados para devovler no más de un determinado número predefinido de entradas. Si esto sucede, el servidor indicará que solamente ha devuelto un conjunto parcial de resultados. Esto también sucede si utilizas este parámetro para limitar la cuenta de las entradas extraídas.

timelimit

Establece el número de segundos de cuan larga será la búsqueda. Al establecer esto a 0 significa que no hay límite.

Nota:
Este parámetro NO puede prevalecer al límite de tiempo preestablecido en el lado del servidor. Aunque puedes establecerlo al más bajo.

deref

Especifica cuantos alias deberían ser manejados durante la búsqueda. Este puede ser uno de los siguientes:

LDAP_DEREF_NEVER - (predeterminado) Los alias nunca son desreferenciados.
LDAP_DEREF_SEARCHING - Los alias deberían ser desreferenciados durante la búsqueda pero no cuando se quiere ubicar el objeto base.
LDAP_DEREF_FINDING - Los alias deberían ser desreferenciados cuando se quiere ubicar el objeto base pero no durante la búsqueda.
LDAP_DEREF_ALWAYS - Los alias deberían ser siempre desreferenciados.

Valores devueltos

Devuelve un identificador del resultado de la búsqueda o false en caso de error.

Historial de cambios

Versión	Descripción
4.0.5	Se añadió soporte para búsquedas en paralelo. Para más detalles vea ldap_search().

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 5 notes

down

cnicholl at yahoo dot com ¶

19 years ago

Clarification of the ldap_read command syntax:  

If you just want to pull certain attributes from an object and you already know it's dn, the ldap_read command can do this as illustrated below.  It will be less overhead than ldap_search.

The string base_dn which is normally used to set the top context for a recursive ldap_search is used slightly differently with this command.  It is used to specify the actual object with the full dn.  (Hopefully this saves someone else a couple hours trying this command out.)

<?php
$ds = ldap.myserver.com // your ldap server
  $dn = "cn=username,o=My Company, c=US"; //the object itself instead of the top search level as in ldap_search
  $filter="(objectclass=*)"; // this command requires some filter
  $justthese = array("ou", "sn", "givenname", "mail"); //the attributes to pull, which is much more efficient than pulling all attributes if you don't do this
      $sr=ldap_read($ds, $dn, $filter, $justthese);
          $entry = ldap_get_entries($ds, $sr);

echo $entry[0]["mail"][0] . "is the email address of the cn your requested";
echo $entry[0]["sn"][0] . "is the sn of the cn your requested";
ldap_close($ds);
?> 

This prints out the specified users mail and surname for example.

down

me at example dot com ¶

17 years ago

In the previous example the

$ds = ldap.myserver.com // your ldap server

should be 

$ds = ldap_connect( "ldap.myserver.com" ) ; // your ldap server

down

ronny at nxc dot no ¶

11 years ago

The array in the attributes parameter needs to be an indexed array with numeric keys in ascending order. Like this:

Array
(
    [0] => this
    [1] => is
    [2] => a
    [3] => test
)

If there are missing keys in the array, then no result will be returned. This will not work:

Array
(
    [0] => this
    [1] => is
    [3] => test
)

down

ehalls at gmail dot com ¶

6 years ago

For those debugging a wrapper, akin to symfony's client wrapper for these functions and since there is crap documentation on a full cycle of pulling a single record vs multiple, etc.

For this one:
YOU MUST call ldap_get_entries after this function call. 

AND PLEASE if you implement a wrapper, prime it with the initial entry else it makes no sense to execute without returning something easily visible as successful.

WHEN query->execute() and you get a collection.. make sure the entry field in the collection has at least the first entry primed.. wasted so much time because it was looking empty. 

AND this entire adapter needs to be wrapped with a less retarded usage pattern via an STL lib wrapper, mysticism( bad design) begone.
123.. not 4290234~"wds

Thanks for your time

down

-1

sbarnum at mac dot com ¶

23 years ago

This differs from ldap_search() by not recursing down to sub-entries.  if you know the dn of the item you're looking for and only want info on that entry, use ldap_read() and pass it the full dn of the item you want.



It also seems that you'd alway want something like objectclass=* for the filter, since you're only searching on one entry.

＋add a note