doc-fr/reference/ldap/functions/ldap-parse-result.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b7cbd468cb4c46d55d43a44cade0eb4590d25dea Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.ldap-parse-result" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ldap_parse_result</refname>
  <refpurpose>Extrait des informations d'un résultat</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ldap_parse_result</methodname>
   <methodparam><type>LDAP\Connection</type><parameter>ldap</parameter></methodparam>
   <methodparam><type>LDAP\Result</type><parameter>result</parameter></methodparam>
   <methodparam><type>int</type><parameter role="reference">error_code</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">matched_dn</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">error_message</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter role="reference">referrals</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter role="reference">controls</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Analyse un résultat de recherche LDAP.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>ldap</parameter></term>
     <listitem>
      <para>
       &ldap.parameter.ldap;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      <para>
       &ldap.parameter.result;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>error_code</parameter></term>
     <listitem>
      <para>
       Une référence vers une variable qui sera valorisée du code erreur
       LDAP dans le résultat, ou par <literal>0</literal> si aucune erreur
       n'est survenue.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>matched_dn</parameter></term>
     <listitem>
      <para>
       Une référence vers une variable qui sera valorisée du DN correspondant
       s'il a été reconnu dans la requête, sinon, vaudra &null;.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>error_message</parameter></term>
     <listitem>
      <para>
       Une référence vers une variable qui sera valorisée du message d'erreur LDAP
       dans le résultat, ou d'une chaîne vide si aucune erreur n'est survenue.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>referrals</parameter></term>
     <listitem>
      <para>
       Une référence vers une variable qui sera valorisée d'un jeu de tableaux
       contenant les chaînes de référence dans le résultat, ou un tableau
       vide si aucune référence n'est retournée.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>controls</parameter></term>
     <listitem>
      <para>
       Tableau de <link linkend="ldap.controls">Contrôles LDAP</link> à envoyer avec la requête.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      &ldap.changelog.ldap-object;
      &ldap.changelog.result-object;
      <row>
       <entry>7.3.0</entry>
       <entry>
        Support pour <parameter>controls</parameter> a été ajouté.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>ldap_parse_result</function></title>
    <programlisting role="php">
     <![CDATA[
<?php
$result = ldap_search($ldap, "cn=userref,dc=my-domain,dc=com", "(cn=user*)");
$errcode = $dn = $errmsg = $refs =  null;
if (ldap_parse_result($ldap, $result, $errcode, $dn, $errmsg, $refs)) {
    // faîtes quelques choses avec $errcode, $dn, $errmsg et $refs
}
?>
     ]]>
    </programlisting>
   </example>
  </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
-->