doc-fr/reference/ldap/functions/ldap-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ldap-connect" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ldap_connect</refname>
  <refpurpose>Connexion à un serveur LDAP</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>LDAP\Connection</type><type>false</type></type><methodname>ldap_connect</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>uri</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <warning>
   <simpara>
    la signature <emphasis>suivante</emphasis> est toujours supportée pour la
    rétrocompatibilité (à l'exception des paramètres nommés), mais est considérée obsolète et ne devrait plus être utilisée !
   </simpara>
  </warning> 
  <methodsynopsis>
   <type class="union"><type>LDAP\Connection</type><type>false</type></type><methodname>ldap_connect</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>uri</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>port</parameter><initializer>389</initializer></methodparam>
  </methodsynopsis>
  <para>
   Crée une instance <classname>LDAP\Connection</classname> et vérifie si
   l'<parameter>uri</parameter> donnée est plausible.
  </para>
  <note>
   <simpara>
    Cette fonction n'ouvre <emphasis>pas</emphasis> de connexion. Il vérifie si 
    les paramètres donnés sont plausibles et peuvent être utilisés pour ouvrir une
    connexion dès qu'on en a besoin.
   </simpara>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>uri</parameter></term>
     <listitem>
      <para>
       Un URI LDAP complet de la forme <literal>LDAP://hostname:port</literal>
       ou <literal>LDAPS://hostname:port</literal> pour le chiffrement SSL.
      </para>
      <para>
       Vous pouvez également fournir plusieurs URI LDAP séparés par un espace comme une chaîne
      </para>
      <para>
       Notez que <literal>hostname:port</literal> n'est pas un URI LDAP pris en
       charge car le schéma est manquant.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>uri</parameter></term>
     <listitem>
      <para>
       Le nom d'hôte à se connecter.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       Le port utilisé pour la connexion.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne une instance de <classname>LDAP\Connection</classname> lorsque
   l'URI LDAP semble plausible. Il s'agit d'un contrôle syntaxique des paramètres fournis,
   mais le serveur(s) ne sera pas contacté ! 
   Si la vérification syntaxique échoue, elle retourne &false;.
   <function>ldap_connect</function> retournera sinon une instance de
   <classname>LDAP\Connection</classname> car elle ne se connectera pas mais
   initialisera uniquement les paramètres de connexion.
   Actuellement, la connexion intervient avec le prochain appel aux fonctions
   <literal>ldap_*</literal>, habituellement avec la fonction
   <function>ldap_bind</function>.
  </para>
  <para>
   Sans argument, alors l'instance <classname>LDAP\Connection</classname> de
   la dernière connexion déjà ouverte sera retourné.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.1.0</entry>
      <entry>
       Retourne désormais une instance de <classname>LDAP\Connection</classname> ;
       auparavant, une &resource; était attendu.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple de connexion à un serveur LDAP</title>
    <programlisting role="php">
<![CDATA[
<?php

// LDAP variables
$ldapuri = "ldap://ldap.example.com:389";  // voter ldap-uri

// Connexion LDAP
$ldapconn = ldap_connect($ldaphost, $ldapport)
          or die("Cette LDAP-URI n'a pas été analysable");

?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Exemple de connexion à un serveur LDAP SSL</title>
    <programlisting role="php">
<![CDATA[
<?php

// Assurez-vous que l'hôte est correct
// et que vous avez un certificat valide
$ldaphost = "ldaps://ldap.example.com/";

// Connexion LDAP
$ldapconn = ldap_connect($ldaphost)
          or die("Cette LDAP-URI n'a pas été analysable");

?>
]]>
    </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
-->