curl-getinfo.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f34918d8b2761af5b596b1b762753ee825c19cd8 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.curl-getinfo" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>curl_getinfo</refname>
  <refpurpose>Lit les informations détaillant un transfert cURL</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>curl_getinfo</methodname>
   <methodparam><type>CurlHandle</type><parameter>handle</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>option</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>curl_getinfo</function> lit les informations
   concernant le transfert <parameter>handle</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &curl.ch.description;
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       L'un des constantes <constant>CURLINFO_<replaceable>*</replaceable></constant>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Si <parameter>option</parameter> est fourni, la valeur sera retournée.
   Sinon, ce sera un tableau associatif contenant les éléments suivants
   (qui correspond à <parameter>option</parameter>), ou &false; si une erreur survient :
   <itemizedlist>
    <listitem>
     <simpara>
      "url"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "content_type"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "http_code"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "header_size"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "request_size"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "filetime"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "ssl_verify_result"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "redirect_count"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "total_time"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "namelookup_time"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "connect_time"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "pretransfer_time"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "size_upload"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "size_download"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "speed_download"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "speed_upload"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "download_content_length"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "upload_content_length"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "starttransfer_time"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "redirect_time"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "certinfo"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "primary_ip"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "primary_port"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "local_ip"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "local_port"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "redirect_url"
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "request_header" (Existe seulement si <constant>CURLINFO_HEADER_OUT</constant>
      est utilisé via un appel à <function>curl_setopt</function>)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "posttransfer_time_us" (Disponible à partir de PHP 8.4.0 et cURL 8.10.0)
     </simpara>
    </listitem>
   </itemizedlist>
   Veuillez noter que les données privées ne sont pas incluses dans le tableau
   associatif et doivent être récupérées individuellement avec l'option
   <constant>CURLINFO_PRIVATE</constant>.
  </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>8.4.0</entry>
       <entry>
        Introduction de la constante <constant>CURLINFO_POSTTRANSFER_TIME_T</constant> et de <literal>posttransfer_time_us</literal> (cURL 8.10.0 ou version ultérieure).
       </entry>
      </row>
      <row>
       <entry>8.3.0</entry>
       <entry>
        Introduit <constant>CURLINFO_CAINFO</constant>
        et <constant>CURLINFO_CAPATH</constant>.
       </entry>
      </row>
      <row>
       <entry>8.2.0</entry>
       <entry>
        Introduction des nouvelles constantes <constant>CURLINFO_PROXY_ERROR</constant>,
        <constant>CURLINFO_REFERER</constant>,
        <constant>CURLINFO_RETRY_AFTER</constant>.
       </entry>
      </row>
      &curl.changelog.handle-param;
      <row>
       <entry>8.0.0</entry>
       <entry>
        <parameter>option</parameter> est désormais nullable ;
        auparavant, la valeur par défaut était <literal>0</literal>.
       </entry>
      </row>
      <row>
       <entry>7.3.0</entry>
       <entry>
        Ajout de <constant>CURLINFO_CONTENT_LENGTH_DOWNLOAD_T</constant>,
        <constant>CURLINFO_CONTENT_LENGTH_UPLOAD_T</constant>,
        <constant>CURLINFO_HTTP_VERSION</constant>,
        <constant>CURLINFO_PROTOCOL</constant>,
        <constant>CURLINFO_PROXY_SSL_VERIFYRESULT</constant>,
        <constant>CURLINFO_SCHEME</constant>,
        <constant>CURLINFO_SIZE_DOWNLOAD_T</constant>,
        <constant>CURLINFO_SIZE_UPLOAD_T</constant>,
        <constant>CURLINFO_SPEED_DOWNLOAD_T</constant>,
        <constant>CURLINFO_SPEED_UPLOAD_T</constant>,
        <constant>CURLINFO_APPCONNECT_TIME_T</constant>,
        <constant>CURLINFO_CONNECT_TIME_T</constant>,
        <constant>CURLINFO_FILETIME_T</constant>,
        <constant>CURLINFO_NAMELOOKUP_TIME_T</constant>,
        <constant>CURLINFO_PRETRANSFER_TIME_T</constant>,
        <constant>CURLINFO_REDIRECT_TIME_T</constant>,
        <constant>CURLINFO_STARTTRANSFER_TIME_T</constant>,
        <constant>CURLINFO_TOTAL_TIME_T</constant>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>curl_getinfo</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// Création d'un gestionnaire cURL
$ch = curl_init('http://www.example.com/');

// Exécution
curl_exec($ch);

// Vérification si une erreur est survenue
if(!curl_errno($ch))
{
 $info = curl_getinfo($ch);

 echo 'La requête a mis ' . $info['total_time'] . ' secondes à être envoyée à ' . $info['url'];
}

// Fermeture du gestionnaire
curl_close($ch);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Exemple de <function>curl_getinfo</function> avec le paramètre <parameter>option</parameter></title>
    <programlisting role="php">
<![CDATA[
<?php
// Création d'un gestionnaire cURL
$ch = curl_init('http://www.example.com/');

// Exécution
curl_exec($ch);

// Vérification du code d'état HTTP
if (!curl_errno($ch)) {
  switch ($http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE)) {
    case 200:  # OK
      break;
    default:
      echo 'Unexpected HTTP code: ', $http_code, "\n";
  }
}

// Close handle
curl_close($ch);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Les informations fournies par cette fonction sont conservées si la connexion
    est réutilisée. La donnée précédemment utilisée est donc retournée à moins que
    celle-ci ne soit écrasée en interne entre temps.
   </para>
  </note>
 </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
-->