php-doc-en/reference/http/reference.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.15 $ -->
<!-- Purpose: basic.php -->
<!-- Membership: pecl -->

<reference id="ref.http">
 <title>HTTP</title>
 <titleabbrev>http</titleabbrev>

 <partintro>
  <sect1 id="http.intro">
   &reftitle.intro;
   <simpara>
    This HTTP extension aims to provide a convenient and powerful
    set of functionality for one of PHPs major applications.
   </simpara>
   <simpara>
    It eases handling of HTTP URLs, dates, redirects, headers and
    messages, provides means for negotiation of clients preferred
    language and charset, as well as a convenient way to send any
    arbitrary data with caching and resuming capabilities.
   </simpara>
   <simpara>
    It provides powerful request functionality, if built with CURL
    support. Parallel requests are available for PHP 5 and greater.
   </simpara>
   <simpara>
    Additionally to the API reference in this manual you can find
    information about how to install and configure as well as
    which global constants are predefined in the following sections:
   </simpara>
   <simplelist>
    <member><link linkend="http.install">Installation</link></member>
    <member><link linkend="http.configuration">Configuration</link></member>
    <member><link linkend="http.constants">Global Constants</link></member>
   </simplelist>
  </sect1>

  <sect1>
   <title>Classes</title>
   <simplelist>
    <member><link linkend="http.HttpMessage"><classname>HttpMessage</classname></link></member>
    <member><link linkend="http.HttpQueryString"><classname>HttpQueryString</classname></link></member>
    <member><link linkend="http.HttpDeflateStream"><classname>HttpDeflateStream</classname></link></member>
    <member><link linkend="http.HttpInflateStream"><classname>HttpInflateStream</classname></link></member>
    <member><link linkend="http.HttpRequest"><classname>HttpRequest</classname></link></member>
    <member><link linkend="http.HttpRequestPool"><classname>HttpRequestPool</classname></link></member>
    <member><link linkend="http.HttpResponse"><classname>HttpResponse</classname></link></member>
   </simplelist>
  </sect1>

  <sect1>
   <title>Functions</title>
   <sect2>
    <title>Built-in Functions</title>
    <simpara>
     Built-in HTTP related functions previously listed on this page can be found in the
     <link linkend="ref.network">networking</link> category.
    </simpara>
    <simpara>
     The following functions do not need the HTTP module to be present:
     <function>header</function>, <function>headers_list</function>, <function>headers_sent</function>,
     <function>setcookie</function> &listendand; <function>setrawcookie</function>.
    </simpara>
   </sect2>
   <sect2>
    <title>Caching</title>
    <simplelist>
     <member><link linkend="function.http-cache-etag"><function>http_cache_etag</function></link></member>
     <member><link linkend="function.http-cache-last-modified"><function>http_cache_last_modified</function></link></member>
    </simplelist>
   </sect2>
   <sect2>
    <title>Encodings</title>
    <simplelist>
     <member><link linkend="function.http-chunked-decode"><function>http_chunked_decode</function></link></member>
     <member><link linkend="function.http-deflate"><function>http_deflate</function></link></member>
     <member><link linkend="function.http-inflate"><function>http_inflate</function></link></member>
    </simplelist>
   </sect2>
   <sect2>
    <title>Miscellaneous</title>
    <simplelist>
     <member><link linkend="function.http-build-cookie"><function>http_build_cookie</function></link></member>
     <member><link linkend="function.http-date"><function>http_date</function></link></member>
     <member><link linkend="function.http-get-request-body-stream"><function>http_get_request_body_stream</function></link></member>
     <member><link linkend="function.http-get-request-body"><function>http_get_request_body</function></link></member>
     <member><link linkend="function.http-get-request-headers"><function>http_get_request_headers</function></link></member>
     <member><link linkend="function.http-match-etag"><function>http_match_etag</function></link></member>
     <member><link linkend="function.http-match-modified"><function>http_match_modified</function></link></member>
     <member><link linkend="function.http-match-request-header"><function>http_match_request_header</function></link></member>
     <member><link linkend="function.http-support"><function>http_support</function></link></member>
    </simplelist>
   </sect2>
   <sect2>
    <title>Negotiation</title>
    <simplelist>
     <member><link linkend="function.http-negotiate-charset"><function>http_negotiate_charset</function></link></member>
     <member><link linkend="function.http-negotiate-content-type"><function>http_negotiate_content_type</function></link></member>
     <member><link linkend="function.http-negotiate-language"><function>http_negotiate_language</function></link></member>
    </simplelist>
   </sect2>
   <sect2>
    <title>Outputhandlers</title>
    <simplelist>
     <member><link linkend="function.ob-deflatehandler"><function>ob_deflatehandler</function></link></member>
     <member><link linkend="function.ob-etaghandler"><function>ob_etaghandler</function></link></member>
     <member><link linkend="function.ob-inflatehandler"><function>ob_inflatehandler</function></link></member>
    </simplelist>
   </sect2>
   <sect2>
    <title>Parsers</title>
    <simplelist>
     <member><link linkend="function.http-parse-cookie"><function>http_parse_cookie</function></link></member>
     <member><link linkend="function.http-parse-headers"><function>http_parse_headers</function></link></member>
     <member><link linkend="function.http-parse-message"><function>http_parse_message</function></link></member>
     <member><link linkend="function.http-parse-params"><function>http_parse_params</function></link></member>
    </simplelist>
   </sect2>
   <sect2>
    <title>Requests</title>
    <simplelist>
     <member><link linkend="function.http-get"><function>http_get</function></link></member>
     <member><link linkend="function.http-head"><function>http_head</function></link></member>
     <member><link linkend="function.http-post-data"><function>http_post_data</function></link></member>
     <member><link linkend="function.http-post-fields"><function>http_post_fields</function></link></member>
     <member><link linkend="function.http-put-data"><function>http_put_data</function></link></member>
     <member><link linkend="function.http-put-file"><function>http_put_file</function></link></member>
     <member><link linkend="function.http-put-stream"><function>http_put_stream</function></link></member>
     <member><link linkend="function.http-request-body-encode"><function>http_request_body_encode</function></link></member>
     <member><link linkend="function.http-request-method-exists"><function>http_request_method_exists</function></link></member>
     <member><link linkend="function.http-request-method-name"><function>http_request_method_name</function></link></member>
     <member><link linkend="function.http-request-method-register"><function>http_request_method_register</function></link></member>
     <member><link linkend="function.http-request-method-unregister"><function>http_request_method_unregister</function></link></member>
     <member><link linkend="function.http-request"><function>http_request</function></link></member>
    </simplelist>
   </sect2>
   <sect2>
    <title>Responses</title>
    <simplelist>
     <member><link linkend="function.http-redirect"><function>http_redirect</function></link></member>
     <member><link linkend="function.http-send-content-disposition"><function>http_send_content_disposition</function></link></member>
     <member><link linkend="function.http-send-content-type"><function>http_send_content_type</function></link></member>
     <member><link linkend="function.http-send-data"><function>http_send_data</function></link></member>
     <member><link linkend="function.http-send-file"><function>http_send_file</function></link></member>
     <member><link linkend="function.http-send-last-modified"><function>http_send_last_modified</function></link></member>
     <member><link linkend="function.http-send-status"><function>http_send_status</function></link></member>
     <member><link linkend="function.http-send-stream"><function>http_send_stream</function></link></member>
     <member><link linkend="function.http-throttle"><function>http_throttle</function></link></member>
    </simplelist>
   </sect2>
   <sect2>
    <title>URLs</title>
    <simplelist>
     <member><link linkend="function.http-build-str"><function>http_build_str</function></link></member>
     <member><link linkend="function.http-build-url"><function>http_build_url</function></link></member>
    </simplelist>
   </sect2>
  </sect1>

 </partintro>

 &reference.http.install;

 &reference.http.configuration;

 <section id="http.resources">
  &reftitle.resources;
  <para>
   This extension defines a stream resource returned by
   <function>http_get_request_body_stream</function> and (thereafter)
   <function>HttpResponse::getStream</function>.
  </para>
 </section>

 &reference.http.constants;
 &reference.http.HttpMessage;
 &reference.http.HttpQueryString;
 &reference.http.HttpDeflateStream;
 &reference.http.HttpInflateStream;
 &reference.http.HttpRequest;
 &reference.http.HttpRequestPool;
 &reference.http.HttpResponse;
 &reference.http.functions;

</reference>

<!-- 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:"../../../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
-->