(PHP 4, PHP 5, PHP 7, PHP 8)
ldap_read — Lee una entrada
$ldap
,$base
,$filter
,$attributes
= [],$attributes_only
= 0,$sizelimit
= -1,$timelimit
= -1,$deref
= LDAP_DEREF_NEVER
,$controls
= null
Realiza una búsqueda con el filtro filter
en el directorio base
con la configuración
LDAP_SCOPE_BASE
. Esto es equivalente a leer una
entrada en un directorio.
It is also possible to perform parallel searches. In this case, the first argument should be an array of
LDAP\Connection instances, rather than a single one.
If the searches should not all use the same base DN and filter, an array of base DNs and/or an array of filters can be passed as arguments instead.
These arrays must be of the same size as the LDAP\Connection instances array,
since the first entries of the arrays are used for one search, the second entries are used for another, and so on.
When doing parallel searches an array of LDAP\Result instances is returned, except in case of error, when the return value will be false
.
ldap
An LDAP\Connection instance, returned by ldap_connect().
base
La base DN del directorio.
filter
Un filtro no puede estar vacío. Si se desea leer toda la información
de una entrada, utilice el filtro "objectClass=*
".
Si se conocen los tipos utilizados en el servidor de directorios, también
puede emplearse un filtro adecuado, como
"objectClass=inetOrgPerson
".
attributes
Un array de atributos requeridos, por ejemplo array("mail", "sn", "cn"). Tenga en cuenta que el "dn" siempre se devuelve, independientemente del tipo de atributo solicitado.
El uso de este argumento es más eficiente que el comportamiento por omisión (que consiste en devolver todos los atributos junto con sus valores asociados). Por esta razón, el uso de este argumento debe considerarse una buena práctica.
attributes_only
Debe establecerse en 1
si solo se solicitan los tipos de atributos.
Si se establece en 0
, se recuperan tanto los tipos como los valores
de los atributos, lo que corresponde al comportamiento por omisión.
sizelimit
Permite limitar el número de entradas a recuperar. Establecer este argumento
en 0
significa que no habrá límite.
Nota:
Este argumento no puede sobrescribir la configuración del lado del servidor. No obstante, puede establecerse un valor inferior.
Algunos servidores de directorios pueden estar configurados para devolver solo un número determinado de entradas. Si ocurre este comportamiento, el servidor indica que solo se ha devuelto un conjunto parcial de resultados. Este comportamiento también se produce si se utiliza este argumento para limitar el número de entradas recuperadas.
timelimit
Define el número máximo de segundos permitidos para la búsqueda.
Establecer este argumento en 0
significa que no hay límite.
Nota:
Este argumento no puede sobrescribir la configuración del lado del servidor pero puede utilizarse para ser más restrictivo.
deref
Especifica el número de alias que deben gestionarse durante la búsqueda. Puede ser uno de los siguientes:
LDAP_DEREF_NEVER
- (por omisión) los alias no se
desreferencian nunca.
LDAP_DEREF_SEARCHING
- los alias deben desreferenciarse
durante la búsqueda pero no al localizar el objeto base de la búsqueda.
LDAP_DEREF_FINDING
- los alias deben desreferenciarse
al localizar el objeto base pero no durante la búsqueda.
LDAP_DEREF_ALWAYS
- los alias deben desreferenciarse
siempre.
controls
Array de Controles LDAP a enviar con la petición.
Returns an LDAP\Result instance, an array of LDAP\Result instances, o false
en caso de error.
Versión | Descripción |
---|---|
8.1.0 |
The ldap parameter expects an LDAP\Connection
instance now; previously, a valid ldap link recurso was expected.
|
8.1.0 | Returns an LDAP\Result instance now; previously, a recurso was returned. |
8.0.0 |
controls is nullable now; previously, it defaulted to [] .
|
7.3.0 |
Se añadió soporte para controls .
|