curl-getinfo.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e6dfcca365ffc8e85af84c9ea50b422835be71af Maintainer: andresdzphp Status: ready -->
<!-- Reviewed: no Maintainer: andresdzphp -->

<refentry xml:id='function.curl-getinfo' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>curl_getinfo</refname>
  <refpurpose>Obtener información sobre una transferencia específica</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>curl_getinfo</methodname>
   <methodparam><type>resource</type><parameter>ch</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>opt</parameter></methodparam>
  </methodsynopsis>
  <para>
   Obtiene información sobre la última transferencia.  
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &curl.ch.description;
    <varlistentry>
     <term><parameter>opt</parameter></term>
     <listitem>
      <para>
       Esta puede ser una de las siguientes constantes:
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>CURLINFO_EFFECTIVE_URL</constant> - Última URL efectiva
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_HTTP_CODE</constant> -  El último código de respuesta.
          A partir de PHP 5.5.0 y cURL 7.10.8, este es un alias heredado de
          <constant>CURLINFO_RESPONSE_CODE</constant>
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_FILETIME</constant> -  Tiempo remoto del documento recuperado, con la constante <constant>CURLOPT_FILETIME</constant> habilitada; si -1 es devuelto el tiempo del documento es desconocido
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_TOTAL_TIME</constant> - Tiempo total de transacción en segundos para la última transferencia
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_NAMELOOKUP_TIME</constant> - El tiempo en segundos hasta que la resolución del nombre se haya completado
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_CONNECT_TIME</constant> - El tiempo en segundos que tomó establecer la conexión
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_PRETRANSFER_TIME</constant> - Tiempo en segundos desde el inicio hasta justo antes de que comience la transferencia de archivos
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_STARTTRANSFER_TIME</constant> - Tiempo en segundos hasta que el primer byte está a punto de ser transferido
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_REDIRECT_COUNT</constant> - Número de redirecciones, con la opción <constant>CURLOPT_FOLLOWLOCATION</constant> habilitada
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_REDIRECT_TIME</constant> - Tiempo en segundos de todos los pasos de redireccionamiento antes de que se iniciara la transacción final, con la opción <constant>CURLOPT_FOLLOWLOCATION</constant> habilitada
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_REDIRECT_URL</constant> - Con la opción <constant>CURLOPT_FOLLOWLOCATION</constant> deshabilitadad: redirigir la URL encontrada en la última transacción, que debe ser solicitado manualmente a continuación. Con la opción <constant>CURLOPT_FOLLOWLOCATION</constant> habilitada: esto está vacío. El URL de redireccionamiento en este caso está disponible en <constant>CURLINFO_EFFECTIVE_URL</constant> 
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_PRIMARY_IP</constant> - La dirección IP de la conexión más reciente
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_PRIMARY_PORT</constant> - Puerto de destino de la conexión más reciente
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_LOCAL_IP</constant> - Dirección IP local (fuente) de la conexión más reciente
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_LOCAL_PORT</constant> - Puerto local (fuente) de la conexión más reciente
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_SIZE_UPLOAD</constant> - Número total de bytes cargados
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_SIZE_DOWNLOAD</constant> - Número total de bytes descargados
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_SPEED_DOWNLOAD</constant> - Velocidad media de descarga
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_SPEED_UPLOAD</constant> - Velocidad media de subida
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_HEADER_SIZE</constant> - Tamaño total de todos los encabezados recibidos
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_HEADER_OUT</constant> - El string de solicitud enviado. Para que esto 
          funcione, agregue la opción <constant>CURLINFO_HEADER_OUT</constant> al manejador llamando 
          <function>curl_setopt</function>
         </simpara>
        </listitem>
        <listitem>
         <simpara>
        <constant>CURLINFO_REQUEST_SIZE</constant> - Tamaño total de las solicitudes emitidas, actualmente sólo para las solicitudes HTTP
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_SSL_VERIFYRESULT</constant> - Resultado de la verificación de la certificación SSL solicitada mediante el ajuste <constant>CURLOPT_SSL_VERIFYPEER</constant>
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_CONTENT_LENGTH_DOWNLOAD</constant> - Longitud del contenido de la descarga, leído desde el campo <literal>Content-Length:</literal>
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_CONTENT_LENGTH_UPLOAD</constant> - Tamaño especificado de la carga
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_CONTENT_TYPE</constant> - <literal>Content-Type:</literal> de el documento. NULL indica que el servidor no envió un encabezado válido <literal>Content-Type:</literal>
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_PRIVATE</constant> - Los datos privados asociados al manejador cURL, previamente establecido con la opción <constant>CURLOPT_PRIVATE</constant> de <function>curl_setopt</function>
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_RESPONSE_CODE</constant> - El último código de respuesta
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_HTTP_CONNECTCODE</constant> - El código de respuesta CONNECT
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_HTTPAUTH_AVAIL</constant> - Máscara de bits que indica el(los) método(s) de autenticación disponible(s) según la respuesta anterior
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_PROXYAUTH_AVAIL</constant> - Máscara de bits que indica el(los) método(s) de autenticación del proxy disponible(s) según la respuesta anterior
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_OS_ERRNO</constant> - Número de error de un fallo de conexión. El número es específico del sistema y del sistema operativo.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_NUM_CONNECTS</constant> - El número de conexiones que Curl tuvo que crear para lograr la transferencia anterior
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_SSL_ENGINES</constant> - Los motores de cifrado OpenSSL soportados
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_COOKIELIST</constant> - Todas las cookies conocidas
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_FTP_ENTRY_PATH</constant> - Ruta de entrada en el servidor FTP
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_APPCONNECT_TIME</constant> - El tiempo en segundos que tomó desde el inicio hasta que la conexión SSL/SSH al host remoto se completó
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_CERTINFO</constant> - Cadena de certificados TLS
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_CONDITION_UNMET</constant> - Información sobre el tiempo condicional no cumplido
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_RTSP_CLIENT_CSEQ</constant> - Próximo cliente de RTSP CSeq
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_RTSP_CSEQ_RECV</constant> - Recién recibido CSeq
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_RTSP_SERVER_CSEQ</constant> - Próximo servidor RTSP CSeq
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_RTSP_SESSION_ID</constant> - ID de la sesión RTSP
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_CONTENT_LENGTH_DOWNLOAD_T</constant> - El contenido de la descarga. Este es el valor leído de el campo <literal>Content-Type:</literal>. -1 si el tamaño no es conocido
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_CONTENT_LENGTH_UPLOAD_T</constant> - El tamaño especificado de la carga. -1 si no se conoce el tamaño
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_HTTP_VERSION</constant> - La versión usada en la última conexión HTTP. El valor devuelto será una de las constantes <constant>CURL_HTTP_VERSION_*</constant> constants o 0 si la versión no puede ser determinada
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_PROTOCOL</constant> - El protocolo utilizado en la última conexión HTTP. El valor devuelto será exactamente uno de los valores <constant>CURLPROTO_*</constant>
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_PROXY_SSL_VERIFYRESULT</constant> - El resultado de la verificación del certificado que se solicitó (usando la opción <constant>CURLOPT_PROXY_SSL_VERIFYPEER</constant>). Sólo se utiliza para los proxies HTTPS
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_SCHEME</constant> - El esquema de URL usado para la conexión más reciente
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_SIZE_DOWNLOAD_T</constant> - Número total de bytes que se descargaron. El número es sólo para la última transferencia y se restablecerá de nuevo para cada nueva transferencia
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_SIZE_UPLOAD_T</constant> - Número total de bytes que se cargaron
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_SPEED_DOWNLOAD_T</constant> - La velocidad media de descarga en bytes/segundo que cURL midió para la descarga completa
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_SPEED_UPLOAD_T</constant> - La velocidad media de subida en bytes/segundo que cURL midió para la subida completa
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_APPCONNECT_TIME_T</constant> - Tiempo, en microsegundos, que tomó desde el principio hasta que la conexión SSL/SSH al host remoto se completó
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_CONNECT_TIME_T</constant> - Tiempo total tomado, en microsegundos, desde el inicio hasta que se completó la conexión con el host remoto (o proxy)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_FILETIME_T</constant> - Hora remota del documento recuperado (como la marca de tiempo de Unix), una alternativa a <constant>CURLINFO_FILETIME</constant> para permitir que los sistemas con variables de 32 bits de largo extraigan fechas fuera del rango de 32 bits de la marca de tiempo
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_NAMELOOKUP_TIME_T</constant> - Tiempo en microsegundos desde el comienzo hasta que el nombre es resuelto.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_PRETRANSFER_TIME_T</constant> - El tiempo transcurrido desde el inicio hasta la transferencia de archivos está a punto de comenzar, en microsegundos
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_REDIRECT_TIME_T</constant> - El tiempo total, en microsegundos, que tomó para todos los pasos de redireccionamiento incluyen la búsqueda del nombre, la conexión, la pretransferencia y la transferencia antes de que se iniciara la transacción final
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_STARTTRANSFER_TIME_T</constant> - El tiempo, en microsegundos, que tomó desde el inicio hasta que se recibe el primer byte
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>CURLINFO_TOTAL_TIME_T</constant> - Tiempo total en microsegundos para la transferencia anterior, incluyendo la resolución de nombres, la conexión TCP, etc.
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Si se da <parameter>opt</parameter>, devuelve este valor.
   En caso contrario, devuelve un array asociativo con los siguientes valores 
   (que corresponden a <parameter>opt</parameter>), o &false; en caso de error:
   <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" (Esto sólo se establece si <constant>CURLINFO_HEADER_OUT</constant> 
      se establece por una llamada previa a <function>curl_setopt</function>)
     </simpara>
    </listitem>
   </itemizedlist>
   Nótese que los datos privados no están incluidos en el conjunto asociativo y deben recuperarse individualmente con la opción <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>7.3.0</entry>
       <entry>
        Introdujo <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>
      <row>
       <entry>5.5.0</entry>
       <entry>
        Introdujo <constant>CURLINFO_RESPONSE_CODE</constant>,
        <constant>CURLINFO_HTTP_CONNECTCODE</constant>,
        <constant>CURLINFO_HTTPAUTH_AVAIL</constant>,
        <constant>CURLINFO_PROXYAUTH_AVAIL</constant>,
        <constant>CURLINFO_OS_ERRNO</constant>,
        <constant>CURLINFO_NUM_CONNECTS</constant>,
        <constant>CURLINFO_SSL_ENGINES</constant>,
        <constant>CURLINFO_COOKIELIST</constant>,
        <constant>CURLINFO_FTP_ENTRY_PATH</constant>,
        <constant>CURLINFO_APPCONNECT_TIME</constant>,
        <constant>CURLINFO_CONDITION_UNMET</constant>,
        <constant>CURLINFO_RTSP_CLIENT_CSEQ</constant>,
        <constant>CURLINFO_RTSP_CSEQ_RECV</constant>,
        <constant>CURLINFO_RTSP_SERVER_CSEQ</constant> y
        <constant>CURLINFO_RTSP_SESSION_ID</constant>.
       </entry>
      </row>
      <row>
       <entry>5.4.7</entry>
       <entry>
        Introdujo <constant>CURLINFO_PRIMARY_IP</constant>,
        <constant>CURLINFO_PRIMARY_PORT</constant>,
        <constant>CURLINFO_LOCAL_IP</constant> y
        <constant>CURLINFO_LOCAL_PORT</constant>.
       </entry>
      </row>
      <row>
       <entry>5.3.7</entry>
       <entry>
        Introdujo <constant>CURLINFO_REDIRECT_URL</constant>.
       </entry>
      </row>
      <row>
       <entry>5.3.0</entry>
       <entry>
        Introdujo <constant>CURLINFO_CERTINFO</constant>.
       </entry>
      </row>
      <row>
       <entry>5.2.4</entry>
       <entry>
        Introdujo <constant>CURLINFO_PRIVATE</constant>.
       </entry>
      </row>
      <row>
       <entry>5.1.3</entry>
       <entry>
        Introdujo <constant>CURLINFO_HEADER_OUT</constant>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>curl_getinfo</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// Crear un manejador cURL
$ch = curl_init('http://www.example.com/');

// Ejecutar
curl_exec($ch);

// Verificar si ocurrió algún error
if (!curl_errno($ch)) {
  $info = curl_getinfo($ch);
  echo 'Took ', $info['total_time'], ' seconds to send a request to ', $info['url'], "\n";
}

// Close handle
curl_close($ch);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Ejemplo de <function>curl_getinfo</function> con el parámetro <parameter>opt</parameter></title>
    <programlisting role="php">
<![CDATA[
<?php
// Crear un manejador cURL
$ch = curl_init('http://www.example.com/');

// Ejecutar
curl_exec($ch);

// Comprueba el código de estado 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>
    La información recogida por esta función se guarda si el manejador se reutiliza. Esto significa que 
    a menos que una estadística sea anulada internamente por esta función, la información anterior 
    es devuelta.
   </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
-->