mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Use <classname>, NULL -> &null;, " -> ", <titleabbrev>
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322045 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
parent
d4ff25da77
commit
8a4819c5d5
68 changed files with 97 additions and 90 deletions
|
@ -3,6 +3,7 @@
|
|||
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
|
||||
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.httpdeflatestream" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<title>The <classname>HttpDeflateStream</classname> class</title>
|
||||
<titleabbrev>HttpDeflateStream</titleabbrev>
|
||||
<partintro>
|
||||
<section xml:id="httpdeflatestream.synopsis">
|
||||
&reftitle.classsynopsis;
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Creates a new HttpDeflateStream object instance.
|
||||
Creates a new <classname>HttpDeflateStream</classname> object instance.
|
||||
</para>
|
||||
<para>
|
||||
See the <link linkend="http.HttpDeflateStream.constants">deflate stream constants table</link> for possible <parameter>flags</parameter>.
|
||||
|
|
|
@ -9,14 +9,14 @@
|
|||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<modifier>static public</modifier>
|
||||
<type>HttpDeflateStream</type>
|
||||
<methodname>HttpDeflateStream::factory</methodname>
|
||||
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>string</type><parameter>class_name</parameter><initializer>"HttpDeflateStream"</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Creates a new HttpDeflateStream object instance.
|
||||
Creates a new <classname>HttpDeflateStream</classname> object instance.
|
||||
</para>
|
||||
<para>
|
||||
See the <link linkend="http.HttpDeflateStream.constants">deflate stream constants table</link> for possible <parameter>flags</parameter>.
|
||||
|
|
|
@ -3,6 +3,7 @@
|
|||
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
|
||||
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.httpinflatestream" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<title>The <classname>HttpInflateStream</classname> class</title>
|
||||
<titleabbrev>HttpInflateStream</titleabbrev>
|
||||
<partintro>
|
||||
<section xml:id="httpinflatestream.synopsis">
|
||||
&reftitle.classsynopsis;
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Creates a new HttpInflateStream object instance.
|
||||
Creates a new <classname>HttpInflateStream</classname> object instance.
|
||||
</para>
|
||||
<para>
|
||||
See the <link linkend="http.HttpInflateStream.constants">inflate constants table</link> for possible <parameter>flags</parameter>.
|
||||
|
|
|
@ -2,6 +2,7 @@
|
|||
<!-- $Revision$ -->
|
||||
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.httpmessage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<title>The <classname>HttpMessage</classname> class</title>
|
||||
<titleabbrev>HttpMessage</titleabbrev>
|
||||
<partintro>
|
||||
<section xml:id="httpmessage.synopsis">
|
||||
&reftitle.classsynopsis;
|
||||
|
|
|
@ -15,7 +15,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Instantiate a new HttpMessage object.
|
||||
Instantiate a new <classname>HttpMessage</classname> object.
|
||||
</para>
|
||||
<para>
|
||||
The constructed object will actually represent the <emphasis>last</emphasis> message of the passed string. If there were
|
||||
|
|
|
@ -15,7 +15,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Returns a clone of an HttpMessage object detached from any parent messages.
|
||||
Returns a clone of an <classname>HttpMessage</classname> object detached from any parent messages.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
@ -27,7 +27,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns detached HttpMessage object copy.
|
||||
Returns detached <classname>HttpMessage</classname> object copy.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -16,7 +16,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Create an HttpMessage object from a string.
|
||||
Create an <classname>HttpMessage</classname> object from a string.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
@ -46,7 +46,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an HttpMessage object on success or NULL on failure.
|
||||
Returns an <classname>HttpMessage</classname> object on success or &null; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -16,7 +16,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Create an HttpMessage object from script environment.
|
||||
Create an <classname>HttpMessage</classname> object from script environment.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
@ -46,7 +46,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an HttpMessage object on success or NULL on failure.
|
||||
Returns an <classname>HttpMessage</classname> object on success or &null; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -16,7 +16,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Create an HttpMessage object from a string.
|
||||
Create an <classname>HttpMessage</classname> object from a string.
|
||||
</para>
|
||||
&info.function.alias.deprecated;
|
||||
|
||||
|
@ -47,7 +47,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an HttpMessage object on success or NULL on failure.
|
||||
Returns an <classname>HttpMessage</classname> object on success or &null; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -15,7 +15,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Get the body of the parsed HttpMessage.
|
||||
Get the body of the parsed <classname>HttpMessage</classname>.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the header value on success or NULL if the header does not exist.
|
||||
Returns the header value on success or &null; if the header does not exist.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -22,7 +22,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the parent HttpMessage object.
|
||||
Returns the parent <classname>HttpMessage</classname> object.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -22,7 +22,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the request method name on success, or FALSE if the message is
|
||||
Returns the request method name on success, or &false; if the message is
|
||||
not of type <classname>HttpMessage</classname>::<constant>TYPE_REQUEST</constant>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
|
|
@ -27,7 +27,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the request URL as string on success, or FALSE if the message
|
||||
Returns the request URL as string on success, or &false; if the message
|
||||
is not of type <classname>HttpMessage</classname>::<constant>TYPE_REQUEST</constant>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
|
|
@ -22,7 +22,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the HTTP response code if the message is of type <classname>HttpMessage</classname>::<constant>TYPE_RESPONSE</constant>, else FALSE.
|
||||
Returns the HTTP response code if the message is of type <classname>HttpMessage</classname>::<constant>TYPE_RESPONSE</constant>, else &false;.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -23,7 +23,7 @@
|
|||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the HTTP response status string if the message is of type
|
||||
<classname>HttpMessage</classname>::<constant>TYPE_RESPONSE</constant>, else FALSE.
|
||||
<classname>HttpMessage</classname>::<constant>TYPE_RESPONSE</constant>, else &false;.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -28,7 +28,7 @@
|
|||
<term><parameter>message</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
HttpMessage object to prepend
|
||||
<classname>HttpMessage</classname> object to prepend
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
|
@ -22,7 +22,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the most parent HttpMessage object.
|
||||
Returns the most parent <classname>HttpMessage</classname> object.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@
|
|||
Send the Message according to its type as Response or Request.
|
||||
</para>
|
||||
<para>
|
||||
This provides limited functionality compared to HttpRequest and HttpResponse.
|
||||
This provides limited functionality compared to <classname>HttpRequest</classname> and <classname>HttpResponse</classname>.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
|
|
@ -15,7 +15,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Set the body of the HttpMessage.
|
||||
Set the body of the <classname>HttpMessage</classname>.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
|
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns TRUE on success, or FALSE if supplied version is out of range (1.0/1.1).
|
||||
Returns &true; on success, or &false; if supplied version is out of range (1.0/1.1).
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns TRUE on success, or FALSE if the message is not of type
|
||||
Returns &true; on success, or &false; if the message is not of type
|
||||
<classname>HttpMessage</classname>::<constant>TYPE_REQUEST</constant> or an invalid request method was supplied.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns TRUE on success, or FALSE if the message is not of type
|
||||
Returns &true; on success, or &false; if the message is not of type
|
||||
<classname>HttpMessage</classname>::<constant>TYPE_REQUEST</constant> or supplied URL was empty.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns TRUE on success, or FALSE if the message is not of type
|
||||
Returns &true; on success, or &false; if the message is not of type
|
||||
<classname>HttpMessage</classname>::<constant>TYPE_RESPONSE</constant> or the response code is out of range (100-510).
|
||||
</para>
|
||||
</refsect1>
|
||||
|
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns TRUE on success or FALSE if the message is not of type
|
||||
Returns &true; on success or &false; if the message is not of type
|
||||
<classname>HttpMessage</classname>::<constant>TYPE_RESPONSE</constant>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
|
|
@ -28,7 +28,7 @@
|
|||
<term><parameter>type</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
the HttpMessage::TYPE
|
||||
the <link linkend="http.HttpMessage.constants">HttpMessage::TYPE_*</link>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
|
@ -27,7 +27,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns either an HttpRequest or HttpResponse object on success, or NULL on failure.
|
||||
Returns either an <classname>HttpRequest</classname> or <classname>HttpResponse</classname> object on success, or &null; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -3,6 +3,7 @@
|
|||
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
|
||||
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.httpquerystring" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<title>The <classname>HttpQueryString</classname> class</title>
|
||||
<titleabbrev>HttpQueryString</titleabbrev>
|
||||
<partintro>
|
||||
<section xml:id="httpquerystring.synopsis">
|
||||
&reftitle.classsynopsis;
|
||||
|
|
|
@ -16,11 +16,11 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Creates a new HttpQueryString object instance.
|
||||
Creates a new <classname>HttpQueryString</classname> object instance.
|
||||
</para>
|
||||
<para>
|
||||
Operates on and modifies <varname>$_GET</varname> and
|
||||
<varname>$_SERVER['QUERY_STRING']</varname> if global is TRUE.
|
||||
<varname>$_SERVER['QUERY_STRING']</varname> if global is &true;.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
|
|
@ -21,9 +21,9 @@
|
|||
Get (part of) the query string.
|
||||
</para>
|
||||
<para>
|
||||
The type parameter is either one of the HttpQueryString::TYPE_* constants or a type abbreviation like
|
||||
"b" for bool, "i" for int, "f" for float, "s" for string, "a"
|
||||
for array and "o" for a stdClass object.
|
||||
The type parameter is either one of the <link linkend="http.HttpQueryString.constants">HttpQueryString::TYPE_* constants</link> or a type abbreviation like
|
||||
"b" for bool, "i" for int, "f" for float, "s" for string, "a"
|
||||
for array and "o" for a stdClass object.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns a new HttpQueryString object
|
||||
Returns a new <classname>HttpQueryString</classname> object
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -15,7 +15,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Set query string entry/entries. <constant>NULL</constant> values will unset the variable.
|
||||
Set query string entry/entries. &null; values will unset the variable.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
|
|
@ -3,6 +3,7 @@
|
|||
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
|
||||
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.httprequest" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<title>The <classname>HttpRequest</classname></title>
|
||||
<titleabbrev>HttpRequest</titleabbrev>
|
||||
<partintro>
|
||||
<section xml:id="httprequest.synopsis">
|
||||
&reftitle.classsynopsis;
|
||||
|
|
|
@ -58,7 +58,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns TRUE on success, or FALSE if the content type seems not to contain a
|
||||
Returns &true; on success, or &false; if the content type seems not to contain a
|
||||
primary and a secondary content type part.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
|
|
@ -17,7 +17,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Instantiate a new HttpRequest object.
|
||||
Instantiate a new <classname>HttpRequest</classname> object.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
|
|
@ -15,11 +15,11 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Get all sent requests and received responses as an HttpMessage object.
|
||||
Get all sent requests and received responses as an <classname>HttpMessage</classname> object.
|
||||
</para>
|
||||
<para>
|
||||
If you want to record history, set the instance variable
|
||||
<classname>HttpRequest</classname>::<varname>recordHistory</varname> to TRUE.
|
||||
<classname>HttpRequest</classname>::<varname>recordHistory</varname> to &true;.
|
||||
</para>
|
||||
<para>
|
||||
The returned object references the last received response, use <function>HttpMessage::getParentMessage</function>
|
||||
|
@ -30,7 +30,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an HttpMessage object representing the complete request/response history.
|
||||
Returns an <classname>HttpMessage</classname> object representing the complete request/response history.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -27,7 +27,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an HttpMessage in a form of a string.
|
||||
Returns an <classname>HttpMessage</classname> in a form of a string.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -35,7 +35,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an HttpMessage object representing the sent request.
|
||||
Returns an <classname>HttpMessage</classname> object representing the sent request.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -42,7 +42,7 @@
|
|||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns either a string with the value of the header matching name if requested,
|
||||
FALSE on failure, or an associative array containing all response headers.
|
||||
&false; on failure, or an associative array containing all response headers.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -46,7 +46,7 @@
|
|||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns either a scalar containing the value of the info matching name if
|
||||
requested, FALSE on failure, or an associative array containing all
|
||||
requested, &false; on failure, or an associative array containing all
|
||||
available info.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
|
|
@ -28,7 +28,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an HttpMessage object of the response.
|
||||
Returns an <classname>HttpMessage</classname> object of the response.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -21,7 +21,7 @@
|
|||
<para>
|
||||
While an exception may be thrown, the transfer could have succeeded
|
||||
at least partially, so you might want to check the return values of various
|
||||
HttpRequest::getResponse*() methods.
|
||||
<classname>HttpRequest</classname>::getResponse*() methods.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
|
@ -29,7 +29,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the received response as HttpMessage object.
|
||||
Returns the received response as <classname>HttpMessage</classname> object.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -37,7 +37,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns TRUE on success, or FALSE if the content type does not seem to
|
||||
Returns &true; on success, or &false; if the content type does not seem to
|
||||
contain a primary and a secondary part.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
|
|
@ -30,7 +30,7 @@
|
|||
<para>
|
||||
an associative array, which values will overwrite the
|
||||
currently set request options;
|
||||
if empty or omitted, the options of the HttpRequest object will be reset
|
||||
if empty or omitted, the options of the <classname>HttpRequest</classname> object will be reset
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
|
@ -3,6 +3,7 @@
|
|||
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
|
||||
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.httprequestpool" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<title>The <classname>HttpRequestPool</classname> class</title>
|
||||
<titleabbrev>HttpRequestPool</titleabbrev>
|
||||
<partintro>
|
||||
<section xml:id="httprequestpool.synopsis">
|
||||
&reftitle.classsynopsis;
|
||||
|
|
|
@ -15,7 +15,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Attach an HttpRequest object to this HttpRequestPool.
|
||||
Attach an <classname>HttpRequest</classname> object to this <classname>HttpRequestPool</classname>.
|
||||
</para>
|
||||
<warning>
|
||||
<para>
|
||||
|
@ -32,7 +32,7 @@
|
|||
<term><parameter>request</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
an HttpRequest object not already attached to any HttpRequestPool object
|
||||
an <classname>HttpRequest</classname> object not already attached to any <classname>HttpRequestPool</classname> object
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
|
@ -15,11 +15,11 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Instantiate a new HttpRequestPool object. An HttpRequestPool is
|
||||
able to send several HttpRequests in parallel.
|
||||
Instantiate a new <classname>HttpRequestPool</classname> object. An <classname>HttpRequestPool</classname> is
|
||||
able to send several <classname>HttpRequests</classname> in parallel.
|
||||
</para>
|
||||
<para>
|
||||
Accepts virtually infinite optional parameters each referencing an HttpRequest object.
|
||||
Accepts virtually infinite optional parameters each referencing an <classname>HttpRequest</classname> object.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
@ -31,7 +31,7 @@
|
|||
<term><parameter>request</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
HttpRequest object to attach
|
||||
<classname>HttpRequest</classname> object to attach
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Clean up HttpRequestPool object.
|
||||
Clean up <classname>HttpRequestPool</classname> object.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Detach an HttpRequest object from this HttpRequestPool.
|
||||
Detach an <classname>HttpRequest</classname> object from this <classname>HttpRequestPool</classname>.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
@ -26,7 +26,7 @@
|
|||
<term><parameter>request</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
an HttpRequest object attached to this HttpRequestPool object
|
||||
an <classname>HttpRequest</classname> object attached to this <classname>HttpRequestPool</classname> object
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Get attached HttpRequest objects.
|
||||
Get attached <classname>HttpRequest</classname> objects.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
@ -26,7 +26,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an array containing all currently attached HttpRequest objects.
|
||||
Returns an array containing all currently attached <classname>HttpRequest</classname> objects.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Get attached HttpRequest objects that already have finished their work.
|
||||
Get attached <classname>HttpRequest</classname> objects that already have finished their work.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
@ -26,7 +26,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an array containing all attached HttpRequest objects that already have finished their work.
|
||||
Returns an array containing all attached <classname>HttpRequest</classname> objects that already have finished their work.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Detach all attached HttpRequest objects.
|
||||
Detach all attached <classname>HttpRequest</classname> objects.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Send all attached HttpRequest objects in parallel.
|
||||
Send all attached <classname>HttpRequest</classname> objects in parallel.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
|
|
@ -15,14 +15,14 @@
|
|||
</methodsynopsis>
|
||||
|
||||
<para>
|
||||
Returns TRUE until each request has finished its transaction.
|
||||
Returns &true; until each request has finished its transaction.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns TRUE until each request has finished its transaction.
|
||||
Returns &true; until each request has finished its transaction.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -3,6 +3,7 @@
|
|||
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
|
||||
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.httpresponse" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<title>The <classname>HttpResponse</classname></title>
|
||||
<titleabbrev>HttpResponse</titleabbrev>
|
||||
<partintro>
|
||||
<section xml:id="httpresponse.synopsis">
|
||||
&reftitle.classsynopsis;
|
||||
|
|
|
@ -27,7 +27,7 @@
|
|||
<term><parameter>filename</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
the file name the "Save as..." dialog should display
|
||||
the file name the "Save as..." dialog should display
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
|
@ -128,7 +128,7 @@
|
|||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
whether "secure" was found in the cookie's parameters list
|
||||
whether "secure" was found in the cookie's parameters list
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
@ -139,7 +139,7 @@
|
|||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
whether "httpOnly" was found in the cookie's parameter list
|
||||
whether "httpOnly" was found in the cookie's parameter list
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
@ -564,7 +564,7 @@
|
|||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
use "basic" authentication
|
||||
use "basic" authentication
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
@ -575,7 +575,7 @@
|
|||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
use "digest" authentication
|
||||
use "digest" authentication
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
@ -586,7 +586,7 @@
|
|||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
use "NTLM" authentication
|
||||
use "NTLM" authentication
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
@ -597,7 +597,7 @@
|
|||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
use "GSS-NEGOTIATE" authentication
|
||||
use "GSS-NEGOTIATE" authentication
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
|
@ -46,7 +46,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the encoded string on success, or NULL on failure.
|
||||
Returns the encoded string on success, or &null; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -35,7 +35,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the decoded string on success, or NULL on failure.
|
||||
Returns the decoded string on success, or &null; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -27,7 +27,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the raw request body as stream on success or NULL on failure.
|
||||
Returns the raw request body as stream on success or &null; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -29,7 +29,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the raw request body as string on success or NULL on failure.
|
||||
Returns the raw request body as string on success or &null; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -44,7 +44,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns &true; if <literal>ETag</literal> matches or the header contained the asterisk ("*"), else &false;.
|
||||
Returns &true; if <literal>ETag</literal> matches or the header contained the asterisk ("*"), else &false;.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
@ -27,7 +27,7 @@
|
|||
for which redirect response code to use in which situation. By default PHP will decide which response status fits best.
|
||||
</para>
|
||||
<para>
|
||||
To be RFC compliant, "Redirecting to <a>URL</a>." will be displayed,
|
||||
To be RFC compliant, "Redirecting to <a>URL</a>." will be displayed,
|
||||
if the client doesn't redirect immediately, and the request method was another one than HEAD.
|
||||
</para>
|
||||
<para>
|
||||
|
|
|
@ -27,7 +27,7 @@
|
|||
<term><parameter>filename</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
the file name the "Save as..." dialog should display
|
||||
the file name the "Save as..." dialog should display
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
|
@ -42,7 +42,7 @@
|
|||
<term><parameter>arg_separator</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
argument separator to use (by default the INI setting arg_separator.output will be used, or "&" if neither is set
|
||||
argument separator to use (by default the INI setting arg_separator.output will be used, or "&" if neither is set
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
|
@ -107,7 +107,7 @@
|
|||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
list of cookies as associative array like <literal>array("cookie" => "value")</literal>
|
||||
list of cookies as associative array like <literal>array("cookie" => "value")</literal>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
@ -170,7 +170,7 @@
|
|||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
list of custom headers as associative array like <literal>array("header" => "value")</literal>
|
||||
list of custom headers as associative array like <literal>array("header" => "value")</literal>
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
@ -183,7 +183,7 @@
|
|||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
http credentials in "user:pass" format
|
||||
http credentials in "user:pass" format
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
@ -215,7 +215,7 @@
|
|||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
proxy host in "host[:port]" format
|
||||
proxy host in "host[:port]" format
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
@ -245,7 +245,7 @@
|
|||
</term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
proxy credentials in "user:pass" format
|
||||
proxy credentials in "user:pass" format
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
@ -375,7 +375,7 @@
|
|||
</term>
|
||||
<listitem>
|
||||
<note>
|
||||
<simpara>SSL options are set through an array with the single "ssl" request option name.</simpara>
|
||||
<simpara>SSL options are set through an array with the single "ssl" request option name.</simpara>
|
||||
</note>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
|
|
Loading…
Reference in a new issue