(PHP 4, PHP 5, PHP 7)
ldap_read — Leer una entrada
$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.
link_identifierUn enlace identificador de LDAP, devuelto por ldap_connect().
base_dnEl DN base para el directorio.
filterNo 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.
attributesUn 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.
attrsonlyDeberí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.
sizelimitPermite 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.
timelimitEstablece 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.
derefEspecifica 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.
Devuelve un identificador del resultado de la búsqueda o FALSE en caso de error.
| Versión | Descripción |
|---|---|
| 4.0.5 | Se añadió soporte para búsquedas en paralelo. Para más detalles vea ldap_search(). |