ldap_read

ldap_read

Lee una entrada

Descripción#

php ldap_read(LDAP\Connection $ldap, array $base, array $filter, [array $attributes], [int $attributes_only], [int $sizelimit], [int $timelimit], [int $deref], [array $controls]): LDAP\Resultphp

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.

También es posible realizar búsquedas en paralelo. En este caso, el primer argumento debe ser un array de instancias de LDAP\Connection, en lugar de una sola. Si las búsquedas no deben utilizar todas el mismo DN base y filtro, se puede pasar un array de DN base y/o un array de filtros como argumentos. Estos arrays deben tener el mismo tamaño que el array de instancias de LDAP\Connection, ya que las primeras entradas de los arrays se utilizan para una búsqueda, las segundas entradas para otra, y así sucesivamente. Al realizar búsquedas en paralelo, se devuelve un array de instancias de LDAP\Result, excepto en caso de error, donde el valor de retorno será false.

Parámetros#

ldap
Una instancia de LDAP\Connection, devuelta por 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.

[!NOTE] 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.

[!NOTE] 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.

Valores devueltos#

Devuelve una instancia de LDAP\Result, un array de instancias de LDAP\Result, o false si ocurre un error.

Historial de cambios#

Versión	Descripción
8.1.0	El parámetro ldap ahora espera una instancia de LDAP\Connection ; anteriormente, se esperaba un resource ldap link válido.
8.1.0	Ahora devuelve una instancia de LDAP\Result; anteriormente, se devolvía un resource.
8.0.0	controls ahora acepta null; anteriormente, su valor predeterminado era [].
7.3.0	Se añadió soporte para controls.