ldap-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: afc3f34c682418a582b0f9199db0bac4a087821f Maintainer: yago Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ldap-connect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ldap_connect</refname>
  <refpurpose>Abre una conexión a un servidor LDAP</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>ldap_connect</methodname>
   <methodparam choice="opt"><type>string</type><parameter>hostname</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>389</initializer></methodparam>
  </methodsynopsis>
  <para>
   Establece una conexión con un servidor LDAP en un determinado 
   <parameter>hostname</parameter> and <parameter>port</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>hostname</parameter></term>
     <listitem>
      <para>
       Si se está usando OpenLDAP 2.x.x se puede especificar una URL en lugar
       del host. Para usar LDAP con SSL, se debe compilar OpenLDAP 2.x.x 
       con soporte para SSL, configurar PHP con SSL y colocar este parámetro como
       <literal>ldaps://hostname/</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       El puerto al cual debe conectarse. No se usa cuando se está usando URLs.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve un identificador de enlace al LDAP en caso de éxito o &false; en 
   caso de error. 
   Cuando se está usando OpenLDAP 2.x.x, <function>ldap_connect</function> 
   devolverá siempre un <type>resource</type> que no es la conexión en sí sino
   solo inicialización de los parámetros de conexión. La conexión real se realizará
   en la siguiente llamada a las funciones ldap_*, por lo general <function>ldap_bind</function>.
  </para>
  <para>
   Si no se especificaron parámetros, será retornado el identificador de enlace 
   de la conexión activa.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de conexión a un servidor LDAP.</title>
    <programlisting role="php">
<![CDATA[
<?php

// Variables del servidor LDAP
$ldaphost = "ldap.example.com";  // servidor LDAP
$ldapport = 389;                 // puerto del servidor LDAP

// Conexión al servidor LDAP
$ldapconn = ldap_connect($ldaphost, $ldapport)
          or die("Could not connect to $ldaphost");

?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Ejemplo de conexión segura a un servidor LDAP.</title>
    <programlisting role="php">
<![CDATA[
<?php

// Asegúrese de que el host sea el que fue publicado
// con su certificado
$ldaphost = "ldaps://ldap.example.com/";

// Conexión al servidor LDAP
$ldapconn = ldap_connect($ldaphost)
          or die("Could not connect to {$ldaphost}");

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ldap_bind</function></member>
   </simplelist>
  </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
-->