ldap_list

(PHP 4, PHP 5, PHP 7)

ldap_list — Búsqueda de un solo nivel

Descripción

ldap_list ( 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 especificado en el directorio con el alcance de LDAP_SCOPE_ONELEVEL.

LDAP_SCOPE_ONELEVEL quiere decir que la búsqueda solamente debería devolver información que está en el nivel inmediatamente abajo de el base_dn proporcionado en la llamada. (Equivalente a digitar "ls" y obtener una lista de los ficheros y carpetas en el actual directorio de trabajo.)

Parámetros

link_identifier

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

base_dn

El DN base para el directorio.

filter

attributes

Un array de atributos requeridos, por ejemplo array("correo", "sn", "cn"). Tenga en cuenta que "dn" siempre es devuelto independientemente de qué tipos de atributos lo soliciten.

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

attrsonly

Debería ser establecido a 1 solamente si los tipos de atributo son solicitados. Si se establece a 0 se devuelven los tipos de atributos y los valores de los atributos lo cual es el comportamiento predeterminado.

sizelimit

Te permite limitar el conteo de entradas a devolver. Al establecer esto a 0 significa que no hay límite.

Nota:

Este parámetro NO puede prevalecer sobre el sizelimit preestablecido en el lado del servidor. Puede aún establecerlo a uno más bajo.

Algunos equipos de servidor de directorio serán configurados para devolver no mas que un número preestablecido de entradas. Si esto ocurre, el servidor indicará que sólo ha devuelto un conjunto de resultados parciales. Esto también ocurre si utiliza este parámetro para limitar el conteo de entradas devueltas.

timelimit

Establece el número de segundos de cuánto tiempo pasa en la búsqueda. Poniendo esto a 0 siginifica que no hay límite.

Nota:

Este parámetro NO puede prevalecer sobre el timelimit preestablecido en el lado del servidor. Puede aún establecerlo a uno más bajo.

deref

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

  • LDAP_DEREF_NEVER - (predeterminado) Los alias nunca son dereferenciados.
  • LDAP_DEREF_SEARCHING - Los alias deberían ser dereferenciados durante la búsqueda pero no cuando se está ubicando el objeto base de la búsqueda.
  • LDAP_DEREF_FINDING - Los alias deberían ser dereferenciados cuando se está ubicando el objeto base pero no durante la búsqueda.
  • LDAP_DEREF_ALWAYS - Los alias siempre deberían ser dereferenciados.

Valores devueltos

Devuelve un identificador de resultado de búsqueda, o FALSE en caso de error.

Historial de cambios

Versión Descripción
4.0.5 Ha sido agregado el soporte de búsquedas en paralelo. Vea ldap_search() para más detalles.

Ejemplos

Ejemplo #1 Producir una lista de todas las unidades organizacionales de una organización

<?php
// $ds es un identificador de enlace válido para un servidor de directorio

$basedn = "o=Mi Compañía, c=US";
$justthese = array("ou");

$sr = ldap_list($ds, $basedn, "ou=*", $justthese);

$info = ldap_get_entries($ds, $sr);

for ($i=0; $i < $info["count"]; $i++) {
    echo $info[$i]["ou"][0];
}
?>

Ver también