cvs: peardoc /en/package http.xml /en/package/http http-client.xml /en/package/http/http-client/http-client attach.xml currentresponse.xml
detach.xml get.xml head.xml http_client.xml post.xml reset.xml setdefaultheader.xml setmaxredirects.xml setrequestparameter.xml
/en/package/http/http-client/http-client-cookiemanager addcookie.xml http_client_cookiemanager.xml passcookies.xml reset.xml updatecookies.xml
| From: | Alexey Borzov | Date: | Wed, 21 Jan 2004 21:13:58 +0000 |
| Subject: | cvs: peardoc /en/package http.xml /en/package/http http-client.xml /en/package/http/http-client/http-client attach.xml currentresponse.xml detach.xml get.xml head.xml http_client.xml post.xml reset.xml setdefaultheader.xml setmaxredirects.xml setrequestparameter.xml /en/package/http/http-client/http-client-cookiemanager addcookie.xml http_client_cookiemanager.xml passcookies.xml reset.xml updatecookies.xml |
||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-2145@lists.php.net to get a copy of this message | ||
avb Wed Jan 21 16:13:58 2004 EDT
Added files:
/peardoc/en/package/http http-client.xml
/peardoc/en/package/http/http-client/http-client attach.xml
currentresponse.xml
detach.xml get.xml
head.xml
http_client.xml
post.xml reset.xml
setdefaultheader.xml
setmaxredirects.xml
setrequestparameter.xml
/peardoc/en/package/http/http-client/http-client-cookiemanager
addcookie.xml
http_client_cookiemanager.xml
passcookies.xml
reset.xml
updatecookies.xml
Modified files:
/peardoc/en/package http.xml
Log:
docs for HTTP_Client package
http://cvs.php.net/diff.php/peardoc/en/package/http.xml?r1=1.4&r2=1.5&ty=u Index: peardoc/en/package/http.xml diff -u peardoc/en/package/http.xml:1.4 peardoc/en/package/http.xml:1.5 --- peardoc/en/package/http.xml:1.4 Tue Oct 14 18:54:04 2003 +++ peardoc/en/package/http.xml Wed Jan 21 16:13:49 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <chapter id="package.http"> <title>HTTP</title> @@ -9,6 +9,7 @@ </para> &package.http.http; + &package.http.http-client; &package.http.http-compress; &package.http.http-download; http://cvs.php.net/co.php/peardoc/en/package/http/http-client.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client.xml +++ peardoc/en/package/http/http-client.xml <!-- $Revision: 1.1 $ --> <sect1 id="package.http.http-client"> <title>HTTP_Client</title> <refentry id="package.http.http-client.http-client-summary"> <refnamediv> <refname>Class Summary <classname>HTTP_Client</classname></refname> <refpurpose>A simple HTTP client class.</refpurpose> </refnamediv> <refsect1> <title><classname>HTTP_Client</classname></title> <para>A simple HTTP client class. The class wraps around <classname>HTTP_Request</classname> providing a higher-level API for performing multiple HTTP requests. It handles HTTP redirects, stores cookies and sets referrers between requests.</para> </refsect1> <refsect1> <title>Class Trees for <classname>HTTP_Client</classname></title> <para> <itemizedlist> <listitem><para> HTTP_Client </para></listitem> </itemizedlist> </para> </refsect1> </refentry> &package.http.http-client.http-client.http-client; &package.http.http-client.http-client.attach; &package.http.http-client.http-client.currentresponse; &package.http.http-client.http-client.detach; &package.http.http-client.http-client.get; &package.http.http-client.http-client.head; &package.http.http-client.http-client.post; &package.http.http-client.http-client.reset; &package.http.http-client.http-client.setdefaultheader; &package.http.http-client.http-client.setmaxredirects; &package.http.http-client.http-client.setrequestparameter; <refentry id="package.http.http-client.http-client-cookiemanager-summary"> <refnamediv> <refname>Class Summary <classname>HTTP_Client_CookieManager</classname></refname> <refpurpose>Stores cookies and passes them between HTTP requests.</refpurpose> </refnamediv> <refsect1> <title><classname>HTTP_Client_CookieManager</classname></title> <para>Stores cookies and passes them between HTTP requests. While this class is a part of <classname>HTTP_Client</classname> package, it <emphasis>can</emphasis> be used separately.</para> </refsect1> <refsect1> <title>Class Trees for <classname>HTTP_Client_CookieManager</classname></title> <para> <itemizedlist> <listitem><para> HTTP_Client_CookieManager </para></listitem> </itemizedlist> </para> </refsect1> </refentry> &package.http.http-client.http-client-cookiemanager.http-client-cookiemanager; &package.http.http-client.http-client-cookiemanager.addcookie; &package.http.http-client.http-client-cookiemanager.passcookies; &package.http.http-client.http-client-cookiemanager.reset; &package.http.http-client.http-client-cookiemanager.updatecookies; </sect1> <!-- Generated by phpDocumentor v 1.2.3 http://www.phpdoc.org --> <!-- 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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/attach.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/attach.xml +++ peardoc/en/package/http/http-client/http-client/attach.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.attach"> <refnamediv> <refname>HTTP_Client::attach()</refname> <refpurpose>Adds a <classname>Listener</classname> to the list of listeners that are notified of the object's events</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>boolean <function>HTTP_Client::attach</function></funcdef> <paramdef>object HTTP_Request_Listener <parameter>&$listener</parameter></paramdef> <paramdef>boolean <parameter> <optional>$propagate = &false;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.attach.desc"> &title.desc; <para> The attached Listeners are notified of the following events: <variablelist> <varlistentry> <term><literal>'request'</literal></term> <listitem><simpara>sent before a HTTP request that is not a result of previous redirect.</simpara></listitem> </varlistentry> <varlistentry> <term><literal>'httpSuccess'</literal></term> <listitem><simpara>sent upon receiving a successfull 2xx response (or 3xx response, if it is not a redirect or if redirect processing is disabled).</simpara></listitem> </varlistentry> <varlistentry> <term><literal>'httpRedirect'</literal></term> <listitem><simpara>sent when a 3xx redirection response is received, before following a redirect</simpara></listitem> </varlistentry> <varlistentry> <term><literal>'httpError'</literal></term> <listitem><simpara>sent on 4xx, 5xx response</simpara></listitem> </varlistentry> </variablelist> If <parameter>$propagate</parameter> is &true; the Listener will be attached to the created <classname>HTTP_Request</classname> objects and will be notified of their events as well. </para> </refsect1> <refsect1 id="package.http.http-client.http-client.attach.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.object; <classname>HTTP_Request_Listener</classname> <parameter>&$listener</parameter> </term> <listitem> <para> Listener instance to attach </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.bool; <parameter>$propagate</parameter> </term> <listitem> <para> Whether the listener should be attached to the created <classname>HTTP_Request</classname> objects </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.attach.returns"> &title.returns; <para> <emphasis>returns</emphasis> whether the listener was successfully attached </para> </refsect1> <refsect1 id="package.http.http-client.http-client.attach.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.attach.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.http.http-client.http-client.detach"><function>detach</function></link> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.attach.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/currentresponse.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/currentresponse.xml +++ peardoc/en/package/http/http-client/http-client/currentresponse.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.currentresponse"> <refnamediv> <refname>HTTP_Client::currentResponse()</refname> <refpurpose>Returns the most recent HTTP response</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>array& <function>HTTP_Client::currentResponse</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.currentresponse.desc"> &title.desc; <para>The returned array has the following keys: <literal>'code'</literal>, <literal>'headers'</literal>, <literal>'body'</literal>.</para> </refsect1> <refsect1 id="package.http.http-client.http-client.currentresponse.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.currentresponse.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/detach.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/detach.xml +++ peardoc/en/package/http/http-client/http-client/detach.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.detach"> <refnamediv> <refname>HTTP_Client::detach()</refname> <refpurpose>Removes a <classname>Listener</classname> from the list of listeners</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>boolean <function>HTTP_Client::detach</function></funcdef> <paramdef>object HTTP_Request_Listener <parameter>&$listener</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.detach.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client.detach.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.object; <classname>HTTP_Request_Listener</classname> <parameter>&$listener</parameter> </term> <listitem> <para> Listener instance to detach </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.detach.returns"> &title.returns; <para> <emphasis>returns</emphasis> whether the listener was successfully detached </para> </refsect1> <refsect1 id="package.http.http-client.http-client.detach.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.detach.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.http.http-client.http-client.attach"><function>attach</function></link> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.detach.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/get.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/get.xml +++ peardoc/en/package/http/http-client/http-client/get.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.get"> <refnamediv> <refname>HTTP_Client::get()</refname> <refpurpose>Sends a 'GET' HTTP request</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>integer <function>HTTP_Client::get</function></funcdef> <paramdef>string <parameter>$url</parameter></paramdef> <paramdef>mixed <parameter> <optional>$data = &null;</optional></parameter></paramdef> <paramdef>boolean <parameter> <optional>$preEncoded = &false;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.get.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client.get.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$url</parameter> </term> <listitem> <para> URL </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$data</parameter> </term> <listitem> <para> additional data to send </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.bool; <parameter>$preEncoded</parameter> </term> <listitem> <para> Whether the data is already urlencoded </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.get.returns"> &title.returns; <para> <emphasis>returns</emphasis> HTTP response code </para> </refsect1> <refsect1 id="package.http.http-client.http-client.get.throws"> &title.throws; <para> <emphasis>throws</emphasis> PEAR_Error </para> </refsect1> <refsect1 id="package.http.http-client.http-client.get.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/head.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/head.xml +++ peardoc/en/package/http/http-client/http-client/head.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.head"> <refnamediv> <refname>HTTP_Client::head()</refname> <refpurpose>Sends a 'HEAD' HTTP request</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>integer <function>HTTP_Client::head</function></funcdef> <paramdef>string <parameter>$url</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.head.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client.head.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$url</parameter> </term> <listitem> <para> URL </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.head.returns"> &title.returns; <para> <emphasis>returns</emphasis> HTTP response code </para> </refsect1> <refsect1 id="package.http.http-client.http-client.head.throws"> &title.throws; <para> <emphasis>throws</emphasis> PEAR_Error </para> </refsect1> <refsect1 id="package.http.http-client.http-client.head.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/http_client.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/http_client.xml +++ peardoc/en/package/http/http-client/http-client/http_client.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.http-client"> <refnamediv> <refname>constructor HTTP_Client::HTTP_Client()</refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void constructor <function>HTTP_Client::HTTP_Client</function></funcdef> <paramdef>array <parameter> <optional>$defaultRequestParams = &null;</optional></parameter></paramdef> <paramdef>array <parameter> <optional>$defaultHeaders = &null;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.http-client.desc"> &title.desc; <para>Sets default request parameters and default headers.</para> </refsect1> <refsect1 id="package.http.http-client.http-client.http-client.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.array; <parameter>$defaultRequestParams</parameter> </term> <listitem> <para> Parameters to pass to <classname>HTTP_Request</classname>'s constructor </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.array; <parameter>$defaultHeaders</parameter> </term> <listitem> <para> Default headers to send on every request </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.http-client.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.http-client.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.http.http-client.http-client.setdefaultheader"><function>setDefaultHeader</function></link>, <link linkend="package.http.http-client.http-client.setrequestparameter"><function>setRequestParameter</function></link> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.http-client.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/post.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/post.xml +++ peardoc/en/package/http/http-client/http-client/post.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.post"> <refnamediv> <refname>HTTP_Client::post()</refname> <refpurpose>Sends a 'POST' HTTP request</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>integer <function>HTTP_Client::post</function></funcdef> <paramdef>string <parameter>$url</parameter></paramdef> <paramdef>mixed <parameter>$data</parameter></paramdef> <paramdef>boolean <parameter> <optional>$preEncoded = &false;</optional></parameter></paramdef> <paramdef>array <parameter> <optional>$files = array()</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.post.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client.post.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$url</parameter> </term> <listitem> <para> URL </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$data</parameter> </term> <listitem> <para> Data to send </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.bool; <parameter>$preEncoded</parameter> </term> <listitem> <para> Whether the data is already urlencoded </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.array; <parameter>$files</parameter> </term> <listitem> <para> Files to upload. Elements of the array should have the form: array(name, filename(s)[, content type]), see <function>HTTP_Request::addFile</function> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.post.returns"> &title.returns; <para> <emphasis>returns</emphasis> HTTP response code </para> </refsect1> <refsect1 id="package.http.http-client.http-client.post.throws"> &title.throws; <para> <emphasis>throws</emphasis> PEAR_Error </para> </refsect1> <refsect1 id="package.http.http-client.http-client.post.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/reset.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/reset.xml +++ peardoc/en/package/http/http-client/http-client/reset.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.reset"> <refnamediv> <refname>HTTP_Client::reset()</refname> <refpurpose>Clears object's internal properties</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client::reset</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.reset.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client.reset.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.reset.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/setdefaultheader.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/setdefaultheader.xml +++ peardoc/en/package/http/http-client/http-client/setdefaultheader.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.setdefaultheader"> <refnamediv> <refname>HTTP_Client::setDefaultHeader()</refname> <refpurpose>Sets default header(s) for HTTP requests</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client::setDefaultHeader</function></funcdef> <paramdef>mixed <parameter>$name</parameter></paramdef> <paramdef>string <parameter> <optional>$value = &null;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.setdefaultheader.desc"> &title.desc; <para>These are standard HTTP headers that will be sent by all created <classname>HTTP_Request</classname> objects.</para> </refsect1> <refsect1 id="package.http.http-client.http-client.setdefaultheader.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$name</parameter> </term> <listitem> <para> header name or array ('header name' => 'header value') </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$value</parameter> </term> <listitem> <para> header value if $name is not an array </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.setdefaultheader.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.setdefaultheader.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/setmaxredirects.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/setmaxredirects.xml +++ peardoc/en/package/http/http-client/http-client/setmaxredirects.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.setmaxredirects"> <refnamediv> <refname>HTTP_Client::setMaxRedirects()</refname> <refpurpose>Sets the maximum number of redirects that will be processed.</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client::setMaxRedirects</function></funcdef> <paramdef>int <parameter>$value</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.setmaxredirects.desc"> &title.desc; <para>Setting this value to 0 disables redirect processing. If it is not 0 and the number of redirects after a request is bigger than this number, then an error will be raised.</para> </refsect1> <refsect1 id="package.http.http-client.http-client.setmaxredirects.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$value</parameter> </term> <listitem> <para> Max number of redirects to process </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.setmaxredirects.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.setmaxredirects.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/setrequestparameter.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/setrequestparameter.xml +++ peardoc/en/package/http/http-client/http-client/setrequestparameter.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.setrequestparameter"> <refnamediv> <refname>HTTP_Client::setRequestParameter()</refname> <refpurpose>Sets parameter(s) for HTTP requests</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client::setRequestParameter</function></funcdef> <paramdef>mixed <parameter>$name</parameter></paramdef> <paramdef>string <parameter> <optional>$value = &null;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.setrequestparameter.desc"> &title.desc; <para>These parameters will be passed to constructors of created <classname>HTTP_Request</classname> instances.</para> </refsect1> <refsect1 id="package.http.http-client.http-client.setrequestparameter.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$name</parameter> </term> <listitem> <para> parameter name or array ('parameter name' => 'parameter value') </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$value</parameter> </term> <listitem> <para> parameter value if $name is not an array </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.setrequestparameter.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.setrequestparameter.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client-cookiemanager/addcookie.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client-cookiemanager/addcookie.xml +++ peardoc/en/package/http/http-client/http-client-cookiemanager/addcookie.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client-cookiemanager.addcookie"> <refnamediv> <refname>HTTP_Client_CookieManager::addCookie()</refname> <refpurpose>Explicitly adds cookie to the list</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ClientCookieManager.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client_CookieManager::addCookie</function></funcdef> <paramdef>array <parameter>$cookie</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client-cookiemanager.addcookie.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.addcookie.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.array; <parameter>$cookie</parameter> </term> <listitem> <para> An array representing cookie, this function expects all of the array's fields (<literal>'name'</literal>, <literal>'value'</literal>, <literal>'domain'</literal>, <literal>'path'</literal>, <literal>'expires'</literal>, <literal>'secure'</literal>) to be set. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.addcookie.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.addcookie.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client-cookiemanager/http_client_cookiemanager.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client-cookiemanager/http_client_cookiemanager.xml +++ peardoc/en/package/http/http-client/http-client-cookiemanager/http_client_cookiemanager.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client-cookiemanager.http-client-cookiemanager"> <refnamediv> <refname>constructor HTTP_Client_CookieManager::HTTP_Client_CookieManager()</refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client/CookieManager.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void constructor <function>HTTP_Client_CookieManager::HTTP_Client_CookieManager</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client-cookiemanager.http-client-cookiemanager.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.http-client-cookiemanager.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.http-client-cookiemanager.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client-cookiemanager/passcookies.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client-cookiemanager/passcookies.xml +++ peardoc/en/package/http/http-client/http-client-cookiemanager/passcookies.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client-cookiemanager.passcookies"> <refnamediv> <refname>HTTP_Client_CookieManager::passCookies()</refname> <refpurpose>Adds cookies to the request</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client/CookieManager.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client_CookieManager::passCookies</function></funcdef> <paramdef>object An <parameter>&$request</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client-cookiemanager.passcookies.desc"> &title.desc; <para> The method sends only the cookies that <emphasis>should</emphasis> be sent with the request and it adds them in right order. </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.passcookies.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.object; <classname>HTTP_Request</classname> <parameter>&$request</parameter> </term> <listitem> <para> <classname>HTTP_Request</classname> object </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.passcookies.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.passcookies.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.http.http-client.http-client-cookiemanager.updatecookies"><function>updateCookies</function></link>, <link linkend="package.http.http-client.http-client-cookiemanager.addcookie"><function>addCookie</function></link> </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.passcookies.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client-cookiemanager/reset.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client-cookiemanager/reset.xml +++ peardoc/en/package/http/http-client/http-client-cookiemanager/reset.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client-cookiemanager.reset"> <refnamediv> <refname>HTTP_Client_CookieManager::reset()</refname> <refpurpose>Clears the cookies list</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client/CookieManager.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client_CookieManager::reset</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client-cookiemanager.reset.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.reset.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.reset.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client-cookiemanager/updatecookies.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client-cookiemanager/updatecookies.xml +++ peardoc/en/package/http/http-client/http-client-cookiemanager/updatecookies.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client-cookiemanager.updatecookies"> <refnamediv> <refname>HTTP_Client_CookieManager::updateCookies()</refname> <refpurpose>Updates cookie list from HTTP server response</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client/CookieManager.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client_CookieManager::updateCookies</function></funcdef> <paramdef>object HTTP_Request <parameter>&$request</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client-cookiemanager.updatecookies.desc"> &title.desc; <para>This method gets the cookies from HTTP response received by <classname>HTTP_Request</classname> instance and adds them to the object's internal list.</para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.updatecookies.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.object; <classname>HTTP_Request</classname> <parameter>&$request</parameter> </term> <listitem> <para> <classname>HTTP_Request</classname> object containing the HTTP response, i.e. its <function>sendRequest</function> should already be called. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.updatecookies.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.updatecookies.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.http.http-client.http-client-cookiemanager.passcookies"><function>passCookies</function></link>, <link linkend="package.http.http-client.http-client-cookiemanager.addcookie"><function>addCookie</function></link> </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.updatecookies.note"> &title.note; ¬e.notstatic; </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 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 -->
http://cvs.php.net/diff.php/peardoc/en/package/http.xml?r1=1.4&r2=1.5&ty=u Index: peardoc/en/package/http.xml diff -u peardoc/en/package/http.xml:1.4 peardoc/en/package/http.xml:1.5 --- peardoc/en/package/http.xml:1.4 Tue Oct 14 18:54:04 2003 +++ peardoc/en/package/http.xml Wed Jan 21 16:13:49 2004 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <chapter id="package.http"> <title>HTTP</title> @@ -9,6 +9,7 @@ </para> &package.http.http; + &package.http.http-client; &package.http.http-compress; &package.http.http-download; http://cvs.php.net/co.php/peardoc/en/package/http/http-client.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client.xml +++ peardoc/en/package/http/http-client.xml <!-- $Revision: 1.1 $ --> <sect1 id="package.http.http-client"> <title>HTTP_Client</title> <refentry id="package.http.http-client.http-client-summary"> <refnamediv> <refname>Class Summary <classname>HTTP_Client</classname></refname> <refpurpose>A simple HTTP client class.</refpurpose> </refnamediv> <refsect1> <title><classname>HTTP_Client</classname></title> <para>A simple HTTP client class. The class wraps around <classname>HTTP_Request</classname> providing a higher-level API for performing multiple HTTP requests. It handles HTTP redirects, stores cookies and sets referrers between requests.</para> </refsect1> <refsect1> <title>Class Trees for <classname>HTTP_Client</classname></title> <para> <itemizedlist> <listitem><para> HTTP_Client </para></listitem> </itemizedlist> </para> </refsect1> </refentry> &package.http.http-client.http-client.http-client; &package.http.http-client.http-client.attach; &package.http.http-client.http-client.currentresponse; &package.http.http-client.http-client.detach; &package.http.http-client.http-client.get; &package.http.http-client.http-client.head; &package.http.http-client.http-client.post; &package.http.http-client.http-client.reset; &package.http.http-client.http-client.setdefaultheader; &package.http.http-client.http-client.setmaxredirects; &package.http.http-client.http-client.setrequestparameter; <refentry id="package.http.http-client.http-client-cookiemanager-summary"> <refnamediv> <refname>Class Summary <classname>HTTP_Client_CookieManager</classname></refname> <refpurpose>Stores cookies and passes them between HTTP requests.</refpurpose> </refnamediv> <refsect1> <title><classname>HTTP_Client_CookieManager</classname></title> <para>Stores cookies and passes them between HTTP requests. While this class is a part of <classname>HTTP_Client</classname> package, it <emphasis>can</emphasis> be used separately.</para> </refsect1> <refsect1> <title>Class Trees for <classname>HTTP_Client_CookieManager</classname></title> <para> <itemizedlist> <listitem><para> HTTP_Client_CookieManager </para></listitem> </itemizedlist> </para> </refsect1> </refentry> &package.http.http-client.http-client-cookiemanager.http-client-cookiemanager; &package.http.http-client.http-client-cookiemanager.addcookie; &package.http.http-client.http-client-cookiemanager.passcookies; &package.http.http-client.http-client-cookiemanager.reset; &package.http.http-client.http-client-cookiemanager.updatecookies; </sect1> <!-- Generated by phpDocumentor v 1.2.3 http://www.phpdoc.org --> <!-- 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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/attach.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/attach.xml +++ peardoc/en/package/http/http-client/http-client/attach.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.attach"> <refnamediv> <refname>HTTP_Client::attach()</refname> <refpurpose>Adds a <classname>Listener</classname> to the list of listeners that are notified of the object's events</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>boolean <function>HTTP_Client::attach</function></funcdef> <paramdef>object HTTP_Request_Listener <parameter>&$listener</parameter></paramdef> <paramdef>boolean <parameter> <optional>$propagate = &false;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.attach.desc"> &title.desc; <para> The attached Listeners are notified of the following events: <variablelist> <varlistentry> <term><literal>'request'</literal></term> <listitem><simpara>sent before a HTTP request that is not a result of previous redirect.</simpara></listitem> </varlistentry> <varlistentry> <term><literal>'httpSuccess'</literal></term> <listitem><simpara>sent upon receiving a successfull 2xx response (or 3xx response, if it is not a redirect or if redirect processing is disabled).</simpara></listitem> </varlistentry> <varlistentry> <term><literal>'httpRedirect'</literal></term> <listitem><simpara>sent when a 3xx redirection response is received, before following a redirect</simpara></listitem> </varlistentry> <varlistentry> <term><literal>'httpError'</literal></term> <listitem><simpara>sent on 4xx, 5xx response</simpara></listitem> </varlistentry> </variablelist> If <parameter>$propagate</parameter> is &true; the Listener will be attached to the created <classname>HTTP_Request</classname> objects and will be notified of their events as well. </para> </refsect1> <refsect1 id="package.http.http-client.http-client.attach.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.object; <classname>HTTP_Request_Listener</classname> <parameter>&$listener</parameter> </term> <listitem> <para> Listener instance to attach </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.bool; <parameter>$propagate</parameter> </term> <listitem> <para> Whether the listener should be attached to the created <classname>HTTP_Request</classname> objects </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.attach.returns"> &title.returns; <para> <emphasis>returns</emphasis> whether the listener was successfully attached </para> </refsect1> <refsect1 id="package.http.http-client.http-client.attach.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.attach.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.http.http-client.http-client.detach"><function>detach</function></link> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.attach.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/currentresponse.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/currentresponse.xml +++ peardoc/en/package/http/http-client/http-client/currentresponse.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.currentresponse"> <refnamediv> <refname>HTTP_Client::currentResponse()</refname> <refpurpose>Returns the most recent HTTP response</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>array& <function>HTTP_Client::currentResponse</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.currentresponse.desc"> &title.desc; <para>The returned array has the following keys: <literal>'code'</literal>, <literal>'headers'</literal>, <literal>'body'</literal>.</para> </refsect1> <refsect1 id="package.http.http-client.http-client.currentresponse.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.currentresponse.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/detach.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/detach.xml +++ peardoc/en/package/http/http-client/http-client/detach.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.detach"> <refnamediv> <refname>HTTP_Client::detach()</refname> <refpurpose>Removes a <classname>Listener</classname> from the list of listeners</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>boolean <function>HTTP_Client::detach</function></funcdef> <paramdef>object HTTP_Request_Listener <parameter>&$listener</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.detach.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client.detach.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.object; <classname>HTTP_Request_Listener</classname> <parameter>&$listener</parameter> </term> <listitem> <para> Listener instance to detach </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.detach.returns"> &title.returns; <para> <emphasis>returns</emphasis> whether the listener was successfully detached </para> </refsect1> <refsect1 id="package.http.http-client.http-client.detach.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.detach.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.http.http-client.http-client.attach"><function>attach</function></link> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.detach.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/get.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/get.xml +++ peardoc/en/package/http/http-client/http-client/get.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.get"> <refnamediv> <refname>HTTP_Client::get()</refname> <refpurpose>Sends a 'GET' HTTP request</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>integer <function>HTTP_Client::get</function></funcdef> <paramdef>string <parameter>$url</parameter></paramdef> <paramdef>mixed <parameter> <optional>$data = &null;</optional></parameter></paramdef> <paramdef>boolean <parameter> <optional>$preEncoded = &false;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.get.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client.get.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$url</parameter> </term> <listitem> <para> URL </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$data</parameter> </term> <listitem> <para> additional data to send </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.bool; <parameter>$preEncoded</parameter> </term> <listitem> <para> Whether the data is already urlencoded </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.get.returns"> &title.returns; <para> <emphasis>returns</emphasis> HTTP response code </para> </refsect1> <refsect1 id="package.http.http-client.http-client.get.throws"> &title.throws; <para> <emphasis>throws</emphasis> PEAR_Error </para> </refsect1> <refsect1 id="package.http.http-client.http-client.get.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/head.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/head.xml +++ peardoc/en/package/http/http-client/http-client/head.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.head"> <refnamediv> <refname>HTTP_Client::head()</refname> <refpurpose>Sends a 'HEAD' HTTP request</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>integer <function>HTTP_Client::head</function></funcdef> <paramdef>string <parameter>$url</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.head.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client.head.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$url</parameter> </term> <listitem> <para> URL </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.head.returns"> &title.returns; <para> <emphasis>returns</emphasis> HTTP response code </para> </refsect1> <refsect1 id="package.http.http-client.http-client.head.throws"> &title.throws; <para> <emphasis>throws</emphasis> PEAR_Error </para> </refsect1> <refsect1 id="package.http.http-client.http-client.head.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/http_client.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/http_client.xml +++ peardoc/en/package/http/http-client/http-client/http_client.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.http-client"> <refnamediv> <refname>constructor HTTP_Client::HTTP_Client()</refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void constructor <function>HTTP_Client::HTTP_Client</function></funcdef> <paramdef>array <parameter> <optional>$defaultRequestParams = &null;</optional></parameter></paramdef> <paramdef>array <parameter> <optional>$defaultHeaders = &null;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.http-client.desc"> &title.desc; <para>Sets default request parameters and default headers.</para> </refsect1> <refsect1 id="package.http.http-client.http-client.http-client.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.array; <parameter>$defaultRequestParams</parameter> </term> <listitem> <para> Parameters to pass to <classname>HTTP_Request</classname>'s constructor </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.array; <parameter>$defaultHeaders</parameter> </term> <listitem> <para> Default headers to send on every request </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.http-client.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.http-client.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.http.http-client.http-client.setdefaultheader"><function>setDefaultHeader</function></link>, <link linkend="package.http.http-client.http-client.setrequestparameter"><function>setRequestParameter</function></link> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.http-client.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/post.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/post.xml +++ peardoc/en/package/http/http-client/http-client/post.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.post"> <refnamediv> <refname>HTTP_Client::post()</refname> <refpurpose>Sends a 'POST' HTTP request</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>integer <function>HTTP_Client::post</function></funcdef> <paramdef>string <parameter>$url</parameter></paramdef> <paramdef>mixed <parameter>$data</parameter></paramdef> <paramdef>boolean <parameter> <optional>$preEncoded = &false;</optional></parameter></paramdef> <paramdef>array <parameter> <optional>$files = array()</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.post.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client.post.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.string; <parameter>$url</parameter> </term> <listitem> <para> URL </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$data</parameter> </term> <listitem> <para> Data to send </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.bool; <parameter>$preEncoded</parameter> </term> <listitem> <para> Whether the data is already urlencoded </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.array; <parameter>$files</parameter> </term> <listitem> <para> Files to upload. Elements of the array should have the form: array(name, filename(s)[, content type]), see <function>HTTP_Request::addFile</function> </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.post.returns"> &title.returns; <para> <emphasis>returns</emphasis> HTTP response code </para> </refsect1> <refsect1 id="package.http.http-client.http-client.post.throws"> &title.throws; <para> <emphasis>throws</emphasis> PEAR_Error </para> </refsect1> <refsect1 id="package.http.http-client.http-client.post.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/reset.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/reset.xml +++ peardoc/en/package/http/http-client/http-client/reset.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.reset"> <refnamediv> <refname>HTTP_Client::reset()</refname> <refpurpose>Clears object's internal properties</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client::reset</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.reset.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client.reset.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.reset.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/setdefaultheader.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/setdefaultheader.xml +++ peardoc/en/package/http/http-client/http-client/setdefaultheader.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.setdefaultheader"> <refnamediv> <refname>HTTP_Client::setDefaultHeader()</refname> <refpurpose>Sets default header(s) for HTTP requests</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client::setDefaultHeader</function></funcdef> <paramdef>mixed <parameter>$name</parameter></paramdef> <paramdef>string <parameter> <optional>$value = &null;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.setdefaultheader.desc"> &title.desc; <para>These are standard HTTP headers that will be sent by all created <classname>HTTP_Request</classname> objects.</para> </refsect1> <refsect1 id="package.http.http-client.http-client.setdefaultheader.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$name</parameter> </term> <listitem> <para> header name or array ('header name' => 'header value') </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$value</parameter> </term> <listitem> <para> header value if $name is not an array </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.setdefaultheader.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.setdefaultheader.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/setmaxredirects.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/setmaxredirects.xml +++ peardoc/en/package/http/http-client/http-client/setmaxredirects.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.setmaxredirects"> <refnamediv> <refname>HTTP_Client::setMaxRedirects()</refname> <refpurpose>Sets the maximum number of redirects that will be processed.</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client::setMaxRedirects</function></funcdef> <paramdef>int <parameter>$value</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.setmaxredirects.desc"> &title.desc; <para>Setting this value to 0 disables redirect processing. If it is not 0 and the number of redirects after a request is bigger than this number, then an error will be raised.</para> </refsect1> <refsect1 id="package.http.http-client.http-client.setmaxredirects.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.int; <parameter>$value</parameter> </term> <listitem> <para> Max number of redirects to process </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.setmaxredirects.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.setmaxredirects.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client/setrequestparameter.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client/setrequestparameter.xml +++ peardoc/en/package/http/http-client/http-client/setrequestparameter.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client.setrequestparameter"> <refnamediv> <refname>HTTP_Client::setRequestParameter()</refname> <refpurpose>Sets parameter(s) for HTTP requests</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client::setRequestParameter</function></funcdef> <paramdef>mixed <parameter>$name</parameter></paramdef> <paramdef>string <parameter> <optional>$value = &null;</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client.setrequestparameter.desc"> &title.desc; <para>These parameters will be passed to constructors of created <classname>HTTP_Request</classname> instances.</para> </refsect1> <refsect1 id="package.http.http-client.http-client.setrequestparameter.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$name</parameter> </term> <listitem> <para> parameter name or array ('parameter name' => 'parameter value') </para> </listitem> </varlistentry> </variablelist> <variablelist> <varlistentry> <term> &type.string; <parameter>$value</parameter> </term> <listitem> <para> parameter value if $name is not an array </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client.setrequestparameter.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client.setrequestparameter.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client-cookiemanager/addcookie.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client-cookiemanager/addcookie.xml +++ peardoc/en/package/http/http-client/http-client-cookiemanager/addcookie.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client-cookiemanager.addcookie"> <refnamediv> <refname>HTTP_Client_CookieManager::addCookie()</refname> <refpurpose>Explicitly adds cookie to the list</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'ClientCookieManager.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client_CookieManager::addCookie</function></funcdef> <paramdef>array <parameter>$cookie</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client-cookiemanager.addcookie.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.addcookie.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.array; <parameter>$cookie</parameter> </term> <listitem> <para> An array representing cookie, this function expects all of the array's fields (<literal>'name'</literal>, <literal>'value'</literal>, <literal>'domain'</literal>, <literal>'path'</literal>, <literal>'expires'</literal>, <literal>'secure'</literal>) to be set. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.addcookie.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.addcookie.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client-cookiemanager/http_client_cookiemanager.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client-cookiemanager/http_client_cookiemanager.xml +++ peardoc/en/package/http/http-client/http-client-cookiemanager/http_client_cookiemanager.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client-cookiemanager.http-client-cookiemanager"> <refnamediv> <refname>constructor HTTP_Client_CookieManager::HTTP_Client_CookieManager()</refname> <refpurpose>Constructor</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client/CookieManager.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void constructor <function>HTTP_Client_CookieManager::HTTP_Client_CookieManager</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client-cookiemanager.http-client-cookiemanager.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.http-client-cookiemanager.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.http-client-cookiemanager.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client-cookiemanager/passcookies.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client-cookiemanager/passcookies.xml +++ peardoc/en/package/http/http-client/http-client-cookiemanager/passcookies.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client-cookiemanager.passcookies"> <refnamediv> <refname>HTTP_Client_CookieManager::passCookies()</refname> <refpurpose>Adds cookies to the request</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client/CookieManager.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client_CookieManager::passCookies</function></funcdef> <paramdef>object An <parameter>&$request</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client-cookiemanager.passcookies.desc"> &title.desc; <para> The method sends only the cookies that <emphasis>should</emphasis> be sent with the request and it adds them in right order. </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.passcookies.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.object; <classname>HTTP_Request</classname> <parameter>&$request</parameter> </term> <listitem> <para> <classname>HTTP_Request</classname> object </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.passcookies.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.passcookies.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.http.http-client.http-client-cookiemanager.updatecookies"><function>updateCookies</function></link>, <link linkend="package.http.http-client.http-client-cookiemanager.addcookie"><function>addCookie</function></link> </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.passcookies.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client-cookiemanager/reset.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client-cookiemanager/reset.xml +++ peardoc/en/package/http/http-client/http-client-cookiemanager/reset.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client-cookiemanager.reset"> <refnamediv> <refname>HTTP_Client_CookieManager::reset()</refname> <refpurpose>Clears the cookies list</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client/CookieManager.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client_CookieManager::reset</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client-cookiemanager.reset.desc"> &title.desc; ¬documented; </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.reset.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.reset.note"> &title.note; ¬e.notstatic; </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 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 --> http://cvs.php.net/co.php/peardoc/en/package/http/http-client/http-client-cookiemanager/updatecookies.xml?r=1.1&p=1 Index: peardoc/en/package/http/http-client/http-client-cookiemanager/updatecookies.xml +++ peardoc/en/package/http/http-client/http-client-cookiemanager/updatecookies.xml <!-- $Revision: 1.1 $ --> <refentry id="package.http.http-client.http-client-cookiemanager.updatecookies"> <refnamediv> <refname>HTTP_Client_CookieManager::updateCookies()</refname> <refpurpose>Updates cookie list from HTTP server response</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'HTTP/Client/CookieManager.php'; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>HTTP_Client_CookieManager::updateCookies</function></funcdef> <paramdef>object HTTP_Request <parameter>&$request</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.http.http-client.http-client-cookiemanager.updatecookies.desc"> &title.desc; <para>This method gets the cookies from HTTP response received by <classname>HTTP_Request</classname> instance and adds them to the object's internal list.</para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.updatecookies.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.object; <classname>HTTP_Request</classname> <parameter>&$request</parameter> </term> <listitem> <para> <classname>HTTP_Request</classname> object containing the HTTP response, i.e. its <function>sendRequest</function> should already be called. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.updatecookies.throws"> &title.throws; <para> <emphasis>throws</emphasis> no exceptions thrown </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.updatecookies.see"> &title.see; <para> <emphasis>see</emphasis> <link linkend="package.http.http-client.http-client-cookiemanager.passcookies"><function>passCookies</function></link>, <link linkend="package.http.http-client.http-client-cookiemanager.addcookie"><function>addCookie</function></link> </para> </refsect1> <refsect1 id="package.http.http-client.http-client-cookiemanager.updatecookies.note"> &title.note; ¬e.notstatic; </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 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 -->