mirror of
https://github.com/php/doc-es.git
synced 2026-04-28 17:43:11 +02:00
ce2e8abb67
git-svn-id: https://svn.php.net/repository/phpdoc/es/trunk@334597 c90b9560-bf6c-de11-be94-00142212c4b1
218 lines
7.1 KiB
XML
218 lines
7.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: afc3f34c682418a582b0f9199db0bac4a087821f Maintainer: edwincartagenah Status: ready -->
|
|
<!-- Reviewed: no -->
|
|
<refentry xml:id="function.ldap-read" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ldap_read</refname>
|
|
<refpurpose>Leer una entrada</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>ldap_read</methodname>
|
|
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>base_dn</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>filter</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>timelimit</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>deref</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Realiza la búsqueda de un <parameter>filter</parameter> en específico en el
|
|
directorio con el alcance de <constant>LDAP_SCOPE_BASE</constant>. Lo que es
|
|
equivalente a leer una entrada del directorio.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>link_identifier</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Un enlace identificador de LDAP, devuelto por <function>ldap_connect</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>base_dn</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
El DN base para el directorio.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>filter</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
No se permite un filtro vacío. Si quieres devolver absolutamente toda
|
|
la información de esta entrada, utiliza un filtro como este
|
|
<literal>objectClass=*</literal>. Si sabes qué tipos de entradas se
|
|
utilizan en el servidor de directorio, podrías utilizar un filtro apropiado
|
|
tal como <literal>objectClass=inetOrgPerson</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>attributes</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Un 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.
|
|
</para>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>attrsonly</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Deberí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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>sizelimit</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Permite limitar la cuenta de entradas extraídas. Establecer esto a 0
|
|
significa que no hay límite.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
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.
|
|
</para>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>timelimit</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Establece el número de segundos de cuan larga será la búsqueda. Al establecer
|
|
esto a 0 significa que no hay límite.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
Este parámetro NO puede prevalecer al límite de tiempo preestablecido en el lado del servidor. Aunque
|
|
puedes establecerlo al más bajo.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>deref</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Especifica cuantos alias deberían ser manejados durante la búsqueda. Este puede ser
|
|
uno de los siguientes:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LDAP_DEREF_NEVER</constant> - (predeterminado) Los alias nunca son
|
|
desreferenciados.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LDAP_DEREF_SEARCHING</constant> - Los alias deberían ser
|
|
desreferenciados durante la búsqueda pero no cuando se quiere ubicar el objeto base.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LDAP_DEREF_FINDING</constant> - Los alias deberían ser
|
|
desreferenciados cuando se quiere ubicar el objeto base pero no durante la búsqueda.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LDAP_DEREF_ALWAYS</constant> - Los alias deberían ser siempre
|
|
desreferenciados.
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Devuelve un identificador del resultado de la búsqueda o &false; en caso de error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>4.0.5</entry>
|
|
<entry>
|
|
Se añadió soporte para búsquedas en paralelo.
|
|
Para más detalles vea <function>ldap_search</function>.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|