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

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

<reference xml:id="ref.http" xmlns="http://docbook.org/ns/docbook">
 <title>HTTP</title>
 <titleabbrev>http</titleabbrev>

 <partintro>
  <section xml: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>
    <member><link linkend="http.resources">Resource Types</link></member>
   </simplelist>
  </section>

  <section xml:id="classess.http">
   <title>Classes</title>
   &extension.classes;
   <simpara>
    The <classname>HttpResponse</classname> class requires at least PHP v5.1.
    Any other class is available as of PHP v5.0.
   </simpara>
   <note>
    <simpara>
     Be aware though, that some methods are not available with PHP v5.0.
    </simpara>
   </note>
   <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>
  </section>

  <section xml:id="functions.http">
   <title>Functions</title>
   <section>
    <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>
   </section>
   <section>
    <title>Caching</title>
    <simplelist>
     <member><function>http_cache_etag</function></member>
     <member><function>http_cache_last_modified</function></member>
    </simplelist>
   </section>
   <section>
    <title>Encodings</title>
    <simplelist>
     <member><function>http_chunked_decode</function></member>
     <member><function>http_deflate</function></member>
     <member><function>http_inflate</function></member>
    </simplelist>
   </section>
   <section>
    <title>Miscellaneous</title>
    <simplelist>
     <member><function>http_build_cookie</function></member>
     <member><function>http_date</function></member>
     <member><function>http_get_request_body_stream</function></member>
     <member><function>http_get_request_body</function></member>
     <member><function>http_get_request_headers</function></member>
     <member><function>http_match_etag</function></member>
     <member><function>http_match_modified</function></member>
     <member><function>http_match_request_header</function></member>
     <member><function>http_support</function></member>
    </simplelist>
   </section>
   <section>
    <title>Negotiation</title>
    <simplelist>
     <member><function>http_negotiate_charset</function></member>
     <member><function>http_negotiate_content_type</function></member>
     <member><function>http_negotiate_language</function></member>
    </simplelist>
   </section>
   <section>
    <title>Outputhandlers</title>
    <simplelist>
     <member><function>ob_deflatehandler</function></member>
     <member><function>ob_etaghandler</function></member>
     <member><function>ob_inflatehandler</function></member>
    </simplelist>
   </section>
   <section>
    <title>Parsers</title>
    <simplelist>
     <member><function>http_parse_cookie</function></member>
     <member><function>http_parse_headers</function></member>
     <member><function>http_parse_message</function></member>
     <member><function>http_parse_params</function></member>
    </simplelist>
   </section>
   <section>
    <title>Requests</title>
    <simplelist>
     <member><function>http_get</function></member>
     <member><function>http_head</function></member>
     <member><function>http_post_data</function></member>
     <member><function>http_post_fields</function></member>
     <member><function>http_put_data</function></member>
     <member><function>http_put_file</function></member>
     <member><function>http_put_stream</function></member>
     <member><function>http_request_body_encode</function></member>
     <member><function>http_request_method_exists</function></member>
     <member><function>http_request_method_name</function></member>
     <member><function>http_request_method_register</function></member>
     <member><function>http_request_method_unregister</function></member>
     <member><function>http_request</function></member>
    </simplelist>
   </section>
   <section>
    <title>Responses</title>
    <simplelist>
     <member><function>http_redirect</function></member>
     <member><function>http_send_content_disposition</function></member>
     <member><function>http_send_content_type</function></member>
     <member><function>http_send_data</function></member>
     <member><function>http_send_file</function></member>
     <member><function>http_send_last_modified</function></member>
     <member><function>http_send_status</function></member>
     <member><function>http_send_stream</function></member>
     <member><function>http_throttle</function></member>
    </simplelist>
   </section>
   <section>
    <title>URLs</title>
    <simplelist>
     <member><function>http_build_str</function></member>
     <member><function>http_build_url</function></member>
    </simplelist>
   </section>
   <section>
    <title>Persistent Handles</title>
    <simplelist>
     <member><function>http_persistent_handles_count</function></member>
     <member><function>http_persistent_handles_ident</function></member>
     <member><function>http_persistent_handles_clean</function></member>
    </simplelist>
   </section>
  </section>

 </partintro>

 &reference.http.install;
 &reference.http.configuration;
 &reference.http.resources;
 &reference.http.constants;
 &reference.http.request-options;
 &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
-->