ldap_list
(PHP 4, PHP 5)
ldap_list — Búsqueda de nivel único
Descripción
Realiza la búsqueda para un filtro especificado en el directorio, con el ámbito LDAP_SCOPE_ONELEVEL.
LDAP_SCOPE_ONELEVEL quiere decir que la búsqueda sólo debe devolver información que se encuentre en el nivel inmediatamente inferior al dn_base especificado en la llamada. (Equivalente a escribir "ls" y obtener un listado de archivos y carpetas en el directorio de trabajo actual.)
Lista de parámetros
- id_enlace
-
Un identificador de enlace LDAP, devuelto por ldap_connect().
- dn_base
-
El DN base para el directorio.
- filtro
-
- atributos
-
Una matriz con los atributos requeridos, p.ej. array("mail", "sn", "cn"). Note que "dn" siempre es devuelto independientemente de cuáles atributes son requeridos.
Usar 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 debe por lo tanto considerarse una práctica recomendable.
- solo_atribs
-
Debe ser definido a 1 si solo se desean tipos de atributo. Si es definido como 0, se recuperan tipos de atributo y valores de atributo, lo cual es el comportamiento predeterminado.
- limite_tamanyo
-
Le permite limitar el número de entradas a recuperar. Definir este valor como 0 quiere decir sin límite.
Note: Este parámetro NO puede sobrescribir el límite de tamaño predefinido en el lado del servidor. Sin embargo, es posible definirlo como un valor más bajo.
Algunos servidores de directorios estarán configurados para devolver no más de un número predefinido de entradas. Si esto ocurre, el servidor indicará que solo ha devuelto un conjunto parcial de resultados. Esto ocurre también si usa este parámetro para limitar el número de entradas recuperadas.
- limite_tiempo
-
Define el número de segundos a esperar en la búsqueda. Definir este valor como 0 quiere decir sin límite.
Note: Este parámetro NO puede sobrescribir el límite de tiempo predefinido en el lado del servidor. Sin embargo, es posible definirlo como un valor más bajo.
- deref
-
Especifica el modo en que deben manejarse los alias durante la búsqueda. Puede ser uno de los siguientes valores:
- LDAP_DEREF_NEVER - (predeterminado) los alias nunca son dereferenciados.
- LDAP_DEREF_SEARCHING - los alias deben ser dereferenciados durante la búsqueda pero no cuando se ubica el objeto base de la búsqueda.
- LDAP_DEREF_FINDING - los alias deben ser dereferenciados cuando se ubica el objeto base, pero no durante la búsqueda.
- LDAP_DEREF_ALWAYS - los alias deben ser dereferenciados siempre.
Valores retornados
Devuelve un identificador de resultado de búsqueda, o FALSE en caso de error.
Registro de cambios
| Versión | Descripción |
|---|---|
| 4.0.5 | Se agregó el soporte para búsquedas paralelas. Vea ldap_search() para más detalles. |
| 4.0.2 | Los parámetros solo_atribs , limite_tamanyo , limite_tiempo y deref fueron agregados. |
Ejemplos
Example#1 Producir una lista de todas los unidades organizacionales de una organización
// $ds es un identificador de enlace válido para un servidor de directorios
$dn_base = "o=Mi Compañía, c=ES";
$solo_estos = array("ou");
$sr=ldap_list($ds, $dn_base, "ou=*", $solo_estos);
$info = ldap_get_entries($ds, $sr);
for ($i=0; $i<$info["count"]; $i++) {
echo $info[$i]["ou"][0] ;
}