archived-doc-es/reference/http/request-options.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: af4410a7e15898c3dbe83d6ea38246745ed9c6fb Maintainer: gerardocdc Status: ready -->
<appendix xml:id="http.request.options" xmlns="http://docbook.org/ns/docbook">
 <title>Opción que pueden ser utilizadas con la clase HttpRequest y las funciones para peticiones</title>
 <titleabbrev>Opciones de las peticiones</titleabbrev>
 <variablelist xml:id="http.request.options.timeouts">
  <title>Opciones relacionadas con las desconexiones por tiempo (time outs)</title>
  <varlistentry xml:id="http.request.option.timeout">
   <term>
    timeout (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     segundos que toda la petición puede tardar para ser completada
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="http.request.option.connecttimeout">
   <term>
    connecttimeout (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     segundos que la conexión, incluyendo la resolución del nombre, puede tardar
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="http.request.option.dns-cache-timeout">
   <term>
    dns_cache_timeout (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     segundos después de la desconexión por tiempo de una entrada en la cache del dns
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="http.request.options.urls">
  <title>Opciones relacionadas con las urls</title>
  <varlistentry xml:id="http.request.option.url">
   <term>
    url (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     la url de la petición
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="http.request.option.port">
   <term>
    port (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     empleo de otro puerto al especificado en la url
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="http.request.option.redirect">
   <term>
    redirect (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     existencia de la redirección y cuantas redirecciones hay que efectuar; 
     por omisión, su valor es 0
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="http.request.option.unrestrictedauth">
   <term>
    unrestrictedauth (<type>bool</type>)
   </term>
   <listitem>
    <simpara>
     posibilidad de continuar enviando credenciales en las redirecciones a un host diferente
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    referer (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     la url de referencia para enviar
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="http.request.options.cookies">
  <title>Opciones relacionadas con las cookies</title>
  <varlistentry>
   <term>
    encodecookies (<type>bool</type>)
   </term>
   <listitem>
    <simpara>
     si las cookies personalizadas deben ser <function>urlencode</function>adas antes de su envío
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    cookies (<type>array</type>)
   </term>
   <listitem>
    <simpara>
     lista de cookies personalizadas en forma de array asociativo como 
     <literal>array(&quot;cookie&quot; => &quot;value&quot;)</literal>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    cookiestore (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     ruta al fichero donde las cookies son/serán almacenadas
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    cookiesession (<type>bool</type>)
   </term>
   <listitem>
    <simpara>
     no carga las cookies de la sesión desde la cookiestore si su valor es &true;
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="http.request.options.headers">
  <title>Opciones relacionadas con las cabeceras</title>
  <varlistentry>
   <term>
    useragent (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     el agente de usuario a enviar; por omisión el valor es <literal>PECL::HTTP/x.y.z (PHP/x.y.z)</literal>;
     si se configura como una cadena vacía se omite el valor por omisión 
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    lastmodified (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     fecha Unix para la cabecera If-(Un)Modified-Since
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    etag (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     etag citado para la cabecera If-(None-)Match
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    headers (<type>array</type>)
   </term>
   <listitem>
    <simpara>
     lista de cabeceras personalizadas en forma de array asociativo como
     <literal>array(&quot;header&quot; => &quot;value&quot;)</literal>
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="http.request.options.auth">
  <title>Opciones relacionadas con la autentificación</title>
  <varlistentry>
   <term>
    httpauth (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     credenciales http en formato &quot;user:pass&quot;
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    httpauthtype (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     <link linkend="http.constants.request.httpauth">Constantes de los tipos de autentificación HTTP</link>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    (<type>array</type>)
   </term>
   <listitem>
    <simpara>
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="http.request.options.proxy">
  <title>Opciones relacionadas con proxies</title>
  <varlistentry>
   <term>
    proxyhost (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     host del proxy en formato &quot;host[:port]&quot;
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    proxyport (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     empleo de otro puerto especificado en el proxyhost
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    proxytype (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     <link linkend="http.constants.request.proxy">Constantes del tipo de proxy HTTP</link>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    proxyauth (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     credenciales del proxy en formato &quot;user:pass&quot;
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    proxyauthtype (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     <link linkend="http.constants.request.httpauth">Constantes de los tipos de autentificación HTTP</link>
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="http.request.options.transfer">
  <title>Opciones relacionadas con la transferencia</title>
  <varlistentry>
   <term>
    compress (<type>bool</type>)
   </term>
   <listitem>
    <simpara>
     si se debe solicitar y aceptar una respuesta de contenido codificado con gzip/deflate 
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    resume (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     inicia la descarga en el byte especificado de la respuesta si existe soporte en el servidor
     (indicado con el código de estado 206 de la respuesta)
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    range (<type>array</type>)
   </term>
   <listitem>
    <simpara>
     array de arrays, cada uno conteniendo dos <type>integer</type>s, que indican el intervalo de la descarga
     si existe soporte en el servidor (indicado con el código de estado 206 de la respuesta);
     sólo se reconoce si la opción de pausa está vacía
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="http.request.options.limits">
  <title>Opciones que imponen límites</title>
  <varlistentry>
   <term>
    maxfilesize (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     tamaño máximo del fichero que debe ser descargado;
     no tiene ningún efecto si el tamaño de la entidad solicitada es 
     desconocido (por ejemplo, páginas dinámicas con transferencia de codificación fragmentada, etc.)
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    low_speed_limit (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     mínima velocidad de transferencia que una petición con éxito puede tener 
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    low_speed_time (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     el tiempo en el cual <literal>low_speed_limit</literal> es transferida a una petición con éxito
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    max_send_speed (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     máxima velocidad en envío en bytes por segundo
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    max_recv_speed (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     máxima velocidad de recepción en bytes por segundo
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="http.request.options.callback">
  <title>Opciones de llamada de retorno</title>
  <varlistentry>
   <term>onprogress (<type>callback</type>)</term>
   <listitem><simpara>estado del progreso de la llamada de retorno</simpara></listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="http.request.options.network">
  <title>Opciones de red</title>
  <varlistentry>
   <term>interface (<type>string</type>)</term>
   <listitem><simpara>interfaz de la red de salida (iframe, ip o nombre de host)</simpara></listitem>
  </varlistentry>
  <varlistentry>
   <term>portrange (<type>array</type>)</term>
   <listitem><simpara>Dos números enteros especificando el intervalo de puertos para la salida a intentar</simpara></listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="http.request.options.ssl">
  <title>Opciones de SSL</title>
  <varlistentry>
   <term>
    ssl (<type>array</type>)
   </term>
   <listitem>
    <note>
     <simpara>Las opciones de SSL son establecidas en un array con el sencillo nombre
      de la opción de la petición &quot;ssl&quot;.</simpara>
    </note>
    <variablelist>
     <varlistentry>
      <term>cert (<type>string</type>)</term>
      <listitem><simpara>ruta del certificado</simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>certtype (<type>string</type>)</term>
      <listitem><simpara>tipo de certificado</simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>certpasswd (<type>string</type>)</term>
      <listitem><simpara>contraseña del certificado</simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>key (<type>string</type>)</term>
      <listitem><simpara>ruta de la llave</simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>keytype (<type>string</type>)</term>
      <listitem><simpara>tipo de llave</simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>keypasswd (<type>string</type>)</term>
      <listitem><simpara>contraseña de la llave</simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>engine (<type>string</type>)</term>
      <listitem><simpara>máquina de ssl a emplear</simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>version (<type>int</type>)</term>
      <listitem><simpara>versión de ssl a emplear</simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>verifypeer (<type>bool</type>)</term>
      <listitem><simpara>si se debe verificar la pareja</simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>verifyhost (<type>bool</type>)</term>
      <listitem><simpara>si se debe verificar el host</simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>cipher_list (<type>string</type>)</term>
      <listitem><simpara>lista de claves permitidas</simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>cainfo (<type>string</type>)</term>
      <listitem><simpara></simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>capath (<type>string</type>)</term>
      <listitem><simpara></simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>random_file (<type>string</type>)</term>
      <listitem><simpara></simpara></listitem>
     </varlistentry>
     <varlistentry>
      <term>egdsocket (<type>string</type>)</term>
      <listitem><simpara></simpara></listitem>
     </varlistentry>
    </variablelist>
   </listitem>
  </varlistentry>
 </variablelist>
</appendix>

<!-- 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
-->