diff --git a/reference/http/HttpDeflateStream.xml b/reference/http/HttpDeflateStream.xml deleted file mode 100644 index 94c2afef15..0000000000 --- a/reference/http/HttpDeflateStream.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - The <classname>HttpDeflateStream</classname> class - HttpDeflateStream - -
- &reftitle.classsynopsis; - - HttpDeflateStream - - HttpDeflateStream - - - -
- -
- Class Members -
- &reftitle.constants; - - - <tgroup cols="3"> - <thead> - <row> - <entry>Type</entry> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry>TYPE_GZIP</entry> - <entry>gzip encoding</entry> - </row> - <row> - <entry>int</entry> - <entry>TYPE_ZLIB</entry> - <entry>zlib AKA deflate encoding</entry> - </row> - <row> - <entry>int</entry> - <entry>TYPE_RAW</entry> - <entry>raw deflate encoding</entry> - </row> - <row> - <entry>int</entry> - <entry>LEVEL_DEF</entry> - <entry>default compression level</entry> - </row> - <row> - <entry>int</entry> - <entry>LEVEL_MIN</entry> - <entry>minimum compression level</entry> - </row> - <row> - <entry>int</entry> - <entry>LEVEL_MAX</entry> - <entry>maximum compression level</entry> - </row> - <row> - <entry>int</entry> - <entry>STRATEGY_DEF</entry> - <entry>default strategy</entry> - </row> - <row> - <entry>int</entry> - <entry>STRATEGY_FILT</entry> - <entry>filtered strategy</entry> - </row> - <row> - <entry>int</entry> - <entry>STRATEGY_HUFF</entry> - <entry>Huffman strategy</entry> - </row> - <row> - <entry>int</entry> - <entry>STRATEGY_RLE</entry> - <entry>RLE strategy</entry> - </row> - <row> - <entry>int</entry> - <entry>STRATEGY_FIXED</entry> - <entry>fixed strategy</entry> - </row> - <row> - <entry>int</entry> - <entry>FLUSH_NONE</entry> - <entry>no forced flush</entry> - </row> - <row> - <entry>int</entry> - <entry>FLUSH_SYNC</entry> - <entry>synching flush</entry> - </row> - <row> - <entry>int</entry> - <entry>FLUSH_FULL</entry> - <entry>full flush</entry> - </row> - </tbody> - </tgroup> - </table> - </section> - </section> - <section role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <classname>HttpDeflateStream</classname> example - -update($data); -echo $stream->finish(); -?> -]]> - - - - - -&reference.http.entities.HttpDeflateStream; - - - - diff --git a/reference/http/HttpDeflateStream/construct.xml b/reference/http/HttpDeflateStream/construct.xml deleted file mode 100644 index 8ab5aeffcd..0000000000 --- a/reference/http/HttpDeflateStream/construct.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - HttpDeflateStream::__construct - HttpDeflateStream class constructor - - - &reftitle.description; - - public - HttpDeflateStream::__construct - intflags0 - - - Creates a new HttpDeflateStream object instance. - - - See the deflate stream constants table for possible flags. - - - - &reftitle.parameters; - - - - flags - - - initialization flags - - - - - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpDeflateStream::factory - - - - - - - - diff --git a/reference/http/HttpDeflateStream/factory.xml b/reference/http/HttpDeflateStream/factory.xml deleted file mode 100644 index db15764b32..0000000000 --- a/reference/http/HttpDeflateStream/factory.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - HttpDeflateStream::factory - HttpDeflateStream class factory - - - &reftitle.description; - - static public - HttpDeflateStream - HttpDeflateStream::factory - intflags0 - stringclass_name"HttpDeflateStream" - - - Creates a new HttpDeflateStream object instance. - - - See the deflate stream constants table for possible flags. - - - - &reftitle.parameters; - - - - flags - - - initialization flags - - - - - class_name - - - name of a subclass of HttpDeflateStream - - - - - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpDeflateStream::__construct - - - - - - - - diff --git a/reference/http/HttpDeflateStream/finish.xml b/reference/http/HttpDeflateStream/finish.xml deleted file mode 100644 index d8abb9ad56..0000000000 --- a/reference/http/HttpDeflateStream/finish.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - HttpDeflateStream::finish - Finalize deflate stream - - - &reftitle.description; - - public - stringHttpDeflateStream::finish - stringdata - - - Finalizes the deflate stream. The deflate stream can be reused after finalizing. - - - - &reftitle.parameters; - - - - data - - - data to deflate - - - - - - - - &reftitle.returnvalues; - - Returns the final part of deflated data. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpDeflateStream/flush.xml b/reference/http/HttpDeflateStream/flush.xml deleted file mode 100644 index 2d3fe479f1..0000000000 --- a/reference/http/HttpDeflateStream/flush.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - HttpDeflateStream::flush - Flush deflate stream - - - &reftitle.description; - - public - stringHttpDeflateStream::flush - stringdata - - - Flushes the deflate stream. - - - - &reftitle.parameters; - - - - data - - - more data to deflate - - - - - - - - &reftitle.returnvalues; - - Returns some deflated data as string on success&return.falseforfailure;. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpDeflateStream/update.xml b/reference/http/HttpDeflateStream/update.xml deleted file mode 100644 index 13a064da92..0000000000 --- a/reference/http/HttpDeflateStream/update.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - HttpDeflateStream::update - Update deflate stream - - - &reftitle.description; - - public - stringHttpDeflateStream::update - stringdata - - - Passes more data through the deflate stream. - - - - &reftitle.parameters; - - - - data - - - data to deflate - - - - - - - - &reftitle.returnvalues; - - Returns deflated data on success&return.falseforfailure;. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpInflateStream.xml b/reference/http/HttpInflateStream.xml deleted file mode 100644 index f9cfc78315..0000000000 --- a/reference/http/HttpInflateStream.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - The <classname>HttpInflateStream</classname> class - HttpInflateStream - -
- &reftitle.classsynopsis; - - HttpInflateStream - - HttpInflateStream - - - -
- -
- Class Members -
- Constants -
- - <tgroup cols="3"> - <thead> - <row> - <entry>Type</entry> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry>FLUSH_NONE</entry> - <entry>no forced flush</entry> - </row> - <row> - <entry>int</entry> - <entry>FLUSH_SYNC</entry> - <entry>synching flush</entry> - </row> - <row> - <entry>int</entry> - <entry>FLUSH_FULL</entry> - <entry>full flush</entry> - </row> - </tbody> - </tgroup> - </table> - <note> - <para> - Flushing usually has no effect on inflate streams. - </para> - </note> - </section> - </section> - <section role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <classname>HttpInflateStream</classname> example - -update($data); -echo $stream->finish(); -?> -]]> - - - - - -&reference.http.entities.HttpInflateStream; - - - - diff --git a/reference/http/HttpInflateStream/construct.xml b/reference/http/HttpInflateStream/construct.xml deleted file mode 100644 index 6bd5e44c24..0000000000 --- a/reference/http/HttpInflateStream/construct.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - HttpInflateStream::__construct - HttpInflateStream class constructor - - - &reftitle.description; - - public - HttpInflateStream::__construct - intflags0 - - - Creates a new HttpInflateStream object instance. - - - See the inflate constants table for possible flags. - - - - &reftitle.parameters; - - - - flags - - - initialization flags - - - - - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpInflateStream::factory - - - - - - - - diff --git a/reference/http/HttpInflateStream/factory.xml b/reference/http/HttpInflateStream/factory.xml deleted file mode 100644 index e57c240c1f..0000000000 --- a/reference/http/HttpInflateStream/factory.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - HttpInflateStream::factory - HttpInflateStream class factory - - - &reftitle.description; - - public - HttpInflateStream - HttpInflateStream::factory - intflags0 - stringclass_name"HttpInflateStream" - - - Creates a new HttpInflateStream object instance. - - - See the inflate constants table for possible flags. - - - - &reftitle.parameters; - - - - flags - - - initialization flags - - - - - class_name - - - name of a subclass of HttpInflateStream - - - - - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpInflateStream::__construct - - - - - - - - diff --git a/reference/http/HttpInflateStream/finish.xml b/reference/http/HttpInflateStream/finish.xml deleted file mode 100644 index 6a6ee1d0dd..0000000000 --- a/reference/http/HttpInflateStream/finish.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - HttpInflateStream::finish - Finalize inflate stream - - - &reftitle.description; - - public - stringHttpInflateStream::finish - stringdata - - - Finalizes the inflate stream. The inflate stream can be reused after finalizing. - - - - &reftitle.parameters; - - - - data - - - data to inflate - - - - - - - - &reftitle.returnvalues; - - Returns the final part of inflated data. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpInflateStream/flush.xml b/reference/http/HttpInflateStream/flush.xml deleted file mode 100644 index ff84d44ac1..0000000000 --- a/reference/http/HttpInflateStream/flush.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - HttpInflateStream::flush - Flush inflate stream - - - &reftitle.description; - - public - stringHttpInflateStream::flush - stringdata - - - Flushes the inflate stream. - - - - Flushing usually has no effect on inflate streams. - - - - - &reftitle.parameters; - - - - data - - - more data to inflate - - - - - - - - &reftitle.returnvalues; - - Returns some inflated data as string on success&return.falseforfailure;. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpInflateStream/update.xml b/reference/http/HttpInflateStream/update.xml deleted file mode 100644 index 5038abfdf1..0000000000 --- a/reference/http/HttpInflateStream/update.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - HttpInflateStream::update - Update inflate stream - - - &reftitle.description; - - public - stringHttpInflateStream::update - stringdata - - - Passes more data through the inflate stream. - - - - &reftitle.parameters; - - - - data - - - data to inflate - - - - - - - - &reftitle.returnvalues; - - Returns inflated data on success&return.falseforfailure;. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage.xml b/reference/http/HttpMessage.xml deleted file mode 100644 index 3dac68fe45..0000000000 --- a/reference/http/HttpMessage.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - The <classname>HttpMessage</classname> class - HttpMessage - -
- &reftitle.classsynopsis; - - HttpMessage - - HttpMessage - - Iterator - - - Countable - - - Serializable - - - - -
- -
- Class Members -
- &reftitle.properties; -
- Instance Properties - - - - Modifiers - Type - Name - Description - - - - - protected - int - type - message type - - - protected - string - body - message body - - - protected - float - httpVersion - HTTP protocol version - - - protected - array - headers - message headers - - - protected - string - requestMethod - request method name - - - protected - requestUrl - string - request URL - - - protected - int - responseCode - response code - - - protected - string - responseStatus - response status message - - - protected - HttpMessage - parentMessage - reference to parent message - - - -
- - - None of these default properties can be accessed by reference, array key/index notation nor be used - in increment or decrement operations. - - -
-
- &reftitle.constants; - - - <tgroup cols="3"> - <thead> - <row> - <entry>Type</entry> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry>TYPE_NONE</entry> - <entry>message has is of no specific type</entry> - </row> - <row> - <entry>int</entry> - <entry>TYPE_REQUEST</entry> - <entry>message is a request style HTTP message</entry> - </row> - <row> - <entry>int</entry> - <entry>TYPE_RESPONSE</entry> - <entry>message is a response style HTTP message</entry> - </row> - </tbody> - </tgroup> - </table> - </section> - </section> - </partintro> - - &reference.http.entities.HttpMessage; -</phpdoc:classref> - - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/http/HttpMessage/addHeaders.xml b/reference/http/HttpMessage/addHeaders.xml deleted file mode 100644 index d8f05eadac..0000000000 --- a/reference/http/HttpMessage/addHeaders.xml +++ /dev/null @@ -1,156 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> -<refentry xml:id="httpmessage.addheaders" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HttpMessage::addHeaders</refname> - <refpurpose>Add headers</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <modifier>public</modifier> - <type>void</type><methodname>HttpMessage::addHeaders</methodname> - <methodparam><type>array</type><parameter>headers</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>append</parameter><initializer>false</initializer></methodparam> - </methodsynopsis> - - <para> - Add headers. If append is true, headers with the same name will be separated, else overwritten. - </para> - - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>headers</parameter></term> - <listitem> - <para> - associative array containing the additional HTTP headers to add to the messages existing headers - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>append</parameter></term> - <listitem> - <para> - if true, and a header with the same name of one to add exists already, this respective - header will be converted to an array containing both header values, otherwise - it will be overwritten with the new header value - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - &return.success; - </para> - </refsect1> - - <!-- Use when ERRORS exist - <refsect1 role="errors"> - &reftitle.errors; - <para> - When does this function throw E_* level errors, or exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>HttpMessage::addHeaders</function> example - - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - tag, not out - - - -]]> - - &example.outputs; - - - - - - - --> - - - - - - - - diff --git a/reference/http/HttpMessage/construct.xml b/reference/http/HttpMessage/construct.xml deleted file mode 100644 index 61cd959fa2..0000000000 --- a/reference/http/HttpMessage/construct.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - HttpMessage::__construct - HttpMessage constructor - - - &reftitle.description; - - public - HttpMessage::__construct - stringmessage - - - - Instantiate a new HttpMessage object. - - - The constructed object will actually represent the last message of the passed string. If there were - prior messages, those can be accessed by HttpMessage::getParentMessage. - - - - - &reftitle.parameters; - - - - message - - - a single or several consecutive HTTP messages - - - - - - - - - &reftitle.errors; - - Throws HttpMalformedHeaderException. - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/detach.xml b/reference/http/HttpMessage/detach.xml deleted file mode 100644 index 54569a06d7..0000000000 --- a/reference/http/HttpMessage/detach.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - HttpMessage::detach - Detach HttpMessage - - - &reftitle.description; - - public - HttpMessageHttpMessage::detach - - - - - Returns a clone of an HttpMessage object detached from any parent messages. - - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns detached HttpMessage object copy. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/factory.xml b/reference/http/HttpMessage/factory.xml deleted file mode 100644 index f5ee31c7ed..0000000000 --- a/reference/http/HttpMessage/factory.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - HttpMessage::factory - Create HttpMessage from string - - - &reftitle.description; - - static public - HttpMessageHttpMessage::factory - stringraw_message - stringclass_name"HttpMessage" - - - - Create an HttpMessage object from a string. - - - - - &reftitle.parameters; - - - - raw_message - - - a single or several consecutive HTTP messages - - - - - class_name - - - a class extending HttpMessage - - - - - - - - &reftitle.returnvalues; - - Returns an HttpMessage object on success or &null; on failure. - - - - - &reftitle.errors; - - Throws HttpMalformedHeadersException. - - - - - - - - - - - &reftitle.seealso; - - - HttpMessage::fromEnv. - - - - - - - - diff --git a/reference/http/HttpMessage/fromEnv.xml b/reference/http/HttpMessage/fromEnv.xml deleted file mode 100644 index 864975b54b..0000000000 --- a/reference/http/HttpMessage/fromEnv.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - HttpMessage::fromEnv - Create HttpMessage from environment - - - &reftitle.description; - - static public - HttpMessageHttpMessage::fromEnv - intmessage_type - stringclass_name"HttpMessage" - - - - Create an HttpMessage object from script environment. - - - - - &reftitle.parameters; - - - - message_type - - - The message type. See HttpMessage type constants. - - - - - class_name - - - a class extending HttpMessage - - - - - - - - &reftitle.returnvalues; - - Returns an HttpMessage object on success or &null; on failure. - - - - - - - - - - - - - &reftitle.seealso; - - - HttpMessage::factory. - - - - - - - - diff --git a/reference/http/HttpMessage/fromString.xml b/reference/http/HttpMessage/fromString.xml deleted file mode 100644 index 86bdd262aa..0000000000 --- a/reference/http/HttpMessage/fromString.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - HttpMessage::fromString - Create HttpMessage from string - - - &reftitle.description; - - static public - HttpMessageHttpMessage::fromString - stringraw_message - stringclass_name"HttpMessage" - - - - Create an HttpMessage object from a string. - - &info.function.alias.deprecated; - - - - &reftitle.parameters; - - - - raw_message - - - a single or several consecutive HTTP messages - - - - - class_name - - - a class extending HttpMessage - - - - - - - - &reftitle.returnvalues; - - Returns an HttpMessage object on success or &null; on failure. - - - - - &reftitle.errors; - - Throws HttpMalformedHeadersException. - - - - - - - - - - - - &reftitle.seealso; - - - HttpMessage::factory. - - - - - - - - diff --git a/reference/http/HttpMessage/getBody.xml b/reference/http/HttpMessage/getBody.xml deleted file mode 100644 index a771683bd8..0000000000 --- a/reference/http/HttpMessage/getBody.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpMessage::getBody - Get message body - - - &reftitle.description; - - public - stringHttpMessage::getBody - - - - - Get the body of the parsed HttpMessage. - - - - - &reftitle.returnvalues; - - Returns the message body as string. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/getHeader.xml b/reference/http/HttpMessage/getHeader.xml deleted file mode 100644 index 48c358a525..0000000000 --- a/reference/http/HttpMessage/getHeader.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - HttpMessage::getHeader - Get header - - - &reftitle.description; - - public - stringHttpMessage::getHeader - stringheader - - - - Get message header. - - - - - &reftitle.parameters; - - - - header - - - header name - - - - - - - - &reftitle.returnvalues; - - Returns the header value on success or &null; if the header does not exist. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/getHeaders.xml b/reference/http/HttpMessage/getHeaders.xml deleted file mode 100644 index cf4b452f68..0000000000 --- a/reference/http/HttpMessage/getHeaders.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpMessage::getHeaders - Get message headers - - - &reftitle.description; - - public - arrayHttpMessage::getHeaders - - - - - Get message headers. - - - - - &reftitle.returnvalues; - - Returns an associative array containing the messages HTTP headers. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/getHttpVersion.xml b/reference/http/HttpMessage/getHttpVersion.xml deleted file mode 100644 index 7bf334da87..0000000000 --- a/reference/http/HttpMessage/getHttpVersion.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpMessage::getHttpVersion - Get HTTP version - - - &reftitle.description; - - public - stringHttpMessage::getHttpVersion - - - - - Get the HTTP Protocol Version of the Message. - - - - - &reftitle.returnvalues; - - Returns the HTTP protocol version as string. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/getParentMessage.xml b/reference/http/HttpMessage/getParentMessage.xml deleted file mode 100644 index 85494a05b3..0000000000 --- a/reference/http/HttpMessage/getParentMessage.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - HttpMessage::getParentMessage - Get parent message - - - &reftitle.description; - - public - HttpMessageHttpMessage::getParentMessage - - - - - Get parent Message. - - - - - &reftitle.returnvalues; - - Returns the parent HttpMessage object. - - - - - &reftitle.errors; - - Throws HttpRuntimeException. - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/getRequestMethod.xml b/reference/http/HttpMessage/getRequestMethod.xml deleted file mode 100644 index af1ccd0268..0000000000 --- a/reference/http/HttpMessage/getRequestMethod.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - HttpMessage::getRequestMethod - Get request method - - - &reftitle.description; - - public - stringHttpMessage::getRequestMethod - - - - - Get the Request Method of the Message. - - - - - &reftitle.returnvalues; - - Returns the request method name on success, or &false; if the message is - not of type HttpMessage::TYPE_REQUEST. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/getRequestUrl.xml b/reference/http/HttpMessage/getRequestUrl.xml deleted file mode 100644 index 961577d567..0000000000 --- a/reference/http/HttpMessage/getRequestUrl.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - HttpMessage::getRequestUrl - Get request URL - - - &reftitle.description; - - public - stringHttpMessage::getRequestUrl - - - - - Get the Request URL of the Message. - - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns the request URL as string on success, or &false; if the message - is not of type HttpMessage::TYPE_REQUEST. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/getResponseCode.xml b/reference/http/HttpMessage/getResponseCode.xml deleted file mode 100644 index 7263a2e228..0000000000 --- a/reference/http/HttpMessage/getResponseCode.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpMessage::getResponseCode - Get response code - - - &reftitle.description; - - public - intHttpMessage::getResponseCode - - - - - Get the Response Code of the Message. - - - - - &reftitle.returnvalues; - - Returns the HTTP response code if the message is of type HttpMessage::TYPE_RESPONSE, else &false;. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/getResponseStatus.xml b/reference/http/HttpMessage/getResponseStatus.xml deleted file mode 100644 index a3a5b410df..0000000000 --- a/reference/http/HttpMessage/getResponseStatus.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - HttpMessage::getResponseStatus - Get response status - - - &reftitle.description; - - public - stringHttpMessage::getResponseStatus - - - - - Get the Response Status of the message (i.e. the string following the response code). - - - - - &reftitle.returnvalues; - - Returns the HTTP response status string if the message is of type - HttpMessage::TYPE_RESPONSE, else &false;. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/getType.xml b/reference/http/HttpMessage/getType.xml deleted file mode 100644 index 504b1fa120..0000000000 --- a/reference/http/HttpMessage/getType.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - HttpMessage::getType - Get message type - - - &reftitle.description; - - public - intHttpMessage::getType - - - - - Get Message Type. - Either HTTP_MSG_NONE, HTTP_MSG_REQUEST or HTTP_MSG_RESPONSE. - - - - - &reftitle.returnvalues; - - Returns the HttpMessage::TYPE. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/guessContentType.xml b/reference/http/HttpMessage/guessContentType.xml deleted file mode 100644 index 9644ff013d..0000000000 --- a/reference/http/HttpMessage/guessContentType.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - HttpMessage::guessContentType - Guess content type - - - &reftitle.description; - - public - stringHttpMessage::guessContentType - stringmagic_file - intmagic_modeMAGIC_MIME - - - - Attempts to guess the content type of the message body through libmagic. - - - - - &reftitle.parameters; - - - - magic_file - - - the magic.mime database to use - - - - - magic_mode - - - flags for libmagic - - - - - - - - &reftitle.returnvalues; - - Returns the guessed content type on success&return.falseforfailure;. - - - - - &reftitle.errors; - - Throws HttpRuntimeException, HttpInvalidParamException. - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/prepend.xml b/reference/http/HttpMessage/prepend.xml deleted file mode 100644 index 96b1c0be0d..0000000000 --- a/reference/http/HttpMessage/prepend.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - HttpMessage::prepend - Prepend message(s) - - - &reftitle.description; - - public - voidHttpMessage::prepend - HttpMessagemessage - booltoptrue - - - - Prepends message(s) to the HTTP message. - - - - - &reftitle.parameters; - - - - message - - - HttpMessage object to prepend - - - - - top - - - whether to prepend to the top most or right this message - - - - - - - - - &reftitle.errors; - - Throws HttpInvalidParamException if the message is located within the same message chain. - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/reverse.xml b/reference/http/HttpMessage/reverse.xml deleted file mode 100644 index 5f2938e4e8..0000000000 --- a/reference/http/HttpMessage/reverse.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpMessage::reverse - Reverse message chain - - - &reftitle.description; - - public - HttpMessageHttpMessage::reverse - - - - - Reorders the message chain in reverse order. - - - - - &reftitle.returnvalues; - - Returns the most parent HttpMessage object. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/send.xml b/reference/http/HttpMessage/send.xml deleted file mode 100644 index de7018be44..0000000000 --- a/reference/http/HttpMessage/send.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - HttpMessage::send - Send message - - - &reftitle.description; - - public - boolHttpMessage::send - - - - - Send the Message according to its type as Response or Request. - - - This provides limited functionality compared to HttpRequest and HttpResponse. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/setBody.xml b/reference/http/HttpMessage/setBody.xml deleted file mode 100644 index b6aedcdbb7..0000000000 --- a/reference/http/HttpMessage/setBody.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - HttpMessage::setBody - Set message body - - - &reftitle.description; - - public - voidHttpMessage::setBody - stringbody - - - - Set the body of the HttpMessage. - - - - Don't forget to update any headers accordingly. - - - - - - &reftitle.parameters; - - - - body - - - the new body of the message - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/setHeaders.xml b/reference/http/HttpMessage/setHeaders.xml deleted file mode 100644 index bf6994552c..0000000000 --- a/reference/http/HttpMessage/setHeaders.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - HttpMessage::setHeaders - Set headers - - - &reftitle.description; - - public - voidHttpMessage::setHeaders - arrayheaders - - - - Sets new headers. - - - - - &reftitle.parameters; - - - - headers - - - associative array containing the new HTTP headers, which will replace all previous HTTP headers of the message - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/setHttpVersion.xml b/reference/http/HttpMessage/setHttpVersion.xml deleted file mode 100644 index 7f1d661d4b..0000000000 --- a/reference/http/HttpMessage/setHttpVersion.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - HttpMessage::setHttpVersion - Set HTTP version - - - &reftitle.description; - - public - boolHttpMessage::setHttpVersion - stringversion - - - - Set the HTTP Protocol version of the Message. - - - - - &reftitle.parameters; - - - - version - - - the HTTP protocol version - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; if supplied version is out of range (1.0/1.1). - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/setRequestMethod.xml b/reference/http/HttpMessage/setRequestMethod.xml deleted file mode 100644 index 661f19e154..0000000000 --- a/reference/http/HttpMessage/setRequestMethod.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - HttpMessage::setRequestMethod - Set request method - - - &reftitle.description; - - public - boolHttpMessage::setRequestMethod - stringmethod - - - - Set the Request Method of the HTTP Message. - - - - - &reftitle.parameters; - - - - method - - - the request method name - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; if the message is not of type - HttpMessage::TYPE_REQUEST or an invalid request method was supplied. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/setRequestUrl.xml b/reference/http/HttpMessage/setRequestUrl.xml deleted file mode 100644 index cfd5954173..0000000000 --- a/reference/http/HttpMessage/setRequestUrl.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - HttpMessage::setRequestUrl - Set request URL - - - &reftitle.description; - - public - boolHttpMessage::setRequestUrl - stringurl - - - - Set the Request URL of the HTTP Message. - - - - - &reftitle.parameters; - - - - url - - - the request URL - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; if the message is not of type - HttpMessage::TYPE_REQUEST or supplied URL was empty. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/setResponseCode.xml b/reference/http/HttpMessage/setResponseCode.xml deleted file mode 100644 index 19610191a6..0000000000 --- a/reference/http/HttpMessage/setResponseCode.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - HttpMessage::setResponseCode - Set response code - - - &reftitle.description; - - public - boolHttpMessage::setResponseCode - intcode - - - - Set the response code of an HTTP Response Message. - - - - - &reftitle.parameters; - - - - code - - - HTTP response code - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; if the message is not of type - HttpMessage::TYPE_RESPONSE or the response code is out of range (100-510). - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/setResponseStatus.xml b/reference/http/HttpMessage/setResponseStatus.xml deleted file mode 100644 index d93891824f..0000000000 --- a/reference/http/HttpMessage/setResponseStatus.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - HttpMessage::setResponseStatus - Set response status - - - &reftitle.description; - - public - boolHttpMessage::setResponseStatus - stringstatus - - - - Set the Response Status of the HTTP message (i.e. the string following the response code). - - - - - &reftitle.parameters; - - - - status - - - the response status text - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success or &false; if the message is not of type - HttpMessage::TYPE_RESPONSE. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/setType.xml b/reference/http/HttpMessage/setType.xml deleted file mode 100644 index 1a476afb26..0000000000 --- a/reference/http/HttpMessage/setType.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - HttpMessage::setType - Set message type - - - &reftitle.description; - - public - voidHttpMessage::setType - inttype - - - - Set Message Type. - Either HTTP_MSG_NONE, HTTP_MSG_REQUEST or HTTP_MSG_RESPONSE. - - - - - &reftitle.parameters; - - - - type - - - the HttpMessage::TYPE_* - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/toMessageTypeObject.xml b/reference/http/HttpMessage/toMessageTypeObject.xml deleted file mode 100644 index 758a8ce4b9..0000000000 --- a/reference/http/HttpMessage/toMessageTypeObject.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - HttpMessage::toMessageTypeObject - Create HTTP object regarding message type - - - &reftitle.description; - - public - HttpRequest|HttpResponseHttpMessage::toMessageTypeObject - - - - - Creates an object regarding to the type of the message. - - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns either an HttpRequest or HttpResponse object on success, or &null; on failure. - - - - - &reftitle.errors; - - Throws HttpRuntimeException, HttpMessageTypeException, HttpHeaderException. - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpMessage/toString.xml b/reference/http/HttpMessage/toString.xml deleted file mode 100644 index f014c778c6..0000000000 --- a/reference/http/HttpMessage/toString.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - HttpMessage::toString - Get string representation - - - &reftitle.description; - - public - stringHttpMessage::toString - boolinclude_parentfalse - - - - Get the string representation of the Message. - - - - - &reftitle.parameters; - - - - include_parent - - - specifies whether the returned string should also contain any parent messages - - - - - - - - &reftitle.returnvalues; - - Returns the message as string. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpQueryString.xml b/reference/http/HttpQueryString.xml deleted file mode 100644 index 8d4719eaa3..0000000000 --- a/reference/http/HttpQueryString.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - The <classname>HttpQueryString</classname> class - HttpQueryString - -
- &reftitle.classsynopsis; - - HttpQueryString - - HttpQueryString - - ArrayAccess - - - Serializable - - - - -
- -
- Class Members -
- &reftitle.properties; -
- Instance Properties - - - - Modifiers - Type - Name - Description - - - - - private - array - queryArray - query parameters - - - private - string - queryString - serialized query parameters - - - -
- - Static Properties - - - - Modifiers - Type - Name - Description - - - - - private - array - instance - holds singletons - - - -
-
-
- &reftitle.constants; - - - <tgroup cols="3"> - <thead> - <row> - <entry>Type</entry> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry>TYPE_BOOL</entry> - <entry>retrieve query param as bool</entry> - </row> - <row> - <entry>int</entry> - <entry>TYPE_INT</entry> - <entry>retrieve query param as int</entry> - </row> - <row> - <entry>int</entry> - <entry>TYPE_FLOAT</entry> - <entry>retrieve query param as float</entry> - </row> - <row> - <entry>int</entry> - <entry>TYPE_STRING</entry> - <entry>retrieve query param as string</entry> - </row> - <row> - <entry>int</entry> - <entry>TYPE_ARRAY</entry> - <entry>retrieve query param as array</entry> - </row> - <row> - <entry>int</entry> - <entry>TYPE_OBJECT</entry> - <entry>retrieve query param as object</entry> - </row> - </tbody> - </tgroup> - </table> - </section> - </section> -</partintro> -&reference.http.entities.HttpQueryString; -</phpdoc:classref> - - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/http/HttpQueryString/construct.xml b/reference/http/HttpQueryString/construct.xml deleted file mode 100644 index f6deb8a845..0000000000 --- a/reference/http/HttpQueryString/construct.xml +++ /dev/null @@ -1,151 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> -<refentry xml:id="httpquerystring.construct" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HttpQueryString::__construct</refname> - <refpurpose>HttpQueryString constructor</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <modifier>final public</modifier> - <methodname>HttpQueryString::__construct</methodname> - <methodparam choice="opt"><type>bool</type><parameter>global</parameter><initializer>true</initializer></methodparam> - <methodparam choice="opt"><type>mixed</type><parameter>add</parameter></methodparam> - </methodsynopsis> - - <para> - 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;. - </para> - - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>global</parameter></term> - <listitem> - <para> - whether to operate on <varname>$_GET</varname> and - <varname>$_SERVER['QUERY_STRING']</varname> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>add</parameter></term> - <listitem> - <para> - additional/initial query string parameters - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - <para> - Throws <classname>HttpRuntimeException</classname>. - </para> - </refsect1> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>HttpQueryString::__construct</function> example - - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - tag, not out - - - -]]> - - &example.outputs; - - - - - - - --> - - - - - - - - diff --git a/reference/http/HttpQueryString/get.xml b/reference/http/HttpQueryString/get.xml deleted file mode 100644 index d885bc15ea..0000000000 --- a/reference/http/HttpQueryString/get.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - HttpQueryString::get - Get the query string or a part thereof - - - - &reftitle.description; - - public - mixedHttpQueryString::get - stringkey - mixedtype0 - mixeddefval&null; - booldeletefalse - - Get the query string or a part thereof - - - - &reftitle.parameters; - - - - key - - - Key of the query string parameter to retrieve - - - - - type - - - Variable type to enforce for the returned value - - - Either one of the - - HttpQueryString::TYPE_* constants - - or a type abbreviation - "b" for bool, "i" for int, "f" for float, - "s" for string, "a" for array and "o" for a stdClass object. - - - - - defval - - - Default value if key does not exist - - - - - delete - - - Whether to remove key from the query string - - - - - - - - - &reftitle.returnvalues; - - Returns the value of the query string param or the whole query string if - key was not specified. Returns - defval if the specified key - does not exist. - - - - - - diff --git a/reference/http/HttpQueryString/mod.xml b/reference/http/HttpQueryString/mod.xml deleted file mode 100644 index 1758a53241..0000000000 --- a/reference/http/HttpQueryString/mod.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - HttpQueryString::mod - Modifiy query string copy - - - &reftitle.description; - - public - HttpQueryStringHttpQueryString::mod - mixedparams - - - - Copies the query string object and sets provided params at the clone. - - - - - &reftitle.parameters; - - - - params - - - query string params to add - - - - - - - - &reftitle.returnvalues; - - Returns a new HttpQueryString object - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpQueryString/set.xml b/reference/http/HttpQueryString/set.xml deleted file mode 100644 index 7758706320..0000000000 --- a/reference/http/HttpQueryString/set.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - HttpQueryString::set - Set query string params - - - &reftitle.description; - - public - stringHttpQueryString::set - mixedparams - - - - Set query string entry/entries. &null; values will unset the variable. - - - - - &reftitle.parameters; - - - - params - - - query string params to add - - - - - - - - &reftitle.returnvalues; - - Returns the current query string. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpQueryString/singleton.xml b/reference/http/HttpQueryString/singleton.xml deleted file mode 100644 index 0f428e3d1f..0000000000 --- a/reference/http/HttpQueryString/singleton.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - HttpQueryString::singleton - HttpQueryString singleton - - - &reftitle.description; - - static public - HttpQueryStringHttpQueryString::singleton - boolglobaltrue - - - - Get a single instance (differentiates between the global setting). - - - - - &reftitle.parameters; - - - - global - - - whether to operate on $_GET and - $_SERVER['QUERY_STRING'] - - - - - - - - &reftitle.returnvalues; - - Returns always the same HttpQueryString instance regarding the global setting. - - - - - &reftitle.errors; - - Throws HttpRuntimeException. - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpQueryString/toArray.xml b/reference/http/HttpQueryString/toArray.xml deleted file mode 100644 index 7c539c7e7e..0000000000 --- a/reference/http/HttpQueryString/toArray.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpQueryString::toArray - Get query string as array - - - &reftitle.description; - - public - arrayHttpQueryString::toArray - - - - - Get the query string represented as associative array. - - - - - &reftitle.returnvalues; - - Returns the array representation of the query string. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpQueryString/toString.xml b/reference/http/HttpQueryString/toString.xml deleted file mode 100644 index 0ff14fda39..0000000000 --- a/reference/http/HttpQueryString/toString.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - HttpQueryString::toString - Get query string - - - &reftitle.description; - - public - stringHttpQueryString::toString - - - - - Get the query string. - - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns the string representation of the query string. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpQueryString/xlate.xml b/reference/http/HttpQueryString/xlate.xml deleted file mode 100644 index 62b2537972..0000000000 --- a/reference/http/HttpQueryString/xlate.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - HttpQueryString::xlate - Change query strings charset - - - &reftitle.description; - - public - boolHttpQueryString::xlate - stringie - stringoe - - - - Converts the query string from the source encoding ie to the target encoding oe. - - - - Don't use any character set that can contain NUL bytes like UTF-16. - - - - - This method requires ext/iconv to be enabled and loaded. - - - - - - &reftitle.parameters; - - - - ie - - - input encoding - - - - - oe - - - output encoding - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest.xml b/reference/http/HttpRequest.xml deleted file mode 100644 index 22beca8319..0000000000 --- a/reference/http/HttpRequest.xml +++ /dev/null @@ -1,403 +0,0 @@ - - - - - The <classname>HttpRequest</classname> - HttpRequest - -
- &reftitle.classsynopsis; - - HttpRequest - - HttpRequest - - - -
- - -
- Class Members -
- &reftitle.properties; -
- Instance Properties - - - - Modifiers - Type - Name - Description - - - - - private - array - options - request options to configure the request; see &link.http.request.options; - - - private - array - postFields - form data: "fieldvalue")]]> - - - private - array - postFiles - files to upload: "image", "file" => "/home/u/images/u.png", "type" => "image/png"))]]> - - - private - array - responseInfo - information (statistical) about the request/response; see &link.http.request.info; - - - private - HttpMessage - responseMessage - the response message - - - private - integer - responseCode - the numerical response code - - - private - string - responseStatus - the literal response status text - - - private - integer - method - the request method to use - - - private - string - url - the request url - - - private - string - contentType - the content type to use for raw post requests - - - private - string - rawPostData - raw post data - - - private - string - queryData - query parameters - - - private - string - putFile - the file to upload with a PUT request - - - private - string - putData - raw data to upload with a PUT request - - - private - HttpMessage - history - the whole request/response history if history logging is enabled - - - public - boolean - recordHistory - whether to enable history logging - - - -
-
-
- &reftitle.constants; - - - <tgroup cols="3"> - <thead> - <row> - <entry>Type</entry> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>integer</entry> - <entry>METH_GET</entry> - <entry>GET request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_HEAD</entry> - <entry>HEAD request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_POST</entry> - <entry>POST request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_PUT</entry> - <entry>PUT request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_DELETE</entry> - <entry>DELETE request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_OPTIONS</entry> - <entry>OPTIONS request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_TRACE</entry> - <entry>TRACE request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_CONNECT</entry> - <entry>CONNECT request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_PROPFIND</entry> - <entry>PROPFIND request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_PROPPATCH</entry> - <entry>PROPPATCH request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_MKCOL</entry> - <entry>MKCOL request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_COPY</entry> - <entry>COPY request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_MOVE</entry> - <entry>MOVE request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_LOCK</entry> - <entry>LOCK request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_UNLOCK</entry> - <entry>UNLOCK request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_VERSION_CONTROL</entry> - <entry>VERSION-CONTROL request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_REPORT</entry> - <entry>REPORT request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_CHECKOUT</entry> - <entry>CHECKOUT request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_CHECKIN</entry> - <entry>CHECKIN request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_UNCHECKOUT</entry> - <entry>UNCHECKOUT request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_MKWORKSPACE</entry> - <entry>MKWORKSPACE request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_UPDATE</entry> - <entry>UPDATE request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_LABEL</entry> - <entry>LABEL request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_MERGE</entry> - <entry>MERGE request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_BASELINE_CONTROL</entry> - <entry>BASELINE-CONTROL request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_MKACTIVITY</entry> - <entry>MKACTIVITY request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>METH_ACL</entry> - <entry>ACL request method</entry> - </row> - <row> - <entry>integer</entry> - <entry>VERSION_1_0</entry> - <entry>HTTP protocol version 1.0</entry> - </row> - <row> - <entry>integer</entry> - <entry>VERSION_1_1</entry> - <entry>HTTP protocol version 1.1</entry> - </row> - <row> - <entry>integer</entry> - <entry>VERSION_ANY</entry> - <entry>any HTTP protocol version</entry> - </row> - <row> - <entry>integer</entry> - <entry>AUTH_BASIC</entry> - <entry>basic authentication</entry> - </row> - <row> - <entry>integer</entry> - <entry>AUTH_DIGEST</entry> - <entry>digest authentication</entry> - </row> - <row> - <entry>integer</entry> - <entry>AUTH_NTLM</entry> - <entry>NTLM authentication</entry> - </row> - <row> - <entry>integer</entry> - <entry>AUTH_GSSNEG</entry> - <entry>GSS negotiate authentication</entry> - </row> - <row> - <entry>integer</entry> - <entry>AUTH_ANY</entry> - <entry>any authentication</entry> - </row> - <row> - <entry>integer</entry> - <entry>PROXY_SOCKS4</entry> - <entry>SOCKS v4 proxy</entry> - </row> - <row> - <entry>integer</entry> - <entry>PROXY_SOCKS5</entry> - <entry>SOCKS v5 proxy</entry> - </row> - <row> - <entry>integer</entry> - <entry>PROXY_HTTP</entry> - <entry>HTTP proxy</entry> - </row> - <row> - <entry>integer</entry> - <entry>SSL_VERSION_TLSv1</entry> - <entry>use TLS v1</entry> - </row> - <row> - <entry>integer</entry> - <entry>SSL_VERSION_SSLv2</entry> - <entry>use SSL v2</entry> - </row> - <row> - <entry>integer</entry> - <entry>SSL_VERSION_SSLv3</entry> - <entry>use SSL v3</entry> - </row> - <row> - <entry>integer</entry> - <entry>SSL_VERSION_ANY</entry> - <entry>use any SSL/TLS method</entry> - </row> - <row> - <entry>integer</entry> - <entry>IPRESOLVE_V4</entry> - <entry>resolve via IPv4 only</entry> - </row> - <row> - <entry>integer</entry> - <entry>IPRESOLVE_V6</entry> - <entry>resolve via IPv6 only</entry> - </row> - <row> - <entry>integer</entry> - <entry>IPRESOLVE_ANY</entry> - <entry>use any resolving methods</entry> - </row> - </tbody> - </tgroup> - </table> - </section> - </section> -</partintro> -&reference.http.entities.HttpRequest; -</phpdoc:classref> - - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/http/HttpRequest/addCookies.xml b/reference/http/HttpRequest/addCookies.xml deleted file mode 100644 index dce7adfe78..0000000000 --- a/reference/http/HttpRequest/addCookies.xml +++ /dev/null @@ -1,133 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> -<refentry xml:id="httprequest.addcookies" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HttpRequest::addCookies</refname> - <refpurpose>Add cookies</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <modifier>public</modifier> - <type>bool</type><methodname>HttpRequest::addCookies</methodname> - <methodparam><type>array</type><parameter>cookies</parameter></methodparam> - </methodsynopsis> - - <para> - Add custom cookies. - </para> - ¬e.http.request.encodecookies; - ¬e.http.request.affects.any; - - </refsect1> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>cookies</parameter></term> - <listitem> - <para> - an associative array containing any cookie name/value pairs to add - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - &return.success; - </para> - </refsect1> - - <!-- Use when ERRORS exist - <refsect1 role="errors"> - &reftitle.errors; - <para> - When does this function throw E_* level errors, or exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>HttpRequest::addCookies</function> example - -addCookies( - array( - "cookie_name" => "cookie value", - ) -); -?> -]]> - - - - - - - &reftitle.seealso; - - - HttpRequest::setCookies - - - - - - - - diff --git a/reference/http/HttpRequest/addHeaders.xml b/reference/http/HttpRequest/addHeaders.xml deleted file mode 100644 index 995481f3fe..0000000000 --- a/reference/http/HttpRequest/addHeaders.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - HttpRequest::addHeaders - Add headers - - - &reftitle.description; - - public - boolHttpRequest::addHeaders - arrayheaders - - - - Add request header name/value pairs. - - - - - &reftitle.parameters; - - - - headers - - - an associative array as parameter containing additional header name/value pairs - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/addPostFields.xml b/reference/http/HttpRequest/addPostFields.xml deleted file mode 100644 index fe2ae67044..0000000000 --- a/reference/http/HttpRequest/addPostFields.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - HttpRequest::addPostFields - Add post fields - - - &reftitle.description; - - public - boolHttpRequest::addPostFields - arraypost_data - - - - Adds POST data entries, leaving previously set unchanged, unless a - post entry with the same name already exists. - - - Affects only POST and custom requests. - - - - - &reftitle.parameters; - - - - post_data - - - an associative array as parameter containing the post fields - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/addPostFile.xml b/reference/http/HttpRequest/addPostFile.xml deleted file mode 100644 index 786e19361a..0000000000 --- a/reference/http/HttpRequest/addPostFile.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - HttpRequest::addPostFile - Add post file - - - &reftitle.description; - - public - boolHttpRequest::addPostFile - stringname - stringfile - stringcontent_type"application/x-octetstream" - - - - Add a file to the POST request, leaving previously set files unchanged. - - - Affects only POST and custom requests. Cannot be used with raw post data. - - - - - &reftitle.parameters; - - - - name - - - the form element name - - - - - file - - - the path to the file - - - - - content_type - - - the content type of the file - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; if the content type seems not to contain a - primary and a secondary content type part. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/addPutData.xml b/reference/http/HttpRequest/addPutData.xml deleted file mode 100644 index 93dc6ecef1..0000000000 --- a/reference/http/HttpRequest/addPutData.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - HttpRequest::addPutData - Add put data - - - &reftitle.description; - - public - boolHttpRequest::addPutData - stringput_data - - - - Add PUT data, leaving previously set PUT data unchanged. - - - Affects only PUT requests. - - - - - &reftitle.parameters; - - - - put_data - - - the data to concatenate - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/addQueryData.xml b/reference/http/HttpRequest/addQueryData.xml deleted file mode 100644 index ef63d28308..0000000000 --- a/reference/http/HttpRequest/addQueryData.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - HttpRequest::addQueryData - Add query data - - - &reftitle.description; - - public - boolHttpRequest::addQueryData - arrayquery_params - - - - Add parameters to the query parameter list, leaving previously set unchanged. - - - Affects any request type. - - - - - &reftitle.parameters; - - - - query_params - - - an associative array as parameter containing the query fields to add - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/addRawPostData.xml b/reference/http/HttpRequest/addRawPostData.xml deleted file mode 100644 index cd216d9f0e..0000000000 --- a/reference/http/HttpRequest/addRawPostData.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - HttpRequest::addRawPostData - Add raw post data - - - &reftitle.description; - - public - boolHttpRequest::addRawPostData - stringraw_post_data - - - - Add raw post data, leaving previously set raw post data unchanged. - - - Affects only POST and custom requests. - - - - - &reftitle.parameters; - - - - raw_post_data - - - the raw post data to concatenate - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/addSslOptions.xml b/reference/http/HttpRequest/addSslOptions.xml deleted file mode 100644 index 2843d83b27..0000000000 --- a/reference/http/HttpRequest/addSslOptions.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - HttpRequest::addSslOptions - Add ssl options - - - &reftitle.description; - - public - boolHttpRequest::addSslOptions - arrayoptions - - - - Set additional SSL options. - - - - - &reftitle.parameters; - - - - options - - - an associative array as parameter containing additional SSL specific options - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/clearHistory.xml b/reference/http/HttpRequest/clearHistory.xml deleted file mode 100644 index 866dcbd537..0000000000 --- a/reference/http/HttpRequest/clearHistory.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - HttpRequest::clearHistory - Clear history - - - &reftitle.description; - - public - voidHttpRequest::clearHistory - - - - - Clears all history messages. - - - - History is only logged if recordHistory was enabled. - - - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/construct.xml b/reference/http/HttpRequest/construct.xml deleted file mode 100644 index 9beb068b81..0000000000 --- a/reference/http/HttpRequest/construct.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - HttpRequest::__construct - HttpRequest constructor - - - &reftitle.description; - - public - HttpRequest::__construct - stringurl - intrequest_methodHTTP_METH_GET - arrayoptions - - - - Instantiate a new HttpRequest object. - - - - - &reftitle.parameters; - - - - url - - - the target request url - - - - - request_method - - - the request method to use - - - - - options - - - an associative array with request options - - - - - - - - - &reftitle.errors; - - Throws HttpException. - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/enableCookies.xml b/reference/http/HttpRequest/enableCookies.xml deleted file mode 100644 index 489827d229..0000000000 --- a/reference/http/HttpRequest/enableCookies.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - HttpRequest::enableCookies - Enable cookies - - - &reftitle.description; - - public - boolHttpRequest::enableCookies - - - - - Enable automatic sending of received cookies. - - - - Note that custom set cookies will be sent anyway. - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getContentType.xml b/reference/http/HttpRequest/getContentType.xml deleted file mode 100644 index 4e371b2f37..0000000000 --- a/reference/http/HttpRequest/getContentType.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpRequest::getContentType - Get content type - - - &reftitle.description; - - public - stringHttpRequest::getContentType - - - - - Get the previously set content type. - - - - - &reftitle.returnvalues; - - Returns the previously set content type as string. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getCookies.xml b/reference/http/HttpRequest/getCookies.xml deleted file mode 100644 index 937e4d2263..0000000000 --- a/reference/http/HttpRequest/getCookies.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpRequest::getCookies - Get cookies - - - &reftitle.description; - - public - arrayHttpRequest::getCookies - - - - - Get previously set cookies. - - - - - &reftitle.returnvalues; - - Returns an associative array containing any previously set cookies. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getHeaders.xml b/reference/http/HttpRequest/getHeaders.xml deleted file mode 100644 index f46edaaf93..0000000000 --- a/reference/http/HttpRequest/getHeaders.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpRequest::getHeaders - Get headers - - - &reftitle.description; - - public - arrayHttpRequest::getHeaders - - - - - Get previously set request headers. - - - - - &reftitle.returnvalues; - - Returns an associative array containing all currently set headers. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getHistory.xml b/reference/http/HttpRequest/getHistory.xml deleted file mode 100644 index 0e86f25f66..0000000000 --- a/reference/http/HttpRequest/getHistory.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - HttpRequest::getHistory - Get history - - - &reftitle.description; - - public - HttpMessageHttpRequest::getHistory - - - - - Get all sent requests and received responses as an HttpMessage object. - - - If you want to record history, set the instance variable - HttpRequest::recordHistory to &true;. - - - The returned object references the last received response, use HttpMessage::getParentMessage - to access the data of previously sent requests and received responses. - - - - - &reftitle.returnvalues; - - Returns an HttpMessage object representing the complete request/response history. - - - - - &reftitle.errors; - - Throws HttpRuntimeException. - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getMethod.xml b/reference/http/HttpRequest/getMethod.xml deleted file mode 100644 index f1190c4d09..0000000000 --- a/reference/http/HttpRequest/getMethod.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpRequest::getMethod - Get method - - - &reftitle.description; - - public - intHttpRequest::getMethod - - - - - Get the previously set request method. - - - - - &reftitle.returnvalues; - - Returns the currently set request method. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getOptions.xml b/reference/http/HttpRequest/getOptions.xml deleted file mode 100644 index 3e033383ff..0000000000 --- a/reference/http/HttpRequest/getOptions.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpRequest::getOptions - Get options - - - &reftitle.description; - - public - arrayHttpRequest::getOptions - - - - - Get currently set options. - - - - - &reftitle.returnvalues; - - Returns an associative array containing currently set options. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getPostFields.xml b/reference/http/HttpRequest/getPostFields.xml deleted file mode 100644 index 1cb4dffb5e..0000000000 --- a/reference/http/HttpRequest/getPostFields.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - HttpRequest::getPostFields - Get post fields - - - &reftitle.description; - - public - arrayHttpRequest::getPostFields - - - - - Get previously set POST data. - - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns the currently set post fields as associative array. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getPostFiles.xml b/reference/http/HttpRequest/getPostFiles.xml deleted file mode 100644 index e55d790836..0000000000 --- a/reference/http/HttpRequest/getPostFiles.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpRequest::getPostFiles - Get post files - - - &reftitle.description; - - public - arrayHttpRequest::getPostFiles - - - - - Get all previously added POST files. - - - - - &reftitle.returnvalues; - - Returns an array containing currently set post files. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getPutData.xml b/reference/http/HttpRequest/getPutData.xml deleted file mode 100644 index 0796f42242..0000000000 --- a/reference/http/HttpRequest/getPutData.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpRequest::getPutData - Get put data - - - &reftitle.description; - - public - stringHttpRequest::getPutData - - - - - Get previously set PUT data. - - - - - &reftitle.returnvalues; - - Returns a string containing the currently set PUT data. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getPutFile.xml b/reference/http/HttpRequest/getPutFile.xml deleted file mode 100644 index f0a54c2e32..0000000000 --- a/reference/http/HttpRequest/getPutFile.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpRequest::getPutFile - Get put file - - - &reftitle.description; - - public - stringHttpRequest::getPutFile - - - - - Get previously set put file. - - - - - &reftitle.returnvalues; - - Returns a string containing the path to the currently set put file. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getQueryData.xml b/reference/http/HttpRequest/getQueryData.xml deleted file mode 100644 index 72cc9c7323..0000000000 --- a/reference/http/HttpRequest/getQueryData.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpRequest::getQueryData - Get query data - - - &reftitle.description; - - public - stringHttpRequest::getQueryData - - - - - Get the current query data in form of an urlencoded query string. - - - - - &reftitle.returnvalues; - - Returns a string containing the urlencoded query. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getRawPostData.xml b/reference/http/HttpRequest/getRawPostData.xml deleted file mode 100644 index 1a2fd5c3eb..0000000000 --- a/reference/http/HttpRequest/getRawPostData.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - HttpRequest::getRawPostData - Get raw post data - - - &reftitle.description; - - public - stringHttpRequest::getRawPostData - - - - - Get previously set raw post data. - - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns a string containing the currently set raw post data. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getRawRequestMessage.xml b/reference/http/HttpRequest/getRawRequestMessage.xml deleted file mode 100644 index 75a14bd632..0000000000 --- a/reference/http/HttpRequest/getRawRequestMessage.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - HttpRequest::getRawRequestMessage - Get raw request message - - - &reftitle.description; - - public - stringHttpRequest::getRawRequestMessage - - - - - Get sent HTTP message. - - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns an HttpMessage in a form of a string. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getRawResponseMessage.xml b/reference/http/HttpRequest/getRawResponseMessage.xml deleted file mode 100644 index 4ab540c4eb..0000000000 --- a/reference/http/HttpRequest/getRawResponseMessage.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - HttpRequest::getRawResponseMessage - Get raw response message - - - &reftitle.description; - - public - stringHttpRequest::getRawResponseMessage - - - - - Get the entire HTTP response. - - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns the complete web server response, including the headers in a form of a string. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getRequestMessage.xml b/reference/http/HttpRequest/getRequestMessage.xml deleted file mode 100644 index 7ac6d07dff..0000000000 --- a/reference/http/HttpRequest/getRequestMessage.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - HttpRequest::getRequestMessage - Get request message - - - &reftitle.description; - - public - HttpMessageHttpRequest::getRequestMessage - - - - - Get sent HTTP message. - - - If redirects were allowed and several responses were received, the data - references the last received response. Use HttpMessage::getParentMessage - to access the data of previously sent requests within this request cycle. - - - - Note that the internal request message is immutable, that means that the - request message received through HttpRequest::getRequestMessage will - always look the same for the same request, regardless of any changes you - may have made to the returned object. - - - - - - &reftitle.returnvalues; - - Returns an HttpMessage object representing the sent request. - - - - - &reftitle.errors; - - Throws HttpMalformedHeadersException, HttpEncodingException. - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getResponseBody.xml b/reference/http/HttpRequest/getResponseBody.xml deleted file mode 100644 index 027049ec89..0000000000 --- a/reference/http/HttpRequest/getResponseBody.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - HttpRequest::getResponseBody - Get response body - - - &reftitle.description; - - public - stringHttpRequest::getResponseBody - - - - - Get the response body after the request has been sent. - - - If redirects were allowed and several responses were received, the data - references the last received response. - - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns a string containing the response body. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getResponseCode.xml b/reference/http/HttpRequest/getResponseCode.xml deleted file mode 100644 index 67d0c0c199..0000000000 --- a/reference/http/HttpRequest/getResponseCode.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - HttpRequest::getResponseCode - Get response code - - - &reftitle.description; - - public - intHttpRequest::getResponseCode - - - - - Get the response code after the request has been sent. - - - If redirects were allowed and several responses were received, the data - references the last received response. - - - - - &reftitle.returnvalues; - - Returns an int representing the response code. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getResponseCookies.xml b/reference/http/HttpRequest/getResponseCookies.xml deleted file mode 100644 index 459a9957fe..0000000000 --- a/reference/http/HttpRequest/getResponseCookies.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - HttpRequest::getResponseCookies - Get response cookie(s) - - - &reftitle.description; - - public - arrayHttpRequest::getResponseCookies - intflags0 - arrayallowed_extras - - - - Get response cookie(s) after the request has been sent. - - - If redirects were allowed and several responses were received, the data - references the last received response. - - - - - &reftitle.parameters; - - - - flags - - - http_parse_cookie flags - - - - - allowed_extras - - - allowed keys treated as extra information instead of cookie names - - - - - - - - &reftitle.returnvalues; - - Returns an array of stdClass objects like http_parse_cookie would return. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getResponseData.xml b/reference/http/HttpRequest/getResponseData.xml deleted file mode 100644 index 9290b59f6e..0000000000 --- a/reference/http/HttpRequest/getResponseData.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - HttpRequest::getResponseData - Get response data - - - &reftitle.description; - - public - arrayHttpRequest::getResponseData - - - - - * Get all response data after the request has been sent. - - - If redirects were allowed and several responses were received, the data - references the last received response. - - - - - &reftitle.returnvalues; - - Returns an associative array with the key "headers" containing an associative - array holding all response headers, as well as the key "body" containing a - string with the response body. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getResponseHeader.xml b/reference/http/HttpRequest/getResponseHeader.xml deleted file mode 100644 index 290eb450c0..0000000000 --- a/reference/http/HttpRequest/getResponseHeader.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - HttpRequest::getResponseHeader - Get response header(s) - - - &reftitle.description; - - public - mixedHttpRequest::getResponseHeader - stringname - - - - Get response header(s) after the request has been sent. - - - If redirects were allowed and several responses were received, the data - references the last received response. - - - - - &reftitle.parameters; - - - - name - - - header to read; if empty, all response headers will be returned - - - - - - - - &reftitle.returnvalues; - - 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. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getResponseInfo.xml b/reference/http/HttpRequest/getResponseInfo.xml deleted file mode 100644 index 3afa8756ad..0000000000 --- a/reference/http/HttpRequest/getResponseInfo.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - HttpRequest::getResponseInfo - Get response info - - - &reftitle.description; - - public - mixedHttpRequest::getResponseInfo - stringname - - - - Get response info after the request has been sent. - - - See http_get for a full list of returned info. - - - If redirects were allowed and several responses were received, the data - references the last received response. - - - - - &reftitle.parameters; - - - - name - - - the info to read; if empty or omitted, an associative array containing - all available info will be returned - - - - - - - - &reftitle.returnvalues; - - Returns either a scalar containing the value of the info matching name if - requested, &false; on failure, or an associative array containing all - available info. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getResponseMessage.xml b/reference/http/HttpRequest/getResponseMessage.xml deleted file mode 100644 index 0ff59e58ac..0000000000 --- a/reference/http/HttpRequest/getResponseMessage.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - HttpRequest::getResponseMessage - Get response message - - - &reftitle.description; - - public - HttpMessageHttpRequest::getResponseMessage - - - - - Get the full response as HttpMessage object after the request has been sent. - - - If redirects were allowed and several responses were received, the data - references the last received response. Use HttpMessage::getParentMessage - to access the data of previously received responses within this request - cycle. - - - - - &reftitle.returnvalues; - - Returns an HttpMessage object of the response. - - - - - &reftitle.errors; - - Throws HttpException, HttpRuntimeException. - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getResponseStatus.xml b/reference/http/HttpRequest/getResponseStatus.xml deleted file mode 100644 index 711a255ccc..0000000000 --- a/reference/http/HttpRequest/getResponseStatus.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpRequest::getResponseStatus - Get response status - - - &reftitle.description; - - public - stringHttpRequest::getResponseStatus - - - - - Get the response status (i.e. the string after the response code) after the message has been sent. - - - - - &reftitle.returnvalues; - - Returns a string containing the response status text. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getSslOptions.xml b/reference/http/HttpRequest/getSslOptions.xml deleted file mode 100644 index ae1b0c1796..0000000000 --- a/reference/http/HttpRequest/getSslOptions.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - HttpRequest::getSslOptions - Get ssl options - - - &reftitle.description; - - public - arrayHttpRequest::getSslOptions - - - - - Get previously set SSL options. - - - - - &reftitle.returnvalues; - - Returns an associative array containing any previously set SSL options. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/getUrl.xml b/reference/http/HttpRequest/getUrl.xml deleted file mode 100644 index 7daf203418..0000000000 --- a/reference/http/HttpRequest/getUrl.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - HttpRequest::getUrl - Get url - - - &reftitle.description; - - public - stringHttpRequest::getUrl - - - - - Get the previously set request URL. - - - - - &reftitle.returnvalues; - - Returns the currently set request url as string. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/resetCookies.xml b/reference/http/HttpRequest/resetCookies.xml deleted file mode 100644 index f9897e5d0a..0000000000 --- a/reference/http/HttpRequest/resetCookies.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - HttpRequest::resetCookies - Reset cookies - - - &reftitle.description; - - public - boolHttpRequest::resetCookies - boolsession_onlyfalse - - - - Reset all automatically received/sent cookies. - - - - Note that custom set cookies are not affected. - - - - - - &reftitle.parameters; - - - - session_only - - - whether only session cookies should be reset (needs libcurl >= v7.15.4, else libcurl >= v7.14.1) - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/send.xml b/reference/http/HttpRequest/send.xml deleted file mode 100644 index 3382fd06d4..0000000000 --- a/reference/http/HttpRequest/send.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - HttpRequest::send - Send request - - - &reftitle.description; - - public - HttpMessageHttpRequest::send - - - - - Send the HTTP request. - - - - 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. - - - - - - &reftitle.returnvalues; - - Returns the received response as HttpMessage object. - - - - - &reftitle.errors; - - Throws HttpRuntimeException, HttpRequestException, HttpMalformedHeaderException, HttpEncodingException. - - - - - - - - - &reftitle.examples; - - - GET example - -setOptions(array('lastmodified' => filemtime('local.rss'))); -$r->addQueryData(array('category' => 3)); -try { - $r->send(); - if ($r->getResponseCode() == 200) { - file_put_contents('local.rss', $r->getResponseBody()); - } -} catch (HttpException $ex) { - echo $ex; -} -?> -]]> - - - - POST example - -setOptions(array('cookies' => array('lang' => 'de'))); -$r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t')); -$r->addPostFile('image', 'profile.jpg', 'image/jpeg'); -try { - echo $r->send()->getBody(); -} catch (HttpException $ex) { - echo $ex; -} -?> -]]> - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/setBody.xml b/reference/http/HttpRequest/setBody.xml deleted file mode 100644 index 7eabfe3565..0000000000 --- a/reference/http/HttpRequest/setBody.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - HttpRequest::setBody - Set request body to send, overwriting previously set request body. - - - - &reftitle.description; - - boolHttpRequest::setBody - stringrequest_body_data - - - Set request body to send, overwriting previously set request body. - - - - - &reftitle.parameters; - - - - request_body_data - - - The request body to overwrite the existing request body with. - - Ensure that a Content-Type is specified in the request body. - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - - - This method was previously available as - HttpRequest::setRawPostData. - - - - - - &reftitle.seealso; - - - HttpRequest::setRawPostData - - - - - - diff --git a/reference/http/HttpRequest/setContentType.xml b/reference/http/HttpRequest/setContentType.xml deleted file mode 100644 index 83faa16219..0000000000 --- a/reference/http/HttpRequest/setContentType.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - HttpRequest::setContentType - Set content type - - - &reftitle.description; - - public - boolHttpRequest::setContentType - stringcontent_type - - - - Set the content type the post request should have. - - - - - &reftitle.parameters; - - - - content_type - - - the content type of the request (primary/secondary) - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; if the content type does not seem to - contain a primary and a secondary part. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/setCookies.xml b/reference/http/HttpRequest/setCookies.xml deleted file mode 100644 index 9c474b76e4..0000000000 --- a/reference/http/HttpRequest/setCookies.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - HttpRequest::setCookies - Set cookies - - - &reftitle.description; - - public - boolHttpRequest::setCookies - arraycookies - - - - Set custom cookies. - - - - - &reftitle.parameters; - - - - cookies - - - an associative array as parameter containing cookie name/value pairs; - if empty or omitted, all previously set cookies will be unset - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/setHeaders.xml b/reference/http/HttpRequest/setHeaders.xml deleted file mode 100644 index 32a7ec21a2..0000000000 --- a/reference/http/HttpRequest/setHeaders.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - HttpRequest::setHeaders - Set headers - - - &reftitle.description; - - public - boolHttpRequest::setHeaders - arrayheaders - - - - Set request header name/value pairs. - - - - - &reftitle.parameters; - - - - headers - - - an associative array as parameter containing header name/value pairs; - if empty or omitted, all previously set headers will be unset - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/setMethod.xml b/reference/http/HttpRequest/setMethod.xml deleted file mode 100644 index 214ae258e8..0000000000 --- a/reference/http/HttpRequest/setMethod.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - HttpRequest::setMethod - Set method - - - &reftitle.description; - - public - boolHttpRequest::setMethod - intrequest_method - - - - Set the request method. - - - - - &reftitle.parameters; - - - - request_method - - - the request method to use - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/setOptions.xml b/reference/http/HttpRequest/setOptions.xml deleted file mode 100644 index e5c00286fb..0000000000 --- a/reference/http/HttpRequest/setOptions.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - HttpRequest::setOptions - Set options - - - &reftitle.description; - - public - boolHttpRequest::setOptions - arrayoptions - - - - Set the request options to use. - - &see.http.request.options; - - - - &reftitle.parameters; - - - - options - - - 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 - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/setPostFields.xml b/reference/http/HttpRequest/setPostFields.xml deleted file mode 100644 index c792a06578..0000000000 --- a/reference/http/HttpRequest/setPostFields.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - HttpRequest::setPostFields - Set post fields - - - &reftitle.description; - - public - boolHttpRequest::setPostFields - arraypost_data - - - - Set the POST data entries, overwriting previously set POST data. - - - Affects only POST and custom requests. - - - - - &reftitle.parameters; - - - - post_data - - - an associative array containing the post fields; - if empty, the post data will be unset - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/setPostFiles.xml b/reference/http/HttpRequest/setPostFiles.xml deleted file mode 100644 index e33832bfab..0000000000 --- a/reference/http/HttpRequest/setPostFiles.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - HttpRequest::setPostFiles - Set post files - - - &reftitle.description; - - public - boolHttpRequest::setPostFiles - arraypost_files - - - - Set files to post, overwriting previously set post files. - - - Affects only POST and requests. Cannot be used with raw post data. - - - - - &reftitle.parameters; - - - - post_files - - - an array containing the files to post; - if empty, the post files will be unset - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/setPutData.xml b/reference/http/HttpRequest/setPutData.xml deleted file mode 100644 index a2dbe528e5..0000000000 --- a/reference/http/HttpRequest/setPutData.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - HttpRequest::setPutData - Set put data - - - &reftitle.description; - - public - boolHttpRequest::setPutData - stringput_data - - - - Set PUT data to send, overwriting previously set PUT data. - - - Affects only PUT requests. - - - Only either PUT data or PUT file can be used for each request. - PUT data has higher precedence and will be used even if a PUT - file is set. - - - - - &reftitle.parameters; - - - - put_data - - - the data to upload - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/setPutFile.xml b/reference/http/HttpRequest/setPutFile.xml deleted file mode 100644 index 181382d5e3..0000000000 --- a/reference/http/HttpRequest/setPutFile.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - HttpRequest::setPutFile - Set put file - - - &reftitle.description; - - public - boolHttpRequest::setPutFile - stringfile"" - - - - Set file to put. Affects only PUT requests. - - - - - &reftitle.parameters; - - - - file - - - the path to the file to send; - if empty or omitted the put file will be unset - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/setQueryData.xml b/reference/http/HttpRequest/setQueryData.xml deleted file mode 100644 index 650d0adaa5..0000000000 --- a/reference/http/HttpRequest/setQueryData.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - HttpRequest::setQueryData - Set query data - - - &reftitle.description; - - public - boolHttpRequest::setQueryData - mixedquery_data - - - - Set the URL query parameters to use, overwriting previously set query parameters. - - - Affects any request types. - - - - - &reftitle.parameters; - - - - query_data - - - a string or associative array parameter containing the pre-encoded - query string or to be encoded query fields; - if empty, the query data will be unset - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/setRawPostData.xml b/reference/http/HttpRequest/setRawPostData.xml deleted file mode 100644 index b55700fd55..0000000000 --- a/reference/http/HttpRequest/setRawPostData.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - HttpRequest::setRawPostData - Set raw post data - - - &reftitle.description; - - public - boolHttpRequest::setRawPostData - stringraw_post_data - - - - Set raw post data to send, overwriting previously set raw post data. Don't - forget to specify a content type. Affects only POST and custom requests. - - - Only either post fields or raw post data can be used for each request. - Raw post data has higher precedence and will be used even if post fields - are set. - - - - - This function alias is DEPRECATED and only - exists for backwards compatibility reasons. The use of this function - is not recommended, as it may be removed from PHP in the future. - HttpRequest::setBody should be used instead. - - - - - - &reftitle.parameters; - - - - raw_post_data - - - raw post data - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpRequest::setBody - - - - - - - - diff --git a/reference/http/HttpRequest/setSslOptions.xml b/reference/http/HttpRequest/setSslOptions.xml deleted file mode 100644 index 0a531d6d31..0000000000 --- a/reference/http/HttpRequest/setSslOptions.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - HttpRequest::setSslOptions - Set ssl options - - - &reftitle.description; - - public - boolHttpRequest::setSslOptions - arrayoptions - - - - Set SSL options. - - - - - &reftitle.parameters; - - - - options - - - an associative array containing any SSL specific options; - if empty or omitted, the SSL options will be reset - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequest/setUrl.xml b/reference/http/HttpRequest/setUrl.xml deleted file mode 100644 index 3825c2dd73..0000000000 --- a/reference/http/HttpRequest/setUrl.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - HttpRequest::setUrl - Set URL - - - &reftitle.description; - - public - boolHttpRequest::setUrl - stringurl - - - - Set the request URL. - - - - - &reftitle.parameters; - - - - url - - - the request url - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequestPool.xml b/reference/http/HttpRequestPool.xml deleted file mode 100644 index 7880b5c3f7..0000000000 --- a/reference/http/HttpRequestPool.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - The <classname>HttpRequestPool</classname> class - HttpRequestPool - -
- &reftitle.classsynopsis; - - HttpRequestPool - - HttpRequestPool - - Iterator - - - Countable - - - - -
- -
- Class Members -
- &reftitle.properties; - - The HttpRequestPool class does not have any properties. - -
-
- &reftitle.constants; - - The HttpRequestPool class does not have any constants. - -
-
- -&reference.http.entities.HttpRequestPool; - - - - diff --git a/reference/http/HttpRequestPool/attach.xml b/reference/http/HttpRequestPool/attach.xml deleted file mode 100644 index 1dcc92531b..0000000000 --- a/reference/http/HttpRequestPool/attach.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - HttpRequestPool::attach - Attach HttpRequest - - - &reftitle.description; - - public - boolHttpRequestPool::attach - HttpRequestrequest - - - - Attach an HttpRequest object to this HttpRequestPool. - - - - Set all options prior attaching! - - - - - - &reftitle.parameters; - - - - request - - - an HttpRequest object not already attached to any HttpRequestPool object - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Throws HttpInvalidParamException, HttpRequestException, - HttpRequestPoolException, HttpEncodingException. - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequestPool/construct.xml b/reference/http/HttpRequestPool/construct.xml deleted file mode 100644 index 7b4117a3b4..0000000000 --- a/reference/http/HttpRequestPool/construct.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - HttpRequestPool::__construct - HttpRequestPool constructor - - - &reftitle.description; - - public HttpRequestPool::__construct - HttpRequestrequest - HttpRequest... - - - - Instantiate a new HttpRequestPool object. An HttpRequestPool is - able to send several HttpRequests in parallel. - - - Accepts virtually infinite optional parameters each referencing an HttpRequest object. - - - - - &reftitle.parameters; - - - - request - - - HttpRequest object to attach - - - - - ... - - - - - - - - - - - &reftitle.errors; - - Throws HttpRequestPoolException (HttpRequestException, HttpInvalidParamException). - - - - - - - - - &reftitle.examples; - - - A <classname>HttpRequestPool</classname> example - -send(); - foreach($pool as $request) { - printf("%s is %s (%d)\n", - $request->getUrl(), - $request->getResponseCode() ? 'alive' : 'not alive', - $request->getResponseCode() - ); - } -} catch (HttpException $e) { - echo $e; -} -?> -]]> - - - - - - - - - - - - diff --git a/reference/http/HttpRequestPool/destruct.xml b/reference/http/HttpRequestPool/destruct.xml deleted file mode 100644 index df1c281117..0000000000 --- a/reference/http/HttpRequestPool/destruct.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - HttpRequestPool::__destruct - HttpRequestPool destructor - - - &reftitle.description; - - voidHttpRequestPool::__destruct - - - - - Clean up HttpRequestPool object. - - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequestPool/detach.xml b/reference/http/HttpRequestPool/detach.xml deleted file mode 100644 index 59a6c021fc..0000000000 --- a/reference/http/HttpRequestPool/detach.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - HttpRequestPool::detach - Detach HttpRequest - - - &reftitle.description; - - boolHttpRequestPool::detach - HttpRequestrequest - - - - Detach an HttpRequest object from this HttpRequestPool. - - - - - &reftitle.parameters; - - - - request - - - an HttpRequest object attached to this HttpRequestPool object - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Throws HttpInvalidParamException, HttpRequestPoolException. - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequestPool/getAttachedRequests.xml b/reference/http/HttpRequestPool/getAttachedRequests.xml deleted file mode 100644 index 49d52f84ee..0000000000 --- a/reference/http/HttpRequestPool/getAttachedRequests.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - HttpRequestPool::getAttachedRequests - Get attached requests - - - &reftitle.description; - - arrayHttpRequestPool::getAttachedRequests - - - - - Get attached HttpRequest objects. - - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns an array containing all currently attached HttpRequest objects. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequestPool/getFinishedRequests.xml b/reference/http/HttpRequestPool/getFinishedRequests.xml deleted file mode 100644 index dc25a7b893..0000000000 --- a/reference/http/HttpRequestPool/getFinishedRequests.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - HttpRequestPool::getFinishedRequests - Get finished requests - - - &reftitle.description; - - arrayHttpRequestPool::getFinishedRequests - - - - - Get attached HttpRequest objects that already have finished their work. - - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns an array containing all attached HttpRequest objects that already have finished their work. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequestPool/reset.xml b/reference/http/HttpRequestPool/reset.xml deleted file mode 100644 index 0f75009051..0000000000 --- a/reference/http/HttpRequestPool/reset.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - HttpRequestPool::reset - Reset request pool - - - &reftitle.description; - - voidHttpRequestPool::reset - - - - - Detach all attached HttpRequest objects. - - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequestPool/send.xml b/reference/http/HttpRequestPool/send.xml deleted file mode 100644 index 3176917545..0000000000 --- a/reference/http/HttpRequestPool/send.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - HttpRequestPool::send - Send all requests - - - &reftitle.description; - - boolHttpRequestPool::send - - - - - Send all attached HttpRequest objects in parallel. - - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Throws HttpRequestPoolException (HttpSocketException, HttpRequestException, HttpMalformedHeaderException). - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpRequestPool/socketPerform.xml b/reference/http/HttpRequestPool/socketPerform.xml deleted file mode 100644 index 4c61174fa8..0000000000 --- a/reference/http/HttpRequestPool/socketPerform.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - HttpRequestPool::socketPerform - Perform socket actions - - - &reftitle.description; - - protected - boolHttpRequestPool::socketPerform - - - - - Returns &true; until each request has finished its transaction. - - - - - &reftitle.returnvalues; - - Returns &true; until each request has finished its transaction. - - - - - - - - - - - &reftitle.examples; - - - A <function>HttpRequestPool::socketPerform</function> example - -socketPerform()) { - if (!$this->socketSelect()) { - throw new HttpSocketExcpetion; - } - } - } - - protected final function socketPerform() - { - $result = parent::socketPerform(); - foreach ($this->getFinishedRequests() as $r) { - $this->detach($r); - // handle response of finished request - } - return $result; - } -} -?> -]]> - - - - - - - - - - - - diff --git a/reference/http/HttpRequestPool/socketSelect.xml b/reference/http/HttpRequestPool/socketSelect.xml deleted file mode 100644 index f34f511d8e..0000000000 --- a/reference/http/HttpRequestPool/socketSelect.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - HttpRequestPool::socketSelect - Perform socket select - - - &reftitle.description; - - protected - boolHttpRequestPool::socketSelect - floattimeout0 - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/HttpResponse.xml b/reference/http/HttpResponse.xml deleted file mode 100644 index d8c0ea6f04..0000000000 --- a/reference/http/HttpResponse.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - The <classname>HttpResponse</classname> - HttpResponse - -
- &reftitle.classsynopsis; - - HttpResponse - - HttpResponse - - - -
- - -
- Class Members -
- &reftitle.properties; -
- Static Properties - - - - Modifiers - Type - Name - Description - - - - - protected - boolean - cache - whether caching the response should be attempted - - - protected - boolean - gzip - whether the sent entity should be gzip'ed on the fly - - - protected - string - eTag - the generated or custom ETag - - - protected - integer - lastModified - the generated or custom timestamp of last modification - - - protected - string - cacheControl - Cache-Control setting - - - protected - string - contentType - the Content-Type of the sent entity - - - protected - string - contentDisposition - the Content-Disposition of the sent entity - - - protected - integer - bufferSize - the chunk buffer size used for throttling - - - protected - double - throttleDelay - the seconds to delay when throttling - - - -
-
-
- &reftitle.constants; - - - <tgroup cols="3"> - <thead> - <row> - <entry>Type</entry> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>integer</entry> - <entry>REDIRECT</entry> - <entry>guess applicable redirect method</entry> - </row> - <row> - <entry>integer</entry> - <entry>REDIRECT_PERM</entry> - <entry>permanent redirect (<literal>301 Moved permanently</literal>)</entry> - </row> - <row> - <entry>integer</entry> - <entry>REDIRECT_FOUND</entry> - <entry>standard redirect (<literal>302 Found</literal>)</entry> - </row> - <row> - <entry>integer</entry> - <entry>REDIRECT_POST</entry> - <entry>redirect applicable to POST requests (<literal>303 See other</literal>)</entry> - </row> - <row> - <entry>integer</entry> - <entry>REDIRECT_PROXY</entry> - <entry>proxy redirect (<literal>305 Use proxy</literal>)</entry> - </row> - <row> - <entry>integer</entry> - <entry>REDIRECT_TEMP</entry> - <entry>temporary redirect (<literal>307 Temporary Redirect</literal>)</entry> - </row> - </tbody> - </tgroup> - </table> - </section> - </section> -</partintro> -&reference.http.entities.HttpResponse; -</phpdoc:classref> - - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/http/HttpResponse/capture.xml b/reference/http/HttpResponse/capture.xml deleted file mode 100644 index be6db5be7f..0000000000 --- a/reference/http/HttpResponse/capture.xml +++ /dev/null @@ -1,106 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> -<refentry xml:id="httpresponse.capture" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HttpResponse::capture</refname> - <refpurpose>Capture script output</refpurpose> - </refnamediv> - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <modifier>static</modifier> - <type>void</type><methodname>HttpResponse::capture</methodname> - <void/> - </methodsynopsis> - <para> - Capture script output. - </para> - </refsect1> - - <!-- Use when ERRORS exist - <refsect1 role="errors"> - &reftitle.errors; - <para> - When does this function throw E_* level errors, or exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here</entry> - <entry>Description of change</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>HttpResponse::capture</function> example - - -]]> - - - - - - - - &reftitle.seealso; - - - HttpResponse::send - - - - - - - - diff --git a/reference/http/HttpResponse/getBufferSize.xml b/reference/http/HttpResponse/getBufferSize.xml deleted file mode 100644 index 46987fc402..0000000000 --- a/reference/http/HttpResponse/getBufferSize.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - HttpResponse::getBufferSize - Get buffer size - - - &reftitle.description; - - static - intHttpResponse::getBufferSize - - - - Get current buffer size. - - - - &reftitle.returnvalues; - - Returns an int representing the current buffer size in bytes. - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::setBufferSize - HttpResponse::getThrottleDelay - HttpResponse::setThrottleDelay - - - - - - - - diff --git a/reference/http/HttpResponse/getCache.xml b/reference/http/HttpResponse/getCache.xml deleted file mode 100644 index afc250e5ab..0000000000 --- a/reference/http/HttpResponse/getCache.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - HttpResponse::getCache - Get cache - - - &reftitle.description; - - static - boolHttpResponse::getCache - - - - Get current caching setting. - - - - &reftitle.returnvalues; - - Returns &true; if caching should be attempted, else &false;. - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::setCacheControl - HttpResponse::getCacheControl - HttpResponse::setCache - - - - - - - - diff --git a/reference/http/HttpResponse/getCacheControl.xml b/reference/http/HttpResponse/getCacheControl.xml deleted file mode 100644 index e24691903d..0000000000 --- a/reference/http/HttpResponse/getCacheControl.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - HttpResponse::getCacheControl - Get cache control - - - &reftitle.description; - - static - stringHttpResponse::getCacheControl - - - - Get current Cache-Control header setting. - - - - &reftitle.returnvalues; - - Returns the current cache control setting as a string like sent in a header. - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::setCacheControl - HttpResponse::setCache - HttpResponse::getCache - - - - - - - - diff --git a/reference/http/HttpResponse/getContentDisposition.xml b/reference/http/HttpResponse/getContentDisposition.xml deleted file mode 100644 index 1bae2e76fe..0000000000 --- a/reference/http/HttpResponse/getContentDisposition.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - HttpResponse::getContentDisposition - Get content disposition - - - &reftitle.description; - - static - stringHttpResponse::getContentDisposition - - - - Get current Content-Disposition setting. - - - - &reftitle.returnvalues; - - Returns the current content disposition as string like sent in a header. - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::setContentDisposition - HttpResponse::getContentType - HttpResponse::setContentType - - - - - - - - diff --git a/reference/http/HttpResponse/getContentType.xml b/reference/http/HttpResponse/getContentType.xml deleted file mode 100644 index 3b939a0437..0000000000 --- a/reference/http/HttpResponse/getContentType.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - HttpResponse::getContentType - Get content type - - - &reftitle.description; - - static - stringHttpResponse::getContentType - - - - Get current Content-Type header setting. - - - - &reftitle.returnvalues; - - Returns the currently set content type as string. - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getContentDisposition - HttpResponse::setContentDisposition - HttpResponse::setContentType - HttpResponse::guessContentType - - - - - - - - diff --git a/reference/http/HttpResponse/getData.xml b/reference/http/HttpResponse/getData.xml deleted file mode 100644 index 7f5270309e..0000000000 --- a/reference/http/HttpResponse/getData.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - HttpResponse::getData - Get data - - - &reftitle.description; - - static - stringHttpResponse::getData - - - - Get the previously set data to be sent. - - - - &reftitle.returnvalues; - - Returns a string containing the previously set data to send. - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::setData - HttpResponse::getFile - HttpResponse::setFile - HttpResponse::getStream - HttpResponse::setStream - - - - - - - - diff --git a/reference/http/HttpResponse/getETag.xml b/reference/http/HttpResponse/getETag.xml deleted file mode 100644 index 5b63ec491c..0000000000 --- a/reference/http/HttpResponse/getETag.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - HttpResponse::getETag - Get ETag - - - &reftitle.description; - - static - stringHttpResponse::getETag - - - - Get calculated or previously set custom ETag. - - - - &reftitle.returnvalues; - - Returns the calculated or previously set ETag as unquoted string. - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getLastModified - HttpResponse::setLastModified - HttpResponse::setETag - - - - - - - - diff --git a/reference/http/HttpResponse/getFile.xml b/reference/http/HttpResponse/getFile.xml deleted file mode 100644 index d1d0783576..0000000000 --- a/reference/http/HttpResponse/getFile.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - HttpResponse::getFile - Get file - - - &reftitle.description; - - static - stringHttpResponse::getFile - - - - Get the previously set file to be sent. - - - - &reftitle.returnvalues; - - Returns the previously set path to the file to send as string. - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getData - HttpResponse::setData - HttpResponse::setFile - HttpResponse::getStream - HttpResponse::setStream - - - - - - - - diff --git a/reference/http/HttpResponse/getGzip.xml b/reference/http/HttpResponse/getGzip.xml deleted file mode 100644 index 824d5d7cc1..0000000000 --- a/reference/http/HttpResponse/getGzip.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - HttpResponse::getGzip - Get gzip - - - &reftitle.description; - - static - boolHttpResponse::getGzip - - - - Get current gzip'ing setting. - - - - &reftitle.returnvalues; - - Returns &true; if GZip compression is enabled, else &false;. - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::setGzip - - - - - - - - diff --git a/reference/http/HttpResponse/getHeader.xml b/reference/http/HttpResponse/getHeader.xml deleted file mode 100644 index b37ed8bdec..0000000000 --- a/reference/http/HttpResponse/getHeader.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - HttpResponse::getHeader - Get header - - - &reftitle.description; - - static - mixedHttpResponse::getHeader - stringname - - - Get header(s) about to be sent. - - - - &http.maynotwork.SAPI; Apache2 w/PHP < 5.1.3. - - - - - &reftitle.parameters; - - - - name - - - specifies the name of the header to read; - if empty or omitted, an associative array with all headers will be returned - - - - - - - - &reftitle.returnvalues; - - Returns either a string containing the value of the header matching name, - &false; on failure, or an associative array with all headers. - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::setHeader - - - - - - - - diff --git a/reference/http/HttpResponse/getLastModified.xml b/reference/http/HttpResponse/getLastModified.xml deleted file mode 100644 index aafea05b4a..0000000000 --- a/reference/http/HttpResponse/getLastModified.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - HttpResponse::getLastModified - Get last modified - - - &reftitle.description; - - static - intHttpResponse::getLastModified - - - - Get calculated or previously set custom Last-Modified date. - - - - &reftitle.returnvalues; - - Returns the calculated or previously set Unix timestamp. - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::setLastModified - HttpResponse::getETag - HttpResponse::setETag - - - - - - - - diff --git a/reference/http/HttpResponse/getRequestBody.xml b/reference/http/HttpResponse/getRequestBody.xml deleted file mode 100644 index 1de28cf70c..0000000000 --- a/reference/http/HttpResponse/getRequestBody.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - HttpResponse::getRequestBody - Get request body - - - &reftitle.description; - - static - stringHttpResponse::getRequestBody - - - - &info.function.alias; http_get_request_body. - - - - - diff --git a/reference/http/HttpResponse/getRequestBodyStream.xml b/reference/http/HttpResponse/getRequestBodyStream.xml deleted file mode 100644 index e1c3b24bef..0000000000 --- a/reference/http/HttpResponse/getRequestBodyStream.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - HttpResponse::getRequestBodyStream - Get request body stream - - - &reftitle.description; - - static - resourceHttpResponse::getRequestBodyStream - - - - &info.function.alias; http_get_request_body_stream. - - - - - diff --git a/reference/http/HttpResponse/getRequestHeaders.xml b/reference/http/HttpResponse/getRequestHeaders.xml deleted file mode 100644 index 1e7b85223d..0000000000 --- a/reference/http/HttpResponse/getRequestHeaders.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - HttpResponse::getRequestHeaders - Get request headers - - - &reftitle.description; - - static - arrayHttpResponse::getRequestHeaders - - - - &info.function.alias; http_get_request_headers. - - - - - diff --git a/reference/http/HttpResponse/getStream.xml b/reference/http/HttpResponse/getStream.xml deleted file mode 100644 index 876dbd2300..0000000000 --- a/reference/http/HttpResponse/getStream.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - HttpResponse::getStream - Get Stream - - - &reftitle.description; - - static - resourceHttpResponse::getStream - - - - Get the previously set resource to be sent. - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns the previously set resource. - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getData - HttpResponse::setData - HttpResponse::getFile - HttpResponse::setFile - HttpResponse::setStream - - - - - - - - diff --git a/reference/http/HttpResponse/getThrottleDelay.xml b/reference/http/HttpResponse/getThrottleDelay.xml deleted file mode 100644 index 3ee642cb0f..0000000000 --- a/reference/http/HttpResponse/getThrottleDelay.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - HttpResponse::getThrottleDelay - Get throttle delay - - - &reftitle.description; - - static - floatHttpResponse::getThrottleDelay - - - - Get the current throttle delay. - - - - &reftitle.returnvalues; - - Returns a double representing the throttle delay in seconds. - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getBufferSize - HttpResponse::setBufferSize - HttpResponse::setThrottleDelay - - - - - - - - diff --git a/reference/http/HttpResponse/guessContentType.xml b/reference/http/HttpResponse/guessContentType.xml deleted file mode 100644 index d576366669..0000000000 --- a/reference/http/HttpResponse/guessContentType.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - HttpResponse::guessContentType - Guess content type - - - &reftitle.description; - - static - stringHttpResponse::guessContentType - stringmagic_file - intmagic_modeMAGIC_MIME - - - Attempts to guess the content type of supplied payload through libmagic. - - - If the attempt is successful, the guessed Content-Type will automatically - be set as response Content-Type. - - - - &reftitle.parameters; - - - - magic_file - - - specifies the magic.mime database to use - - - - - magic_mode - - - flags for libmagic - - - - - - - - &reftitle.returnvalues; - - Returns the guessed content type on success&return.falseforfailure;. - - - - - &reftitle.errors; - - Throws HttpRuntimeException, HttpInvalidParamException. - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getContentType - HttpResponse::setContentType - - - - - - - - diff --git a/reference/http/HttpResponse/redirect.xml b/reference/http/HttpResponse/redirect.xml deleted file mode 100644 index 531da71f58..0000000000 --- a/reference/http/HttpResponse/redirect.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - HttpResponse::redirect - Redirect - - - &reftitle.description; - - static - voidHttpResponse::redirect - stringurl - arrayparams - boolsessionfalse - intstatus - - - &info.function.alias; http_redirect. - - - - - diff --git a/reference/http/HttpResponse/send.xml b/reference/http/HttpResponse/send.xml deleted file mode 100644 index 07e7cd761b..0000000000 --- a/reference/http/HttpResponse/send.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - HttpResponse::send - Send response - - - &reftitle.description; - - static - boolHttpResponse::send - boolclean_obtrue - - - Finally send the entity. - - - A successful caching attempt will exit PHP, and write a log entry if the &link.http.configuration; - http.log.cache is set. - &see.http.configuration.force_exit; - - - - &reftitle.parameters; - - - - clean_ob - - - whether to destroy all previously started output handlers and their buffers - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - &reftitle.examples; - - - A <function>HttpResponse::send</function> example - - -]]> - - - - - - - - &reftitle.seealso; - - - HttpResponse::capture - - - - - - - - diff --git a/reference/http/HttpResponse/setBufferSize.xml b/reference/http/HttpResponse/setBufferSize.xml deleted file mode 100644 index d08400d2b6..0000000000 --- a/reference/http/HttpResponse/setBufferSize.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - HttpResponse::setBufferSize - Set buffer size - - - &reftitle.description; - - static - boolHttpResponse::setBufferSize - intbytes - - - Sets the send buffer size of the throttling mechanism. - - ¬e.http.throttling.yields.process; - - - &http.maynotwork.SAPI; FastCGI. - - - - - &reftitle.parameters; - - - - bytes - - - the chunk size in bytes - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getBufferSize - HttpResponse::getThrottleDelay - HttpResponse::setThrottleDelay - - - - - - - - diff --git a/reference/http/HttpResponse/setCache.xml b/reference/http/HttpResponse/setCache.xml deleted file mode 100644 index 6573c44ead..0000000000 --- a/reference/http/HttpResponse/setCache.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - HttpResponse::setCache - Set cache - - - &reftitle.description; - - static - boolHttpResponse::setCache - boolcache - - - Whether it should be attempted to cache the entity. - - - This will result in necessary caching headers and checks of clients - If-Modified-Since and If-None-Match headers. If one of those headers - matches a 304 Not Modified status code will be issued. - - - - If you're using sessions, be sure that you set session.cache_limiter - to something more appropriate than "no-cache"! - - - - - &reftitle.parameters; - - - - cache - - - whether caching should be attempted - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::setCacheControl - HttpResponse::getCacheControl - HttpResponse::getCachel - - - - - - - - diff --git a/reference/http/HttpResponse/setCacheControl.xml b/reference/http/HttpResponse/setCacheControl.xml deleted file mode 100644 index d02d5261aa..0000000000 --- a/reference/http/HttpResponse/setCacheControl.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - HttpResponse::setCacheControl - Set cache control - - - &reftitle.description; - - static - boolHttpResponse::setCacheControl - stringcontrol - intmax_age0 - boolmust_revalidatetrue - - - Define a custom Cache-Control header, usually being private or public; - - - - &reftitle.parameters; - - - - control - - - the primary cache control setting - - - - - max_age - - - the max-age in seconds, suggesting how long the cache entry is valid on the client side - - - - - must_revalidate - - - whether the cached entity should be revalidated by the client for every request - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; if control does not match one of public, private or no-cache. - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getCacheControl - HttpResponse::setCache - HttpResponse::getCache - - - - - - - - diff --git a/reference/http/HttpResponse/setContentDisposition.xml b/reference/http/HttpResponse/setContentDisposition.xml deleted file mode 100644 index 07f897cfc3..0000000000 --- a/reference/http/HttpResponse/setContentDisposition.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - HttpResponse::setContentDisposition - Set content disposition - - - &reftitle.description; - - static - boolHttpResponse::setContentDisposition - stringfilename - boolinlinefalse - - - Set the Content-Disposition. - &http.content.disposition; - - - - &reftitle.parameters; - - - - filename - - - the file name the "Save as..." dialog should display - - - - - inline - - - if set to true and the user agent knows how to handle the content type, - it will probably not cause the popup window to be shown - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getContentDisposition - HttpResponse::getContentType - HttpResponse::setContentType - - - - - - - - diff --git a/reference/http/HttpResponse/setContentType.xml b/reference/http/HttpResponse/setContentType.xml deleted file mode 100644 index 0ba5d1519a..0000000000 --- a/reference/http/HttpResponse/setContentType.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - HttpResponse::setContentType - Set content type - - - &reftitle.description; - - static - boolHttpResponse::setContentType - stringcontent_type - - - Set the Content-Type of the sent entity. - - - - &reftitle.parameters; - - - - content_type - - - the content type of the sent entity (primary/secondary) - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; if the content type does not seem to - contain a primary and secondary content type part. - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getContentDisposition - HttpResponse::setContentDisposition - HttpResponse::getContentType - HttpResponse::guessContentType - - - - - - - - diff --git a/reference/http/HttpResponse/setData.xml b/reference/http/HttpResponse/setData.xml deleted file mode 100644 index d3e6c203b1..0000000000 --- a/reference/http/HttpResponse/setData.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - HttpResponse::setData - Set data - - - &reftitle.description; - - static - boolHttpResponse::setData - mixeddata - - - Set the data to be sent. - - ¬e.http.response.recalculate.etag.lm; - - - &reftitle.parameters; - - - - data - - - data to send - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getData - HttpResponse::getFile - HttpResponse::setFile - HttpResponse::getStream - HttpResponse::setStream - - - - - - - - diff --git a/reference/http/HttpResponse/setETag.xml b/reference/http/HttpResponse/setETag.xml deleted file mode 100644 index 1f49685132..0000000000 --- a/reference/http/HttpResponse/setETag.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - HttpResponse::setETag - Set ETag - - - &reftitle.description; - - static - boolHttpResponse::setETag - stringetag - - - Set a custom ETag. Use this only if you know what you're doing. - - - - &reftitle.parameters; - - - - etag - - - unquoted string as parameter containing the ETag - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getLastModified - HttpResponse::setLastModified - HttpResponse::getETag - - - - - - - - diff --git a/reference/http/HttpResponse/setFile.xml b/reference/http/HttpResponse/setFile.xml deleted file mode 100644 index 22836bcd66..0000000000 --- a/reference/http/HttpResponse/setFile.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - HttpResponse::setFile - Set file - - - &reftitle.description; - - static - boolHttpResponse::setFile - stringfile - - - Set the file to be sent. - - ¬e.http.response.recalculate.etag.lm; - - - &reftitle.parameters; - - - - file - - - the path to the file to send - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getData - HttpResponse::setData - HttpResponse::getFile - HttpResponse::getStream - HttpResponse::setStream - - - - - - - - diff --git a/reference/http/HttpResponse/setGzip.xml b/reference/http/HttpResponse/setGzip.xml deleted file mode 100644 index c175477451..0000000000 --- a/reference/http/HttpResponse/setGzip.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - HttpResponse::setGzip - Set gzip - - - &reftitle.description; - - static - boolHttpResponse::setGzip - boolgzip - - - Enable on-thy-fly gzip'ing of the sent entity. - - - - &reftitle.parameters; - - - - gzip - - - whether GZip compression should be enabled - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getGzip - - - - - - - - diff --git a/reference/http/HttpResponse/setHeader.xml b/reference/http/HttpResponse/setHeader.xml deleted file mode 100644 index b2ae95c57a..0000000000 --- a/reference/http/HttpResponse/setHeader.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - HttpResponse::setHeader - Set header - - - &reftitle.description; - - static - boolHttpResponse::setHeader - stringname - mixedvalue - boolreplacetrue - - - Send an HTTP header. - - - - &reftitle.parameters; - - - - name - - - the name of the header - - - - - value - - - the value of the header; - if not set, no header with this name will be sent - - - - - replace - - - whether an existing header should be replaced - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getHeader - - - - - - - - diff --git a/reference/http/HttpResponse/setLastModified.xml b/reference/http/HttpResponse/setLastModified.xml deleted file mode 100644 index 63a990f5b7..0000000000 --- a/reference/http/HttpResponse/setLastModified.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - HttpResponse::setLastModified - Set last modified - - - &reftitle.description; - - static - boolHttpResponse::setLastModified - inttimestamp - - - Set a custom Last-Modified date. - - - - &reftitle.parameters; - - - - timestamp - - - Unix timestamp representing the last modification time of the sent entity - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getLastModified - HttpResponse::getETag - HttpResponse::setETag - - - - - - - - diff --git a/reference/http/HttpResponse/setStream.xml b/reference/http/HttpResponse/setStream.xml deleted file mode 100644 index 88cdd3fb91..0000000000 --- a/reference/http/HttpResponse/setStream.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - HttpResponse::setStream - Set stream - - - &reftitle.description; - - static - boolHttpResponse::setStream - resourcestream - - - Set the resource to be sent. - - ¬e.http.response.recalculate.etag.lm; - - - &reftitle.parameters; - - - - stream - - - already opened stream from which the data to send will be read - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getData - HttpResponse::setData - HttpResponse::getFile - HttpResponse::setFile - HttpResponse::getStream - - - - - - - - diff --git a/reference/http/HttpResponse/setThrottleDelay.xml b/reference/http/HttpResponse/setThrottleDelay.xml deleted file mode 100644 index 5ea7cae758..0000000000 --- a/reference/http/HttpResponse/setThrottleDelay.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - HttpResponse::setThrottleDelay - Set throttle delay - - - &reftitle.description; - - static - boolHttpResponse::setThrottleDelay - floatseconds - - - Sets the throttle delay. - - ¬e.http.throttling.yields.process; - - - &http.maynotwork.SAPI; FastCGI. - - - - - &reftitle.parameters; - - - - seconds - - - seconds to sleep after each chunk sent - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - HttpResponse::getBufferSize - HttpResponse::setBufferSize - HttpResponse::getThrottleDelay - - - - - - - - diff --git a/reference/http/HttpResponse/status.xml b/reference/http/HttpResponse/status.xml deleted file mode 100644 index 75ecbf2b7c..0000000000 --- a/reference/http/HttpResponse/status.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - HttpResponse::status - Send HTTP response status - - - &reftitle.description; - - static - boolHttpResponse::status - intstatus - - - &info.function.alias; http_send_status. - - - - - diff --git a/reference/http/book.xml b/reference/http/book.xml deleted file mode 100644 index 113df0f11a..0000000000 --- a/reference/http/book.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - HTTP - - - - &reftitle.intro; - - The HTTP extension aims to provide a convenient and powerful - set of functionality for major applications. - - - - If you are looking for documentation of version 2 of this extension, - please find a complete reference at https://mdref.m6w6.name/http. - - - - The HTTP extension eases handling of HTTP URLs, dates, redirects, - headers and messages in a HTTP context (both incoming and outgoing). - It also provides means for client negotiation of preferred language - and charset, as well as a convenient way to exchange arbitrary data - with caching and resuming capabilities. - - - Also provided is a powerful request and parallel interface (PHP 5+), - if the extension is built with cURL support. - - - Additionally to the API reference in this manual you can find - information about how to install and configure as well as - which global constants are predefined in the following sections: - - - - - &reference.http.setup; - &reference.http.constants; - &reference.http.request-options; - - &reference.http.HttpDeflateStream; - &reference.http.HttpInflateStream; - &reference.http.HttpMessage; - &reference.http.HttpQueryString; - &reference.http.HttpRequest; - &reference.http.HttpRequestPool; - &reference.http.HttpResponse; - - &reference.http.reference; - - - - - diff --git a/reference/http/configuration.xml b/reference/http/configuration.xml deleted file mode 100644 index 312082e2ac..0000000000 --- a/reference/http/configuration.xml +++ /dev/null @@ -1,249 +0,0 @@ - - -
- &reftitle.runtime; - &extension.runtime; - -
- HTTP Configuration Options - - - - - &Name; - &Default; - &Changeable; - &Description; - - - - - - http.etag.mode - "MD5" - PHP_INI_ALL - - The hashing algorithm used to generate the ETag. MD5, SHA1, and CRC32 - are always available. If the hash - extension is enabled, any hashing algorithms this extension provides - are available, too. - - - - - http.log.cache - "" - PHP_INI_ALL - - The path (or stream wrapper url) to a log file in which to write successful cache hits. - - - - - http.log.redirect - "" - PHP_INI_ALL - - The path (or stream wrapper url) to a log file in which to write redirects. - - - - - http.log.not_found - "" - PHP_INI_ALL - - The path (or stream wrapper url) to a log file in which to write "file not found" errors. - - - - - http.log.allowed_methods - "" - PHP_INI_ALL - - The path (or stream wrapper url) to a log file in which to write "allowed methods" violations. - - - - - http.log.composite - "" - PHP_INI_ALL - - The path (or stream wrapper url) to a log file in which to write all events. - - - - - http.request.methods.allowed - "" - PHP_INI_ALL - - Allowed request methods. If a client issues a request with a request method - other than listed here, PHP exits with a status of "405 Method not allowed". - &see.http.configuration.force_exit; - - - - - http.request.methods.custom - "" - PHP_INI_PERDIR|PHP_INI_SYSTEM - - Custom request methods. If you want to use any non-standard request methods, - you can register them with this INI setting or http_request_method_register. - - - - - http.request.datashare.cookie - "0" - PHP_INI_SYSTEM - - Whether the global HttpRequestDataShare should by default share cookie information. - - - - - http.request.datashare.dns - "1" - PHP_INI_SYSTEM - - Whether the global HttpRequestDataShare should by default share name lookup information. - - - - - http.request.datashare.ssl - "0" - PHP_INI_SYSTEM - - Whether the global HttpRequestDataShare should by default share SSL session information. - This is not yet implemented in libcurl. - - - - - http.request.datashare.connect - "0" - PHP_INI_SYSTEM - - Whether the global HttpRequestDataShare should by default share connect information. - This is not yet implemented in libcurl. - - - - - http.persistent.handles.limit - "-1" - PHP_INI_SYSTEM - - The maximum amount of persistent handles to keep alive. - - - - - http.persistent.handles.ident - "GLOBAL" - PHP_INI_ALL - - The ident of persistent handles. - - - - - http.send.inflate.start_auto - "0" - PHP_INI_PERDIR|PHP_INI_SYSTEM - - Whether to automatically start the inflate output handler. - - - - - http.send.inflate.start_flags - "0" - PHP_INI_ALL - - Initialization settings for the inflate output handler. - - - - - http.send.deflate.start_auto - "0" - PHP_INI_PERDIR|PHP_INI_SYSTEM - - Whether to automatically start the deflate output handler. - - - - - http.send.deflate.start_flags - "0" - PHP_INI_ALL - - Initialization settings for the deflate output handler. - See deflate constants. - - - - - http.send.not_found_404 - "1" - PHP_INI_ALL - - Whether to automatically exit with a status of "404 Not found", - if http_send_file was not able to find the specified file. - &see.http.configuration.force_exit; - - - - - http.only_exceptions - "0" - PHP_INI_ALL - - Whether all notices/warnings/errors should be thrown as exceptions. - - - - - http.force_exit - "1" - PHP_INI_ALL - - Each occasion where "exits with a status of..." is mentioned, usually causes - the halt of the scripting engine. Disable this option if you alternatively - want to start a discarding (dev/null) output handler and continue script - execution. - - - - - -
- -
- - diff --git a/reference/http/constants.xml b/reference/http/constants.xml deleted file mode 100644 index ca8e7636d7..0000000000 --- a/reference/http/constants.xml +++ /dev/null @@ -1,1296 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - Constants usable with <function>http_support</function> - - - HTTP_SUPPORT - (integer) - - - - querying for this constant will always return &true; - - - - - - HTTP_SUPPORT_REQUESTS - (integer) - - - - whether support to issue HTTP requests is given, ie. libcurl support was compiled in - - - - - - HTTP_SUPPORT_MAGICMIME - (integer) - - - - whether support to guess the Content-Type of HTTP messages is given, ie. libmagic support was compiled in - - - - - - HTTP_SUPPORT_ENCODINGS - (integer) - - - - whether support for zlib encodings is given, ie. libz support was compiled in - - - - - - HTTP_SUPPORT_SSLREQUESTS - (integer) - - - - whether support to issue HTTP requests over SSL is given, ie. linked libcurl was built with SSL support - - - - - - Constants usable with <function>http_parse_params</function> - - - HTTP_PARAMS_ALLOW_COMMA - (integer) - - - - allow commands additionally to semicolons as separator - - - - - - HTTP_PARAMS_ALLOW_FAILURE - (integer) - - - - continue parsing after an error occurred - - - - - - HTTP_PARAMS_RAISE_ERROR - (integer) - - - - raise PHP warnings on parse errors - - - - - - HTTP_PARAMS_DEFAULT - (integer) - - - - all three values above, bitwise or'ed - - - - - - Constants usable with <function>http_parse_cookie</function> and its return value - - - HTTP_COOKIE_PARSE_RAW - (integer) - - - - don't urldecode values - - - - - - HTTP_COOKIE_SECURE - (integer) - - - - whether "secure" was found in the cookie's parameters list - - - - - - HTTP_COOKIE_HTTPONLY - (integer) - - - - whether "httpOnly" was found in the cookie's parameter list - - - - - - Constants usable with <function>http_deflate</function> and <classname>HttpDeflateStream</classname> - - - HTTP_DEFLATE_LEVEL_DEF - (integer) - - - - - - - - - - HTTP_DEFLATE_LEVEL_MIN - (integer) - - - - - - - - - - HTTP_DEFLATE_LEVEL_MAX - (integer) - - - - - - - - - - HTTP_DEFLATE_TYPE_ZLIB - (integer) - - - - - - - - - - HTTP_DEFLATE_TYPE_GZIP - (integer) - - - - - - - - - - HTTP_DEFLATE_TYPE_RAW - (integer) - - - - - - - - - - HTTP_DEFLATE_STRATEGY_DEF - (integer) - - - - - - - - - - HTTP_DEFLATE_STRATEGY_FILT - (integer) - - - - - - - - - - HTTP_DEFLATE_STRATEGY_HUFF - (integer) - - - - - - - - - - HTTP_DEFLATE_STRATEGY_RLE - (integer) - - - - - - - - - - HTTP_DEFLATE_STRATEGY_FIXED - (integer) - - - - - - - - - - Constants usable with <classname>HttpDeflateStream</classname> and <classname>HttpInflateStream</classname> - - - HTTP_ENCODING_STREAM_FLUSH_NONE - (integer) - - - - don't flush - - - - - - HTTP_ENCODING_STREAM_FLUSH_SYNC - (integer) - - - - synchronized flush only - - - - - - HTTP_ENCODING_STREAM_FLUSH_FULL - (integer) - - - - full data flush - - - - - - Constants used for error reporting and Exceptions - - - HTTP_E_RUNTIME - (integer) - - - - runtime error - - - - - - HTTP_E_INVALID_PARAM - (integer) - - - - an invalid parameter was passed - - - - - - HTTP_E_HEADER - (integer) - - - - header() or similar operation failed - - - - - - HTTP_E_MALFORMED_HEADERS - (integer) - - - - HTTP header parse error - - - - - - HTTP_E_REQUEST_METHOD - (integer) - - - - unknown/invalid request method - - - - - - HTTP_E_MESSAGE_TYPE - (integer) - - - - with operation incompatible message type - - - - - - HTTP_E_ENCODING - (integer) - - - - encoding/decoding error - - - - - - HTTP_E_REQUEST - (integer) - - - - request failure - - - - - - HTTP_E_REQUEST_POOL - (integer) - - - - request pool failure - - - - - - HTTP_E_SOCKET - (integer) - - - - socket exception - - - - - - HTTP_E_RESPONSE - (integer) - - - - response failure - - - - - - HTTP_E_URL - (integer) - - - - invalid URL - - - - - - HTTP_E_QUERYSTRING - (integer) - - - - querystring operation failure - - - - - - Constants usable with <classname>HttpMessage</classname> - - - HTTP_MSG_NONE - (integer) - - - - the message is of no specific type - - - - - - HTTP_MSG_REQUEST - (integer) - - - - request style message - - - - - - HTTP_MSG_RESPONSE - (integer) - - - - response style message - - - - - - Constants usable with <classname>HttpQueryString</classname> - - - HTTP_QUERYSTRING_TYPE_BOOL - (integer) - - - - - - - - - - HTTP_QUERYSTRING_TYPE_INT - (integer) - - - - - - - - - - HTTP_QUERYSTRING_TYPE_FLOAT - (integer) - - - - - - - - - - HTTP_QUERYSTRING_TYPE_STRING - (integer) - - - - - - - - - - HTTP_QUERYSTRING_TYPE_ARRAY - (integer) - - - - - - - - - - HTTP_QUERYSTRING_TYPE_OBJECT - (integer) - - - - - - - - - - Constants used for the <literal>httpauthtype</literal> &link.http.request.option; - - - HTTP_AUTH_BASIC - (integer) - - - - use "basic" authentication - - - - - - HTTP_AUTH_DIGEST - (integer) - - - - use "digest" authentication - - - - - - HTTP_AUTH_NTLM - (integer) - - - - use "NTLM" authentication - - - - - - HTTP_AUTH_GSSNEG - (integer) - - - - use "GSS-NEGOTIATE" authentication - - - - - - HTTP_AUTH_ANY - (integer) - - - - try any authentication scheme - - - - - - Constants used for the HTTP <literal>protocol</literal> version &link.http.request.option; - - - HTTP_VERSION_ANY - (integer) - - - - no specific HTTP protocol version - - - - - - HTTP_VERSION_1_0 - (integer) - - - - HTTP version 1.0 - - - - - - HTTP_VERSION_1_1 - (integer) - - - - HTTP version 1.1 - - - - - - Constants used for the SSL <literal>protocol</literal> type and version &link.http.request.option; - - - HTTP_SSL_VERSION_ANY - (integer) - - - - no specific SSL protocol version - - - - - - HTTP_SSL_VERSION_TLSv1 - (integer) - - - - use TLSv1 only - - - - - - HTTP_SSL_VERSION_SSLv3 - (integer) - - - - use SSLv3 only - - - - - - HTTP_SSL_VERSION_SSLv2 - (integer) - - - - use SSLv2 only - - - - - - Constants used for the <literal>proxytype</literal> &link.http.request.option; - - - HTTP_PROXY_SOCKS4 - (integer) - - - - the proxy is a SOCKS4 type proxy - - - - - - HTTP_PROXY_SOCKS5 - (integer) - - - - the proxy is a SOCKS5 type proxy - - - - - - HTTP_PROXY_HTTP - (integer) - - - - standard HTTP proxy - - - - - - Constants used for the <literal>ipresolve</literal> &link.http.request.option; - - - HTTP_IPRESOLVE_V4 - (integer) - - - - use IPv4 only for name lookups - - - - - - HTTP_IPRESOLVE_V6 - (integer) - - - - use IPv6 only for name lookups - - - - - - HTTP_IPRESOLVE_ANY - (integer) - - - - use any IP mechanism only for name lookups - - - - - - Predefined HTTP request method constants - - - HTTP_METH_GET - (integer) - - - - - - - - - - HTTP_METH_HEAD - (integer) - - - - - - - - - - HTTP_METH_POST - (integer) - - - - - - - - - - HTTP_METH_PUT - (integer) - - - - - - - - - - HTTP_METH_DELETE - (integer) - - - - - - - - - - HTTP_METH_OPTIONS - (integer) - - - - - - - - - - HTTP_METH_TRACE - (integer) - - - - - - - - - - HTTP_METH_CONNECT - (integer) - - - - - - - - - - HTTP_METH_PROPFIND - (integer) - - - - - - - - - - HTTP_METH_PROPPATCH - (integer) - - - - - - - - - - HTTP_METH_MKCOL - (integer) - - - - - - - - - - HTTP_METH_COPY - (integer) - - - - - - - - - - HTTP_METH_MOVE - (integer) - - - - - - - - - - HTTP_METH_LOCK - (integer) - - - - - - - - - - HTTP_METH_UNLOCK - (integer) - - - - - - - - - - HTTP_METH_VERSION_CONTROL - (integer) - - - - - - - - - - HTTP_METH_REPORT - (integer) - - - - - - - - - - HTTP_METH_CHECKOUT - (integer) - - - - - - - - - - HTTP_METH_CHECKIN - (integer) - - - - - - - - - - HTTP_METH_UNCHECKOUT - (integer) - - - - - - - - - - HTTP_METH_MKWORKSPACE - (integer) - - - - - - - - - - HTTP_METH_UPDATE - (integer) - - - - - - - - - - HTTP_METH_LABEL - (integer) - - - - - - - - - - HTTP_METH_MERGE - (integer) - - - - - - - - - - HTTP_METH_BASELINE_CONTROL - (integer) - - - - - - - - - - HTTP_METH_MKACTIVITY - (integer) - - - - - - - - - - HTTP_METH_ACL - (integer) - - - - - - - - - - Constants usable with <function>http_redirect</function> - - - HTTP_REDIRECT - (integer) - - - - guess applicable redirect method - - - - - - HTTP_REDIRECT_PERM - (integer) - - - - permanent redirect (301 Moved permanently) - - - - - - HTTP_REDIRECT_FOUND - (integer) - - - - standard redirect (302 Found) - - - - RFC 1945 and RFC 2068 specify that the client is not allowed - to change the method on the redirected request. However, most - existing user agent implementations treat 302 as if it were a 303 - response, performing a GET on the Location field-value regardless - of the original request method. The status codes 303 and 307 have - been added for servers that wish to make unambiguously clear which - kind of reaction is expected of the client. - - - - - - - HTTP_REDIRECT_POST - (integer) - - - - redirect applicable to POST requests (303 See other) - - - - - - HTTP_REDIRECT_PROXY - (integer) - - - - proxy redirect (305 Use proxy) - - - - - - HTTP_REDIRECT_TEMP - (integer) - - - - temporary redirect (307 Temporary Redirect) - - - - - - Constants usable with <function>http_build_url</function> - - - HTTP_URL_REPLACE - (integer) - - - - replace every part of the first URL when there's one of the second URL - - - - - - HTTP_URL_JOIN_PATH - (integer) - - - - join relative paths - - - - - - HTTP_URL_JOIN_QUERY - (integer) - - - - join query strings - - - - - - HTTP_URL_STRIP_USER - (integer) - - - - strip any user authentication information - - - - - - HTTP_URL_STRIP_PASS - (integer) - - - - strip any password authentication information - - - - - - HTTP_URL_STRIP_AUTH - (integer) - - - - strip any authentication information - - - - - - HTTP_URL_STRIP_PORT - (integer) - - - - strip explicit port numbers - - - - - - HTTP_URL_STRIP_PATH - (integer) - - - - strip complete path - - - - - - HTTP_URL_STRIP_QUERY - (integer) - - - - strip query string - - - - - - HTTP_URL_STRIP_FRAGMENT - (integer) - - - - strip any fragments (#identifier) - - - - - - HTTP_URL_STRIP_ALL - (integer) - - - - strip anything but scheme and host - - - - - - - diff --git a/reference/http/functions/caching/http-cache-etag.xml b/reference/http/functions/caching/http-cache-etag.xml deleted file mode 100644 index c3ce12c889..0000000000 --- a/reference/http/functions/caching/http-cache-etag.xml +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - http_cache_etag - Caching by ETag - - - &reftitle.description; - - boolhttp_cache_etag - stringetag - - - Attempts to cache the sent entity by its ETag, either supplied or generated - by the hash algorithm specified by the &link.http.configuration; - http.etag.mode. - - - If the clients If-None-Match header matches the supplied/calculated - ETag, the body is considered cached on the clients side and - a 304 Not Modified status code is issued. - - - A log entry is written to the cache log if the &link.http.configuration; - http.log.cache is set - and the cache attempt was successful. - - ¬e.http.send.API.mayuse; - - If this function is used outside the http_send_*() API, it facilitates the ob_etaghandler. - - - - &reftitle.parameters; - - - - etag - - - custom ETag - - - - - - - - &reftitle.returnvalues; - - &returns.http.false.orexits; with 304 Not Modified if the entity is cached. - &see.http.configuration.force_exit; - - - - - - - - - - - &reftitle.examples; - - - A <function>http_cache_etag</function> example - - -]]> - - - - - - - - &reftitle.seealso; - - - http_cache_last_modified - ob_etaghandler - http_match_etag - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/caching/http-cache-last-modified.xml b/reference/http/functions/caching/http-cache-last-modified.xml deleted file mode 100644 index 5da971a601..0000000000 --- a/reference/http/functions/caching/http-cache-last-modified.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - http_cache_last_modified - Caching by last modification - - - &reftitle.description; - - boolhttp_cache_last_modified - inttimestamp_or_expires - - - Attempts to cache the sent entity by its last modification date. - - - If the supplied argument is greater than 0, it is handled as timestamp - and will be sent as date of last modification. If it is 0 or omitted, - the current time will be sent as Last-Modified date. - If it's negative, it is handled as expiration time in seconds, which means - that if the requested last modification date is not between the calculated timespan, - the Last-Modified header is updated and the actual body will be sent. - - - A log entry will be written to the cache log if the &link.http.configuration; - http.log.cache is set - and the cache attempt was successful. - - ¬e.http.send.API.mayuse; - - - &reftitle.parameters; - - - - timestamp_or_expires - - - Unix timestamp - - - - - - - - &reftitle.returnvalues; - - &returns.http.false.orexits; with 304 Not Modified if the entity is cached. - &see.http.configuration.force_exit; - - - - - - - - - - - &reftitle.examples; - - - A <function>http_cache_last_modified</function> example - - Caching for 5 seconds. - - - -]]> - - - - - - - - &reftitle.seealso; - - - http_cache_etag - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/encodings/http-chunked-decode.xml b/reference/http/functions/encodings/http-chunked-decode.xml deleted file mode 100644 index 31b06cd686..0000000000 --- a/reference/http/functions/encodings/http-chunked-decode.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - http_chunked_decode - Decode chunked-encoded data - - - &reftitle.description; - - stringhttp_chunked_decode - stringencoded - - - Decodes a string which is HTTP-chunked encoded. - - - - &reftitle.parameters; - - - - encoded - - - chunked encoded string - - - - - - - - &reftitle.returnvalues; - - Returns the decoded string on success&return.falseforfailure;. - - - - - - - - - - - &reftitle.examples; - - - A <function>http_chunked_decode</function> example - - -]]> - - &example.outputs; - - - - - - - - - - - - - - diff --git a/reference/http/functions/encodings/http-deflate.xml b/reference/http/functions/encodings/http-deflate.xml deleted file mode 100644 index 5313581391..0000000000 --- a/reference/http/functions/encodings/http-deflate.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - http_deflate - Deflate data - - - &reftitle.description; - - stringhttp_deflate - stringdata - intflags0 - - - Compress data with gzip, zlib AKA deflate or raw deflate encoding. - - - See the deflate constants table for possible values for the flags parameter. - - - - &reftitle.parameters; - - - - data - - - String containing the data that should be encoded - - - - - flags - - - deflate options - - - - - - - - &reftitle.returnvalues; - - Returns the encoded string on success, or &null; on failure. - - - - - - - - - - - - - - &reftitle.seealso; - - - http_inflate - HttpDeflateStream - - - - - - - - diff --git a/reference/http/functions/encodings/http-inflate.xml b/reference/http/functions/encodings/http-inflate.xml deleted file mode 100644 index 744445cefc..0000000000 --- a/reference/http/functions/encodings/http-inflate.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - http_inflate - Inflate data - - - &reftitle.description; - - stringhttp_inflate - stringdata - - - Decompress data compressed with either gzip, deflate AKA zlib or raw - deflate encoding. - - - - &reftitle.parameters; - - - - data - - - string containing the compressed data - - - - - - - - &reftitle.returnvalues; - - Returns the decoded string on success, or &null; on failure. - - - - - - - - - - - - - - &reftitle.seealso; - - - http_deflate - HttpInflateStream - - - - - - - - diff --git a/reference/http/functions/misc/http-build-cookie.xml b/reference/http/functions/misc/http-build-cookie.xml deleted file mode 100644 index 09a29008fa..0000000000 --- a/reference/http/functions/misc/http-build-cookie.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - http_build_cookie - Build cookie string - - - &reftitle.description; - - stringhttp_build_cookie - arraycookie - - - - Build a cookie string from an array/object like returned by http_parse_cookie. - - - - - &reftitle.parameters; - - - - cookie - - - a cookie list like returned from http_parse_cookie - - - - - - - - &reftitle.returnvalues; - - Returns the cookie(s) as string. - - - - - - - - - - - - - - &reftitle.seealso; - - - http_parse_cookie - - - - - - - - diff --git a/reference/http/functions/misc/http-date.xml b/reference/http/functions/misc/http-date.xml deleted file mode 100644 index 9168c699b2..0000000000 --- a/reference/http/functions/misc/http-date.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - http_date - Compose HTTP RFC compliant date - - - &reftitle.description; - - stringhttp_date - inttimestamp - - - Compose a valid HTTP date regarding RFC 1123 - looking like: Wed, 22 Dec 2004 11:34:47 GMT. - - - - &reftitle.parameters; - - - - timestamp - - - Unix timestamp; current time if omitted - - - - - - - - &reftitle.returnvalues; - - Returns the HTTP date as string. - - - - - - - - - - - - - - &reftitle.seealso; - - - date - - - - - - - - diff --git a/reference/http/functions/misc/http-get-request-body-stream.xml b/reference/http/functions/misc/http-get-request-body-stream.xml deleted file mode 100644 index 8f7f2f91a5..0000000000 --- a/reference/http/functions/misc/http-get-request-body-stream.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - http_get_request_body_stream - Get request body as stream - - - &reftitle.description; - - resourcehttp_get_request_body_stream - - - - Create a stream to read the raw request body (e.g. POST or PUT data). - - - This function can only be used once if the request method was another than POST. - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns the raw request body as stream on success or &null; on failure. - - - - - - - - - - - - - - &reftitle.seealso; - - - http_get_request_body - http_get_request_headers - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/misc/http-get-request-body.xml b/reference/http/functions/misc/http-get-request-body.xml deleted file mode 100644 index 03b4e6c856..0000000000 --- a/reference/http/functions/misc/http-get-request-body.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - http_get_request_body - Get request body as string - - - &reftitle.description; - - stringhttp_get_request_body - - - - Get the raw request body (e.g. POST or PUT data). - - - This function can not be used after - http_get_request_body_stream - if the request method was another than POST. - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns the raw request body as string on success or &null; on failure. - - - - - - - - - - - - - - &reftitle.seealso; - - - http_get_request_body_stream - http_get_request_headers - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/misc/http-get-request-headers.xml b/reference/http/functions/misc/http-get-request-headers.xml deleted file mode 100644 index 1ec2e14257..0000000000 --- a/reference/http/functions/misc/http-get-request-headers.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - http_get_request_headers - Get request headers as array - - - &reftitle.description; - - arrayhttp_get_request_headers - - - - Get a list of incoming HTTP headers. - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns an associative array of incoming request headers. - - - - - - - - - - - - - - &reftitle.seealso; - - - http_get_request_body - http_get_request_body_stream - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/misc/http-match-etag.xml b/reference/http/functions/misc/http-match-etag.xml deleted file mode 100644 index e80ec36c41..0000000000 --- a/reference/http/functions/misc/http-match-etag.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - http_match_etag - Match ETag - - - &reftitle.description; - - boolhttp_match_etag - stringetag - boolfor_rangefalse - - - Matches the given ETag against the clients If-Match resp. - If-None-Match HTTP headers. - - - - &reftitle.parameters; - - - - etag - - - the ETag to match - - - - - for_range - - - if set to &true;, the header usually used to validate HTTP ranges will be checked - - - - - - - - &reftitle.returnvalues; - - Returns &true; if ETag matches or the header contained the asterisk ("*"), else &false;. - - - - - - - - - - - - - - &reftitle.seealso; - - - http_match_last_modified - http_match_request_header - http_cache_etag - http_cache_last_modified - ob_etaghandler - - - - - - - - diff --git a/reference/http/functions/misc/http-match-modified.xml b/reference/http/functions/misc/http-match-modified.xml deleted file mode 100644 index bbe1205dac..0000000000 --- a/reference/http/functions/misc/http-match-modified.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - http_match_modified - Match last modification - - - &reftitle.description; - - boolhttp_match_modified - inttimestamp-1 - boolfor_rangefalse - - - Matches the given Unix timestamp against the clients If-Modified-Since - resp. If-Unmodified-Since HTTP headers. - - - - &reftitle.parameters; - - - - timestamp - - - Unix timestamp; current time, if omitted - - - - - for_range - - - if set to &true;, the header usually used to validate HTTP ranges will be checked - - - - - - - - &reftitle.returnvalues; - - Returns &true; if timestamp represents an earlier date than the header, else &false;. - - - - - - - - - - - - - - &reftitle.seealso; - - - http_match_etag - http_match_request_header - http_cache_etag - http_cache_last_modified - - - - - - - - diff --git a/reference/http/functions/misc/http-match-request-header.xml b/reference/http/functions/misc/http-match-request-header.xml deleted file mode 100644 index fe5b99075b..0000000000 --- a/reference/http/functions/misc/http-match-request-header.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - http_match_request_header - Match any header - - - &reftitle.description; - - boolhttp_match_request_header - stringheader - stringvalue - boolmatch_casefalse - - - Match an incoming HTTP header. - - - - &reftitle.parameters; - - - - header - - - the header name (case-insensitive) - - - - - value - - - the header value that should be compared - - - - - match_case - - - whether the value should be compared case sensitively - - - - - - - - &reftitle.returnvalues; - - Returns &true; if header value matches, else &false;. - - - - - - - - - - - - - - &reftitle.seealso; - - - http_match_etag - http_match_last_modified - - - - - - - - diff --git a/reference/http/functions/misc/http-support.xml b/reference/http/functions/misc/http-support.xml deleted file mode 100644 index 7104b0d2c6..0000000000 --- a/reference/http/functions/misc/http-support.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - http_support - Check built-in HTTP support - - - &reftitle.description; - - inthttp_support - intfeature0 - - - Check for features that require external libraries. - - - See the feature support constants table - for possible values for the feature argument. - - - - &reftitle.parameters; - - - - feature - - - feature to probe for - - - - - - - - &reftitle.returnvalues; - - Returns integer, whether requested feature is supported, - or a bitmask with all supported features if feature was omitted. - - - - - - - - - - - &reftitle.examples; - - - A <function>http_support</function> example - - -]]> - - - - - - - - - - - - diff --git a/reference/http/functions/negotiation/http-negotiate-charset.xml b/reference/http/functions/negotiation/http-negotiate-charset.xml deleted file mode 100644 index f638e766f8..0000000000 --- a/reference/http/functions/negotiation/http-negotiate-charset.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - http_negotiate_charset - Negotiate client's preferred character set - - - &reftitle.description; - - stringhttp_negotiate_charset - arraysupported - arrayresult - - - This function negotiates the clients preferred charset based on its - Accept-Charset HTTP header. The qualifier is recognized and charsets - without qualifier are rated highest. - - - - &reftitle.parameters; - - - - supported - - - array containing the supported charsets as values - - - - - result - - - will be filled with an array containing the negotiation results - - - - - - - - &reftitle.returnvalues; - - Returns the negotiated charset or the default charset (i.e. first array entry) if none match. - - - - - - - - - - - &reftitle.examples; - - - Using <function>http_negotiate_charset</function> - - -]]> - - - - - - - - - - - - diff --git a/reference/http/functions/negotiation/http-negotiate-content-type.xml b/reference/http/functions/negotiation/http-negotiate-content-type.xml deleted file mode 100644 index 04132a5e60..0000000000 --- a/reference/http/functions/negotiation/http-negotiate-content-type.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - http_negotiate_content_type - Negotiate client's preferred content type - - - &reftitle.description; - - stringhttp_negotiate_content_type - arraysupported - arrayresult - - - This function negotiates the clients preferred content type based on its - Accept HTTP header. The qualifier is recognized and content types - without qualifier are rated highest. - - - - &reftitle.parameters; - - - - supported - - - array containing the supported content types as values - - - - - result - - - will be filled with an array containing the negotiation results - - - - - - - - &reftitle.returnvalues; - - Returns the negotiated content type or the default content type (i.e. first array entry) if none match. - - - - - - - - - - - &reftitle.examples; - - - Using <function>http_negotiate_content_type</function> - - -]]> - - - - - - - - - - - - diff --git a/reference/http/functions/negotiation/http-negotiate-language.xml b/reference/http/functions/negotiation/http-negotiate-language.xml deleted file mode 100644 index 40820d8283..0000000000 --- a/reference/http/functions/negotiation/http-negotiate-language.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - http_negotiate_language - Negotiate client's preferred language - - - &reftitle.description; - - stringhttp_negotiate_language - arraysupported - arrayresult - - - This function negotiates the client's preferred language based on its - Accept-Language HTTP header. The qualifier is recognized and languages - without qualifier are rated highest. The qualifier will be decreased by - 10% for partial matches (i.e. matching primary language). - - - - &reftitle.parameters; - - - - supported - - - array containing the supported languages as values - - - - - result - - - will be filled with an array containing the negotiation results - - - - - - - - &reftitle.returnvalues; - - Returns the negotiated language or the default language (i.e. first array entry) if none match. - - - - - - - - - - - &reftitle.examples; - - - Using <function>http_negotiate_language</function> - - -]]> - - - - - - - - - - - - diff --git a/reference/http/functions/outputhandlers/ob-deflatehandler.xml b/reference/http/functions/outputhandlers/ob-deflatehandler.xml deleted file mode 100644 index e584589140..0000000000 --- a/reference/http/functions/outputhandlers/ob-deflatehandler.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - ob_deflatehandler - Deflate output handler - - - &reftitle.description; - - stringob_deflatehandler - stringdata - intmode - - - &http.use.ob_start; - - ¬e.http.ob.once; - - The deflate output buffer handler can only be used once. - - - It conflicts with ob_gzhandler and - zlib.output_compression as well and should - not be used after mbstring extension's mb_output_handler and - session extension's URL-Rewriter (AKA session.use_trans_sid). - - - - - - - - - - - - - - &reftitle.seealso; - - - ob_inflatehandler - ob_start - - - - - - - - diff --git a/reference/http/functions/outputhandlers/ob-etaghandler.xml b/reference/http/functions/outputhandlers/ob-etaghandler.xml deleted file mode 100644 index b832a5c2f1..0000000000 --- a/reference/http/functions/outputhandlers/ob-etaghandler.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - ob_etaghandler - ETag output handler - - - &reftitle.description; - - stringob_etaghandler - stringdata - intmode - - - &http.use.ob_start; - - - Output buffer handler generating an ETag with the hash algorithm - specified with the &link.http.configuration; http.etag.mode. - - - This output handler is used by http_cache_etag. - - - - - - - - - - - - - - &reftitle.seealso; - - - http_cache_etag - http_match_etag - - - - - - - - diff --git a/reference/http/functions/outputhandlers/ob-inflatehandler.xml b/reference/http/functions/outputhandlers/ob-inflatehandler.xml deleted file mode 100644 index b1ff1b56d0..0000000000 --- a/reference/http/functions/outputhandlers/ob-inflatehandler.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - ob_inflatehandler - Inflate output handler - - - &reftitle.description; - - stringob_inflatehandler - stringdata - intmode - - - &http.use.ob_start; - - - Same restrictions as with ob_deflatehandler apply. - - - - - - - - - - - - - - &reftitle.seealso; - - - ob_deflatehandler - ob_start - - - - - - - diff --git a/reference/http/functions/parsers/http-parse-cookie.xml b/reference/http/functions/parsers/http-parse-cookie.xml deleted file mode 100644 index 887f739245..0000000000 --- a/reference/http/functions/parsers/http-parse-cookie.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - http_parse_cookie - Parse HTTP cookie - - - &reftitle.description; - - objecthttp_parse_cookie - stringcookie - intflags - arrayallowed_extras - - - Parses HTTP cookies like sent in a response into a struct. - - - - &reftitle.parameters; - - - - cookie - - - string containing the value of a Set-Cookie response header - - - - - flags - - - parse flags (HTTP_COOKIE_PARSE_RAW) - - - - - allowed_extras - - - array containing recognized extra keys; - by default all unknown keys will be treated as cookie names - - - - - - - - &reftitle.returnvalues; - - Returns a stdClass object on success&return.falseforfailure;. - - - - - - - - - - - &reftitle.examples; - - - Using <function>http_parse_cookie</function> - - -]]> - - &example.outputs; - - Array - ( - [foo] => bar - [bar] => baz - ) - - [extras] => Array - ( - [comment] => - ) - - [flags] => 16 - [expires] => 0 - [path] => / - [domain] => example.com -) -]]> - - - - - - - - &reftitle.seealso; - - - http_parse_headers - http_parse_message - http_build_cookie - - - - - - - - diff --git a/reference/http/functions/parsers/http-parse-headers.xml b/reference/http/functions/parsers/http-parse-headers.xml deleted file mode 100644 index c25373a826..0000000000 --- a/reference/http/functions/parsers/http-parse-headers.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - http_parse_headers - Parse HTTP headers - - - &reftitle.description; - - arrayhttp_parse_headers - stringheader - - - Parses HTTP headers into an associative array. - - - - &reftitle.parameters; - - - - header - - - string containing HTTP headers - - - - - - - - &reftitle.returnvalues; - - Returns an array on success&return.falseforfailure;. - - - - - - - - - - - &reftitle.examples; - - - Using <function>http_parse_headers</function> - - -]]> - - &example.outputs; - - text/html; charset=UTF-8 - [Server] => Funky/1.0 - [Set-Cookie] => Array - ( - [0] => foo=bar - [1] => baz=quux - ) - [Folded] => works - too -) -]]> - - - - - - - - &reftitle.seealso; - - - http_parse_message - http_parse_cookie - - - - - - - - diff --git a/reference/http/functions/parsers/http-parse-message.xml b/reference/http/functions/parsers/http-parse-message.xml deleted file mode 100644 index ab78779fe1..0000000000 --- a/reference/http/functions/parsers/http-parse-message.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - http_parse_message - Parse HTTP messages - - - &reftitle.description; - - objecthttp_parse_message - stringmessage - - - Parses the HTTP message into a simple - recursive object. - - - - &reftitle.parameters; - - - - message - - - string containing a single HTTP message or several consecutive HTTP messages - - - - - - - - &reftitle.returnvalues; - - Returns a hierarchical object structure of the parsed messages. - - - - - - - - - - - &reftitle.examples; - - - Using <function>http_parse_message</function> - - 3)))); -?> -]]> - - &example.outputs.similar; - - 2 - [httpVersion] => 1.1 - [responseCode] => 200 - [headers] => Array - ( - [Content-Length] => 3 - [Server] => Apache - ) - [body] => Hi! - [parentMessage] => stdClass object - ( - [type] => 2 - [httpVersion] => 1.1 - [responseCode] => 302 - [headers] => Array - ( - [Content-Length] => 0 - [Location] => ... - ) - [body] => - [parentMessage] => ... - ) -) -]]> - - - - - - - - &reftitle.seealso; - - - http_parse_headers - the HttpMessage class - - - - - - - - diff --git a/reference/http/functions/parsers/http-parse-params.xml b/reference/http/functions/parsers/http-parse-params.xml deleted file mode 100644 index 7afac4e2d6..0000000000 --- a/reference/http/functions/parsers/http-parse-params.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - http_parse_params - Parse parameter list - - - &reftitle.description; - - objecthttp_parse_params - stringparam - intflagsHTTP_PARAMS_DEFAULT - - - Parse parameter list. - - - See the params parsing constants table for possible - values of the flags argument. - - - - &reftitle.parameters; - - - - param - - - Parameters - - - - - flags - - - Parse flags - - - - - - - - &reftitle.returnvalues; - - Returns parameter list as stdClass object. - - - - - - - - - - - &reftitle.examples; - - - A <function>http_parse_params</function> example - - -]]> - - &example.outputs; - - - array(2) { - [0]=> - string(9) "text/html" - [1]=> - array(1) { - ["charset"]=> - string(4) "utf8" - } - } -} -]]> - - - - - - - - &reftitle.seealso; - - - http_parse_headers - http_parse_cookie - http_parse_message - - - - - - - - diff --git a/reference/http/functions/persistenthandles/http-persistent-handles-clean.xml b/reference/http/functions/persistenthandles/http-persistent-handles-clean.xml deleted file mode 100644 index 3333addc5f..0000000000 --- a/reference/http/functions/persistenthandles/http-persistent-handles-clean.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - http_persistent_handles_clean - Clean up persistent handles - - - &reftitle.description; - - stringhttp_persistent_handles_clean - stringident - - - Clean up (close) persistent handles, optionally identified with ident. - - - - &reftitle.parameters; - - - - clean - - - the identification string - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - http_persistent_handles_ident - http_persistent_handles_count - - - - - - - - diff --git a/reference/http/functions/persistenthandles/http-persistent-handles-count.xml b/reference/http/functions/persistenthandles/http-persistent-handles-count.xml deleted file mode 100644 index e950921881..0000000000 --- a/reference/http/functions/persistenthandles/http-persistent-handles-count.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - http_persistent_handles_count - Stat persistent handles - - - &reftitle.description; - - objecthttp_persistent_handles_count - - - - List statistics about persistent handles usage. - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - Returns persistent handles statistics as stdClass object on success&return.falseforfailure;. - - - - - - - - - - - &reftitle.examples; - - - A <function>http_persistent_handles_count</function> example - - -]]> - - &example.outputs; - - Array - ( - [GLOBAL] => Array - ( - [used] => 0 - [free] => 1 - ) - - ) - - [http_request_datashare] => Array - ( - [GLOBAL] => Array - ( - [used] => 1 - [free] => 0 - ) - - ) - - [http_request_pool] => Array - ( - ) - -) -]]> - - - - - - - - &reftitle.seealso; - - - http_persistent_handles_ident - http_persistent_handles_clean - - - - - - - - diff --git a/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml b/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml deleted file mode 100644 index f4af88526a..0000000000 --- a/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - http_persistent_handles_ident - Get/set ident of persistent handles - - - &reftitle.description; - - stringhttp_persistent_handles_ident - stringident - - - Query or define the ident of persistent handles. - - - - &reftitle.parameters; - - - - ident - - - the identification string - - - - - - - - &reftitle.returnvalues; - - Returns the prior ident as string on success&return.falseforfailure;. - - - - - - - - - - &reftitle.examples; - - - A <function>http_persistent_handles_ident</function> example - - -]]> - - &example.outputs; - -GLOBAL -CUSTOM -stdClass Object -( - [http_request] => Array - ( - [MyApp1] => Array - ( - [used] => 0 - [free] => 1 - ) - - ) - - [http_request_datashare] => Array - ( - [GLOBAL] => Array - ( - [used] => 1 - [free] => 0 - ) - - ) - - [http_request_pool] => Array - ( - ) - -) - - - - - - - &reftitle.seealso; - - - http_persistent_handles_count - http_persistent_handles_clean - - - - - - - diff --git a/reference/http/functions/requests/http-get.xml b/reference/http/functions/requests/http-get.xml deleted file mode 100644 index 6bfeef2a26..0000000000 --- a/reference/http/functions/requests/http-get.xml +++ /dev/null @@ -1,189 +0,0 @@ - - - - - - http_get - Perform GET request - - - &reftitle.description; - - stringhttp_get - stringurl - arrayoptions - arrayinfo - - - Performs an HTTP GET request on the supplied url. - - &see.http.request.options; - - - &reftitle.parameters; - - - - url - - - URL - - - - - options - - - &link.http.request.options; - - - - - info - - - Will be filled with request/response information - - - - - - - - &reftitle.returnvalues; - - &returns.http.response; - - - - - - - - - - - &reftitle.examples; - - - A <function>http_get</function> example - -1), $info); -print_r($info); -?> -]]> - - &example.outputs; - - 'http://www.example.com/', - 'response_code' => 302, - 'connect_code' => 0, - 'filetime' => -1, - 'total_time' => 0.212348, - 'namelookup_time' => 0.038296, - 'connect_time' => 0.104144, - 'pretransfer_time' => 0.104307, - 'starttransfer_time' => 0.212077, - 'redirect_time' => 0, - 'redirect_count' => 0, - 'size_upload' => 0, - 'size_download' => 218, - 'speed_download' => 1026, - 'speed_upload' => 0, - 'header_size' => 307, - 'request_size' => 103, - 'ssl_verifyresult' => 0, - 'ssl_engines' => - array ( - 0 => 'dynamic', - 1 => 'cswift', - 2 => 'chil', - 3 => 'atalla', - 4 => 'nuron', - 5 => 'ubsec', - 6 => 'aep', - 7 => 'sureware', - 8 => '4758cca', - ), - 'content_length_download' => 218, - 'content_length_upload' => 0, - 'content_type' => 'text/html', - 'httpauth_avail' => 0, - 'proxyauth_avail' => 0, - 'num_connects' => 1, - 'os_errno' => 0, - 'error' => '', -)]]> - - - - - - - - - - - diff --git a/reference/http/functions/requests/http-head.xml b/reference/http/functions/requests/http-head.xml deleted file mode 100644 index 5179fa5205..0000000000 --- a/reference/http/functions/requests/http-head.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - http_head - Perform HEAD request - - - &reftitle.description; - - stringhttp_head - stringurl - arrayoptions - arrayinfo - - - Performs an HTTP HEAD request on the supplied url. - - &see.http.request.options; - - - &reftitle.parameters; - - - - url - - - URL - - - - - options - - - &link.http.request.options; - - - - - info - - - &link.http.request.info; - - - - - - - - &reftitle.returnvalues; - - &returns.http.response; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/functions/requests/http-post-data.xml b/reference/http/functions/requests/http-post-data.xml deleted file mode 100644 index a335a37893..0000000000 --- a/reference/http/functions/requests/http-post-data.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - http_post_data - Perform POST request with pre-encoded data - - - &reftitle.description; - - stringhttp_post_data - stringurl - stringdata - arrayoptions - arrayinfo - - - Performs an HTTP POST request on the supplied url. - - &see.http.request.options; - - - &reftitle.parameters; - - - - url - - - URL - - - - - data - - - String containing the pre-encoded post data - - - - - options - - - &link.http.request.options; - - - - - info - - - &link.http.request.info; - - - - - - - - &reftitle.returnvalues; - - &returns.http.response; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/functions/requests/http-post-fields.xml b/reference/http/functions/requests/http-post-fields.xml deleted file mode 100644 index 3d94892d48..0000000000 --- a/reference/http/functions/requests/http-post-fields.xml +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - http_post_fields - Perform POST request with data to be encoded - - - &reftitle.description; - - stringhttp_post_fields - stringurl - arraydata - arrayfiles - arrayoptions - arrayinfo - - - Performs an HTTP POST request on the supplied url. - - &see.http.request.options; - - - &reftitle.parameters; - - - - url - - - URL - - - - - data - - - Associative array of POST values - - - - - files - - - Array of files to post - - - - - options - - - &link.http.request.options; - - - - - info - - - &link.http.request.info; - - - - - - - - &reftitle.returnvalues; - - &returns.http.response; - - - - - - - - - - - &reftitle.examples; - - - A <function>http_post_fields</function> example - - 'mike', - 'pass' => 'se_ret' -); -$files = array( - array( - 'name' => 'uimg', - 'type' => 'image/jpeg', - 'file' => './profile.jpg', - ) -); - -$response = http_post_fields("http://www.example.com/", $fields, $files); -?> -]]> - - - - - - - - - - - - diff --git a/reference/http/functions/requests/http-put-data.xml b/reference/http/functions/requests/http-put-data.xml deleted file mode 100644 index 3a7ac87343..0000000000 --- a/reference/http/functions/requests/http-put-data.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - http_put_data - Perform PUT request with data - - - &reftitle.description; - - stringhttp_put_data - stringurl - stringdata - arrayoptions - arrayinfo - - - Performs an HTTP PUT request on the supplied url. - - &see.http.request.options; - - - &reftitle.parameters; - - - - url - - - URL - - - - - data - - - PUT request body - - - - - options - - - &link.http.request.options; - - - - - info - - - &link.http.request.info; - - - - - - - - &reftitle.returnvalues; - - &returns.http.response; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/functions/requests/http-put-file.xml b/reference/http/functions/requests/http-put-file.xml deleted file mode 100644 index 8023017692..0000000000 --- a/reference/http/functions/requests/http-put-file.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - http_put_file - Perform PUT request with file - - - &reftitle.description; - - stringhttp_put_file - stringurl - stringfile - arrayoptions - arrayinfo - - - Performs an HTTP PUT request on the supplied url. - - &see.http.request.options; - - - &reftitle.parameters; - - - - url - - - URL - - - - - file - - - The file to put - - - - - options - - - &link.http.request.options; - - - - - info - - - &link.http.request.info; - - - - - - - - &reftitle.returnvalues; - - &returns.http.response; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/functions/requests/http-put-stream.xml b/reference/http/functions/requests/http-put-stream.xml deleted file mode 100644 index c47d18e1d1..0000000000 --- a/reference/http/functions/requests/http-put-stream.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - http_put_stream - Perform PUT request with stream - - - &reftitle.description; - - stringhttp_put_stream - stringurl - resourcestream - arrayoptions - arrayinfo - - - Performs an HTTP PUT request on the supplied url. - - &see.http.request.options; - - - &reftitle.parameters; - - - - url - - - URL - - - - - stream - - - The stream to read the PUT request body from - - - - - options - - - &link.http.request.options; - - - - - info - - - &link.http.request.info; - - - - - - - - &reftitle.returnvalues; - - &returns.http.response; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/functions/requests/http-request-body-encode.xml b/reference/http/functions/requests/http-request-body-encode.xml deleted file mode 100644 index fce24f852f..0000000000 --- a/reference/http/functions/requests/http-request-body-encode.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - http_request_body_encode - Encode request body - - - &reftitle.description; - - stringhttp_request_body_encode - arrayfields - arrayfiles - - - - Generate x-www-form-urlencoded resp. form-data encoded request body. - - - - - &reftitle.parameters; - - - - fields - - - POST fields - - - - - files - - - POST files - - - - - - - - &reftitle.returnvalues; - - Returns encoded string on success&return.falseforfailure;. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/functions/requests/http-request-method-exists.xml b/reference/http/functions/requests/http-request-method-exists.xml deleted file mode 100644 index 2f6668b3fe..0000000000 --- a/reference/http/functions/requests/http-request-method-exists.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - http_request_method_exists - Check whether request method exists - - - &reftitle.description; - - inthttp_request_method_exists - mixedmethod - - - Check if a request method is registered (or available by default). - - - - &reftitle.parameters; - - - - method - - - request method name or ID - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the request method is known, else &false;. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/functions/requests/http-request-method-name.xml b/reference/http/functions/requests/http-request-method-name.xml deleted file mode 100644 index 5ca5ed0ede..0000000000 --- a/reference/http/functions/requests/http-request-method-name.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - http_request_method_name - Get request method name - - - &reftitle.description; - - stringhttp_request_method_name - intmethod - - - Get the literal string representation of a standard or registered request method. - - - - &reftitle.parameters; - - - - method - - - request method ID - - - - - - - - &reftitle.returnvalues; - - Returns the request method name as string on success&return.falseforfailure;. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/functions/requests/http-request-method-register.xml b/reference/http/functions/requests/http-request-method-register.xml deleted file mode 100644 index 0d89e8593a..0000000000 --- a/reference/http/functions/requests/http-request-method-register.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - http_request_method_register - Register request method - - - &reftitle.description; - - inthttp_request_method_register - stringmethod - - - Register a custom request method. - - - - &reftitle.parameters; - - - - method - - - the request method name to register - - - - - - - - &reftitle.returnvalues; - - Returns the ID of the request method on success&return.falseforfailure;. - - - - - - - - - - - - - - - - - - diff --git a/reference/http/functions/requests/http-request-method-unregister.xml b/reference/http/functions/requests/http-request-method-unregister.xml deleted file mode 100644 index 01b65748ae..0000000000 --- a/reference/http/functions/requests/http-request-method-unregister.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - http_request_method_unregister - Unregister request method - - - &reftitle.description; - - boolhttp_request_method_unregister - mixedmethod - - - - Unregister a previously registered custom request method. - - - - - &reftitle.parameters; - - - - method - - - The request method name or ID - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/functions/requests/http-request.xml b/reference/http/functions/requests/http-request.xml deleted file mode 100644 index 1ed4333617..0000000000 --- a/reference/http/functions/requests/http-request.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - http_request - Perform custom request - - - &reftitle.description; - - stringhttp_request - intmethod - stringurl - stringbody - arrayoptions - arrayinfo - - - Performs a custom HTTP request on the supplied url. - - &see.http.request.options; - - - - &reftitle.parameters; - - - - method - - - Request method - - - - - url - - - URL - - - - - body - - - Request body - - - - - options - - - &link.http.request.options; - - - - - info - - - &link.http.request.info; - - - - - - - - &reftitle.returnvalues; - - &returns.http.response; - - - - - - - - - - - - - - - - - - diff --git a/reference/http/functions/responses/http-redirect.xml b/reference/http/functions/responses/http-redirect.xml deleted file mode 100644 index 23f314bbf1..0000000000 --- a/reference/http/functions/responses/http-redirect.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - http_redirect - Issue HTTP redirect - - - &reftitle.description; - - boolhttp_redirect - stringurl - arrayparams - boolsessionfalse - intstatus0 - - - Redirect to the given url. - - - The supplied url will be expanded with http_build_url, the params array will - be treated with http_build_str and the session identification will be appended - if session is true. The HTTP response code will be set according to status. - You can use one of the redirect constants for convenience. - Please see RFC 2616 - for which redirect response code to use in which situation. By default PHP will decide which response status fits best. - - - 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. - - - A log entry will be written to the redirect log, if the &link.http.configuration; - http.log.redirect is set and the redirect attempt was successful. - - - - - &reftitle.parameters; - - - - url - - - the URL to redirect to - - - - - params - - - associative array of query parameters - - - - - session - - - whether to append session information - - - - - status - - - custom response status code - - - - - - - - &reftitle.returnvalues; - - &returns.http.false.orexits; with the specified redirection status code. - &see.http.configuration.force_exit; - - - - - - - - - - - &reftitle.examples; - - - A <function>http_redirect</function> example - - "value"), true, HTTP_REDIRECT_PERM); -?> -]]> - - &example.outputs; - -http://www.example.com/curdir/relpath?name=value&PHPSESSID=abc. -]]> - - - - - - - - &reftitle.seealso; - - - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/responses/http-send-content-disposition.xml b/reference/http/functions/responses/http-send-content-disposition.xml deleted file mode 100644 index 9031324623..0000000000 --- a/reference/http/functions/responses/http-send-content-disposition.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - http_send_content_disposition - Send Content-Disposition - - - &reftitle.description; - - boolhttp_send_content_disposition - stringfilename - boolinlinefalse - - - Send the Content-Disposition. - &http.content.disposition; - - ¬e.http.send.API; - - - &reftitle.parameters; - - - - filename - - - the file name the "Save as..." dialog should display - - - - - inline - - - if set to &true; and the user agent knows how to handle the content type, - it will probably not cause the popup window to be shown - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - http_send_data - http_send_file - http_send_stream - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/responses/http-send-content-type.xml b/reference/http/functions/responses/http-send-content-type.xml deleted file mode 100644 index 68afd149b3..0000000000 --- a/reference/http/functions/responses/http-send-content-type.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - http_send_content_type - Send Content-Type - - - &reftitle.description; - - boolhttp_send_content_type - stringcontent_type"application/x-octetstream" - - - Send the Content-Type of the sent entity. - - ¬e.http.send.API; - - - &reftitle.parameters; - - - - content_type - - - the desired content type (primary/secondary) - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Raises an E_WARNING when the content_type - doesn't seem to contain a primary and a secondary part. - - - - - - - - - - - - &reftitle.seealso; - - - http_send_data - http_send_file - http_send_stream - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/responses/http-send-data.xml b/reference/http/functions/responses/http-send-data.xml deleted file mode 100644 index 9df9990e7c..0000000000 --- a/reference/http/functions/responses/http-send-data.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - http_send_data - Send arbitrary data - - - &reftitle.description; - - boolhttp_send_data - stringdata - - - Sends raw data with support for (multiple) range requests. - - - - &reftitle.parameters; - - - - data - - - data to send - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - http_send_file - http_send_stream - http_throttle - http_send_content_type - http_send_content_disposition - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/responses/http-send-file.xml b/reference/http/functions/responses/http-send-file.xml deleted file mode 100644 index 8f07d2e6cd..0000000000 --- a/reference/http/functions/responses/http-send-file.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - http_send_file - Send file - - - &reftitle.description; - - boolhttp_send_file - stringfile - - - Sends a file with support for (multiple) range requests. - - - This functions behaviour and further action is dependent on the following - &link.http.configuration;s: - http.send.not_found_404 - &listendand; http.log.not_found. - - - If the &link.http.configuration; http.send.not_found_404 - is enabled and the &link.http.configuration; http.log.not_found - points to a writable file, a log message is written when the file was not found. - - - - &reftitle.parameters; - - - - file - - - the file to send - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - &reftitle.examples; - - - A <function>http_send_file</function> example - - -]]> - - &example.outputs; - - - - - - - - - - &reftitle.seealso; - - - http_send_data - http_send_stream - http_throttle - http_send_content_type - http_send_content_disposition - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/responses/http-send-last-modified.xml b/reference/http/functions/responses/http-send-last-modified.xml deleted file mode 100644 index 2d90954d14..0000000000 --- a/reference/http/functions/responses/http-send-last-modified.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - http_send_last_modified - Send Last-Modified - - - &reftitle.description; - - boolhttp_send_last_modified - inttimestamptime() - - - Send a Last-Modified header with a valid HTTP date. - - ¬e.http.send.API; - - - &reftitle.parameters; - - - - timestamp - - - a Unix timestamp, converted to a valid HTTP date; - if omitted, the current time will be sent - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/responses/http-send-status.xml b/reference/http/functions/responses/http-send-status.xml deleted file mode 100644 index 9be2547df9..0000000000 --- a/reference/http/functions/responses/http-send-status.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - http_send_status - Send HTTP response status - - - &reftitle.description; - - boolhttp_send_status - intstatus - - - Send HTTP status code. - - - - &reftitle.parameters; - - - - status - - - HTTP status code (100-599) - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/responses/http-send-stream.xml b/reference/http/functions/responses/http-send-stream.xml deleted file mode 100644 index 0b281a9fa3..0000000000 --- a/reference/http/functions/responses/http-send-stream.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - http_send_stream - Send stream - - - &reftitle.description; - - boolhttp_send_stream - resourcestream - - - Sends an already opened stream with support for (multiple) range requests. - - - - &reftitle.parameters; - - - - stream - - - stream to read from (must be seekable) - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - - &reftitle.seealso; - - - http_send_data - http_send_file - http_throttle - http_send_content_type - http_send_content_disposition - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/responses/http-throttle.xml b/reference/http/functions/responses/http-throttle.xml deleted file mode 100644 index 63c1978934..0000000000 --- a/reference/http/functions/responses/http-throttle.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - http_throttle - HTTP throttling - - - &reftitle.description; - - voidhttp_throttle - floatsec - intbytes40960 - - - Sets the throttle delay and send buffer size. - - ¬e.http.send.API; - ¬e.http.throttling.yields.process; - - - &http.maynotwork.SAPI; FastCGI. - - - - - &reftitle.parameters; - - - - sec - - - seconds to sleep after each chunk sent - - - - - bytes - - - the chunk size in bytes - - - - - - - - - - - - - - - &reftitle.examples; - - - A <function>http_throttle</function> example - - Send file with approximately 20 kbyte/s. - - - -]]> - - - - - - - - &reftitle.seealso; - - - http_send_data - http_send_file - http_send_stream - &http.response.class.php51; - - - - - - - - diff --git a/reference/http/functions/urls/http-build-str.xml b/reference/http/functions/urls/http-build-str.xml deleted file mode 100644 index 679b8f9bca..0000000000 --- a/reference/http/functions/urls/http-build-str.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - http_build_str - Build query string - - - &reftitle.description; - - stringhttp_build_str - arrayquery - stringprefix - stringarg_separatorini_get("arg_separator.output") - - - Builds a query string from an array of query variables. In effect, this - function is the opposite of parse_str. - - - - &reftitle.parameters; - - - - query - - - associative array of query string parameters - - - - - prefix - - - top level prefix - - - - - arg_separator - - - argument separator to use (by default the INI setting arg_separator.output will be used, or "&" if neither is set - - - - - - - - &reftitle.returnvalues; - - Returns the built query as string on success&return.falseforfailure;. - - - - - - - - - - - - - - &reftitle.seealso; - - - standard http_build_query - http_build_url - - - - - - - - diff --git a/reference/http/functions/urls/http-build-url.xml b/reference/http/functions/urls/http-build-url.xml deleted file mode 100644 index d72c5eda10..0000000000 --- a/reference/http/functions/urls/http-build-url.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - http_build_url - Build a URL - - - &reftitle.description; - - stringhttp_build_url - mixedurl - mixedparts - intflagsHTTP_URL_REPLACE - arraynew_url - - - - Build a URL. - - - The parts of the second URL will be merged into the first according to the flags argument. - - - - - &reftitle.parameters; - - - - url - - - (part(s) of) a URL in form of a string or associative array like parse_url returns - - - - - parts - - - same as the first argument - - - - - flags - - - a bitmask of binary or'ed HTTP_URL constants; - HTTP_URL_REPLACE is the default - - - - - new_url - - - if set, it will be filled with the parts of the composed url like parse_url would return - - - - - - - - &reftitle.returnvalues; - - Returns the new URL as string on success&return.falseforfailure;. - - - - - - - - - - - &reftitle.examples; - - - A <function>http_build_url</function> example - - "ftp", - "host" => "ftp.example.com", - "path" => "files/current/", - "query" => "a=c" - ), - HTTP_URL_STRIP_AUTH | HTTP_URL_JOIN_PATH | HTTP_URL_JOIN_QUERY | HTTP_URL_STRIP_FRAGMENT -); -?> -]]> - - &example.outputs; - - - - - - - - - - &reftitle.seealso; - - - parse_url - http_build_str - - - - - - - - diff --git a/reference/http/install.xml b/reference/http/install.xml deleted file mode 100644 index e0ad7bb6ac..0000000000 --- a/reference/http/install.xml +++ /dev/null @@ -1,44 +0,0 @@ - - -
- Installation/Configuration - Installing the HTTP extension - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;pecl_http. - - - The official name of this extension is pecl_http. - - - &pecl.windows.download; - -
-
- - diff --git a/reference/http/reference.xml b/reference/http/reference.xml deleted file mode 100644 index a34a5bfff0..0000000000 --- a/reference/http/reference.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - HTTP &Functions; - - - Built-in HTTP related functions previously listed on this page can be found in the - networking category. - - - The following functions do not need the HTTP module to be present: - header, headers_list, headers_sent, - setcookie &listendand; setrawcookie. - - -
- Function groups -
- Caching - - http_cache_etag - http_cache_last_modified - -
-
- Encodings - - http_chunked_decode - http_deflate - http_inflate - -
-
- Miscellaneous - - http_build_cookie - http_date - http_get_request_body_stream - http_get_request_body - http_get_request_headers - http_match_etag - http_match_modified - http_match_request_header - http_support - -
-
- Negotiation - - http_negotiate_charset - http_negotiate_content_type - http_negotiate_language - -
-
- Outputhandlers - - ob_deflatehandler - ob_etaghandler - ob_inflatehandler - -
-
- Parsers - - http_parse_cookie - http_parse_headers - http_parse_message - http_parse_params - -
-
- Requests - - http_get - http_head - http_post_data - http_post_fields - http_put_data - http_put_file - http_put_stream - http_request_body_encode - http_request_method_exists - http_request_method_name - http_request_method_register - http_request_method_unregister - http_request - -
-
- Responses - - http_redirect - http_send_content_disposition - http_send_content_type - http_send_data - http_send_file - http_send_last_modified - http_send_status - http_send_stream - http_throttle - -
-
- URLs - - http_build_str - http_build_url - -
-
- Persistent Handles - - http_persistent_handles_count - http_persistent_handles_ident - http_persistent_handles_clean - -
-
- - - - &reference.http.functions.entities.caching; - &reference.http.functions.entities.encodings; - &reference.http.functions.entities.misc; - &reference.http.functions.entities.negotiation; - &reference.http.functions.entities.outputhandlers; - &reference.http.functions.entities.parsers; - &reference.http.functions.entities.persistenthandles; - &reference.http.functions.entities.requests; - &reference.http.functions.entities.responses; - &reference.http.functions.entities.urls; - - - - - diff --git a/reference/http/request-options.xml b/reference/http/request-options.xml deleted file mode 100644 index 5bac6a3645..0000000000 --- a/reference/http/request-options.xml +++ /dev/null @@ -1,466 +0,0 @@ - - - - Options usable with the HttpRequest class and request functions - Request Options - - Options related to time outs - - - timeout (integer) - - - - seconds the whole request may take to complete - - - - - - connecttimeout (integer) - - - - seconds the connect, including name resolving, may take - - - - - - dns_cache_timeout (integer) - - - - seconds after an dns cache entry times out - - - - - - Options related to urls - - - url (string) - - - - the request url - - - - - - port (integer) - - - - use another port as specified in the url - - - - - - redirect (integer) - - - - whether and how many redirects to follow; defaults to 0 - - - - - - unrestrictedauth (bool) - - - - whether to continue sending credentials on redirects to a different host - - - - - - referer (string) - - - - the referring url to send - - - - - - Options related to cookies - - - encodecookies (bool) - - - - whether custom cookies should be urlencoded prior sending - - - - - - cookies (array) - - - - list of cookies as associative array like array("cookie" => "value") - - - - - - cookiestore (string) - - - - path to a file where cookies are/will be stored - - - - - - cookiesession (bool) - - - - don't load session cookies from cookiestore if &true; - - - - - - Options related to headers - - - useragent (string) - - - - the user agent to send; defaults to PECL::HTTP/x.y.z (PHP/x.y.z); omitted if explicitly set to an empty string - - - - - - lastmodified (int) - - - - timestamp for If-(Un)Modified-Since header - - - - - - etag (string) - - - - quoted etag for If-(None-)Match header - - - - - - headers (array) - - - - list of custom headers as associative array like array("header" => "value") - - - - - - Options related to authentication - - - httpauth (string) - - - - http credentials in "user:pass" format - - - - - - httpauthtype (int) - - - - HTTP authentication type constant - - - - - - (array) - - - - - - - - - Options related to proxies - - - proxyhost (string) - - - - proxy host in "host[:port]" format - - - - - - proxyport (int) - - - - use another proxy port as specified in proxyhost - - - - - - proxytype (int) - - - - HTTP proxy type constant - - - - - - proxyauth (string) - - - - proxy credentials in "user:pass" format - - - - - - proxyauthtype (int) - - - - HTTP authentication type constant - - - - - - Options related to the transfer - - - compress (bool) - - - - whether to request and accept a gzip/deflate content encoded response - - - - - - resume (int) - - - - start the download at the specified byte offset if server support is given (indicated by a 206 response code) - - - - - - range (array) - - - - array of arrays, each containing two integers, specifying the ranges to download if server support is given (indicated by a 206 response code); - only recognized if the resume option is empty - - - - - - Options imposing limits - - - maxfilesize (integer) - - - - maximum file size that should be downloaded; - has no effect, if the size of the requested entity is unknown - (eg. dynamic pages with chunked transfer encoding etc.) - - - - - - low_speed_limit (int) - - - - the lowest transfer speed a successful request may have - - - - - - low_speed_time (int) - - - - the time in which low_speed_limit must be transferred for a successful request - - - - - - max_send_speed (int) - - - - maximum send speed in bytes per second - - - - - - max_recv_speed (int) - - - - maximum receive speed in bytes per second - - - - - - Callback options - - onprogress (callable) - progress callback - - - - Network options - - interface (string) - outgoing network interface (ifname, ip or hostname) - - - portrange (array) - 2 integers specifying outgoing portrange to try - - - - SSL options - - - ssl (array) - - - - SSL options are set through an array with the single "ssl" request option name. - - - - cert (string) - path to certificate - - - certtype (string) - type of certificate - - - certpasswd (string) - password for certificate - - - key (string) - path to key - - - keytype (string) - type of key - - - keypasswd (string) - password for key - - - engine (string) - ssl engine to use - - - version (int) - ssl version to use - - - verifypeer (bool) - whether to verify the peer - - - verifyhost (bool) - whether to verify the host - - - cipher_list (string) - list of allowed ciphers - - - cainfo (string) - - - - capath (string) - - - - random_file (string) - - - - egdsocket (string) - - - - - - - - - diff --git a/reference/http/resources.xml b/reference/http/resources.xml deleted file mode 100644 index b3acb4caf0..0000000000 --- a/reference/http/resources.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -
- &reftitle.resources; - - This extension defines a stream resource returned by - http_get_request_body_stream and (thereafter) - HttpResponse::getStream. - -
- - diff --git a/reference/http/setup.xml b/reference/http/setup.xml deleted file mode 100644 index f93e386df3..0000000000 --- a/reference/http/setup.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - - The HttpResponse class requires at least PHP v5.1. - Any other class is available as of PHP v5.0. - - - - Be aware though, that some methods are not available with PHP v5.0. - - -
- Installation requirements on Windows - - In order to be able to load this extension on Windows, - you additionally need to load the following PHP extensions: - hash, iconv - &listendand; SPL. - -
- -
- Installation requirements on other platforms - - The extension must be built with libcurl support - to enable request functionality (--with-http-curl-requests). - A library version equal or greater to v7.12.3 is required. - - - To enable support for sending and receiving compressed - responses, the extension must be built with zlib support - (--with-http-zlib-compression). - A library version equal or greater than v1.2.2 is required. - - - Content type guessing can be enabled by - building this extension with libmagic support - (--with-http-magic-mime). - -
-
- - - - &reference.http.install; - - - - &reference.http.configuration; - - - - &reference.http.resources; - - - - - - diff --git a/reference/http/versions.xml b/reference/http/versions.xml deleted file mode 100644 index 8cbbdd343e..0000000000 --- a/reference/http/versions.xml +++ /dev/null @@ -1,368 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -