From b80fd05811cc0d9b8eecfcd531be46d4b27edbc5 Mon Sep 17 00:00:00 2001 From: Michael Wallner Date: Fri, 20 Apr 2007 16:44:20 +0000 Subject: [PATCH] - reviewed Http[In|De]flateStream git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@234183 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/http/HttpDeflateStream.xml | 39 +++-- .../http/HttpDeflateStream/construct.xml | 10 +- reference/http/HttpDeflateStream/factory.xml | 146 ++++++++++++++++++ reference/http/HttpDeflateStream/finish.xml | 4 +- reference/http/HttpDeflateStream/flush.xml | 6 +- reference/http/HttpDeflateStream/update.xml | 6 +- reference/http/HttpInflateStream.xml | 23 ++- .../http/HttpInflateStream/construct.xml | 10 +- reference/http/HttpInflateStream/factory.xml | 146 ++++++++++++++++++ reference/http/HttpInflateStream/finish.xml | 4 +- reference/http/HttpInflateStream/flush.xml | 6 +- reference/http/HttpInflateStream/update.xml | 6 +- reference/http/install.xml | 18 ++- 13 files changed, 376 insertions(+), 48 deletions(-) create mode 100644 reference/http/HttpDeflateStream/factory.xml create mode 100644 reference/http/HttpInflateStream/factory.xml diff --git a/reference/http/HttpDeflateStream.xml b/reference/http/HttpDeflateStream.xml index 0acb842ca7..efe59fe179 100644 --- a/reference/http/HttpDeflateStream.xml +++ b/reference/http/HttpDeflateStream.xml @@ -1,5 +1,5 @@ - + @@ -7,9 +7,7 @@ HTTP Deflate Stream Class - - class HttpDeflateStream - + class HttpDeflateStream Class Members @@ -43,13 +41,13 @@ int - LEVEL_MIN - minimum compression level + LEVEL_DEF + default compression level int - TYPE_DEF - default compression level + LEVEL_MIN + minimum compression level int @@ -103,15 +101,38 @@ &reftitle.methods; - HttpDeflateStream::construct + HttpDeflateStream::factory + HttpDeflateStream::__construct HttpDeflateStream::update HttpDeflateStream::flush HttpDeflateStream::finish + + &reftitle.examples; + + + A <classname>HttpDeflateStream</classname> example + +update($data); +echo $stream->finish(); +?> +]]> + + + + +&reference.http.HttpDeflateStream.factory; &reference.http.HttpDeflateStream.construct; &reference.http.HttpDeflateStream.update; &reference.http.HttpDeflateStream.flush; diff --git a/reference/http/HttpDeflateStream/construct.xml b/reference/http/HttpDeflateStream/construct.xml index 552c3c8002..e4f24adb57 100644 --- a/reference/http/HttpDeflateStream/construct.xml +++ b/reference/http/HttpDeflateStream/construct.xml @@ -1,5 +1,5 @@ - + @@ -17,9 +17,8 @@ Creates a new HttpDeflateStream object instance. - See the deflate stream constants table for possible arguments. + See the deflate stream constants table for possible flags. - &reftitle.parameters; @@ -104,17 +103,14 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpDeflateStream/factory.xml b/reference/http/HttpDeflateStream/factory.xml new file mode 100644 index 0000000000..781f1be52d --- /dev/null +++ b/reference/http/HttpDeflateStream/factory.xml @@ -0,0 +1,146 @@ + + + + + + HttpDeflateStream::factory + HttpDeflateStream class factory + + + &reftitle.description; + + public + voidHttpDeflateStream::factory + intflags = 0 + stringtclass_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 index cb519f9ba2..41aee754f0 100644 --- a/reference/http/HttpDeflateStream/finish.xml +++ b/reference/http/HttpDeflateStream/finish.xml @@ -1,5 +1,5 @@ - + @@ -25,7 +25,7 @@ data - Data to deflate + data to deflate diff --git a/reference/http/HttpDeflateStream/flush.xml b/reference/http/HttpDeflateStream/flush.xml index e61e8cfc81..290d3ff241 100644 --- a/reference/http/HttpDeflateStream/flush.xml +++ b/reference/http/HttpDeflateStream/flush.xml @@ -1,5 +1,5 @@ - + @@ -25,7 +25,7 @@ data - More data to deflate + more data to deflate @@ -35,7 +35,7 @@ &reftitle.returnvalues; - Returns some deflated data as string on success or FALSE on failure. + Returns some deflated data as string on success or &false; on failure. diff --git a/reference/http/HttpDeflateStream/update.xml b/reference/http/HttpDeflateStream/update.xml index e9663046ad..c3f2619d35 100644 --- a/reference/http/HttpDeflateStream/update.xml +++ b/reference/http/HttpDeflateStream/update.xml @@ -1,5 +1,5 @@ - + @@ -25,7 +25,7 @@ data - Data to deflate + data to deflate @@ -35,7 +35,7 @@ &reftitle.returnvalues; - Returns deflated data on success or FALSE on failure. + Returns deflated data on success or &false; on failure. diff --git a/reference/http/HttpInflateStream.xml b/reference/http/HttpInflateStream.xml index cf2ee7dc53..70dd410e09 100644 --- a/reference/http/HttpInflateStream.xml +++ b/reference/http/HttpInflateStream.xml @@ -1,5 +1,5 @@ - + @@ -53,15 +53,34 @@ &reftitle.methods; - HttpInflateStream::construct + HttpInflateStream::factory + HttpInflateStream::__construct HttpInflateStream::update HttpInflateStream::flush HttpInflateStream::finish + + &reftitle.examples; + + + A <classname>HttpInflateStream</classname> example + +update($data); +echo $stream->finish(); +?> +]]> + + + + +&reference.http.HttpInflateStream.factory; &reference.http.HttpInflateStream.construct; &reference.http.HttpInflateStream.update; &reference.http.HttpInflateStream.flush; diff --git a/reference/http/HttpInflateStream/construct.xml b/reference/http/HttpInflateStream/construct.xml index 0dd6e06d74..0a109bd112 100644 --- a/reference/http/HttpInflateStream/construct.xml +++ b/reference/http/HttpInflateStream/construct.xml @@ -1,5 +1,5 @@ - + @@ -17,9 +17,8 @@ Creates a new HttpInflateStream object instance. - See the inflate constants table for possible arguments. + See the inflate constants table for possible flags. - &reftitle.parameters; @@ -104,17 +103,14 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpInflateStream/factory.xml b/reference/http/HttpInflateStream/factory.xml new file mode 100644 index 0000000000..4ed9e985fb --- /dev/null +++ b/reference/http/HttpInflateStream/factory.xml @@ -0,0 +1,146 @@ + + + + + + HttpInflateStream::factory + HttpInflateStream class factory + + + &reftitle.description; + + public + voidHttpInflateStream::factory + intflags = 0 + 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 index feddd961c7..f31c75d885 100644 --- a/reference/http/HttpInflateStream/finish.xml +++ b/reference/http/HttpInflateStream/finish.xml @@ -1,5 +1,5 @@ - + @@ -25,7 +25,7 @@ data - Data to inflate + data to inflate diff --git a/reference/http/HttpInflateStream/flush.xml b/reference/http/HttpInflateStream/flush.xml index abaa401b19..ba5d76a50a 100644 --- a/reference/http/HttpInflateStream/flush.xml +++ b/reference/http/HttpInflateStream/flush.xml @@ -1,5 +1,5 @@ - + @@ -30,7 +30,7 @@ data - More data to inflate + more data to inflate @@ -40,7 +40,7 @@ &reftitle.returnvalues; - Returns some inflated data as string on success or FALSE on failure. + Returns some inflated data as string on success or &false; on failure. diff --git a/reference/http/HttpInflateStream/update.xml b/reference/http/HttpInflateStream/update.xml index f1f1358ef9..bac20e9ec0 100644 --- a/reference/http/HttpInflateStream/update.xml +++ b/reference/http/HttpInflateStream/update.xml @@ -1,5 +1,5 @@ - + @@ -25,7 +25,7 @@ data - Data to inflate + data to inflate @@ -35,7 +35,7 @@ &reftitle.returnvalues; - Returns inflated data on success or FALSE on failure. + Returns inflated data on success or &false; on failure. diff --git a/reference/http/install.xml b/reference/http/install.xml index c156182e32..13f5862ff0 100644 --- a/reference/http/install.xml +++ b/reference/http/install.xml @@ -1,9 +1,9 @@ - + Installation - Installing and configuring the HTTP extension + Installing the HTTP extension @@ -15,6 +15,9 @@ &pecl.info; &url.pecl.package;pecl_http. + + The official name of this extension is pecl_http. + &pecl.windows.download; @@ -25,27 +28,28 @@ In order to be able to load this extension on Windows, you additionally need to load the following PHP extensions: - - hash, iconv, SPL. + hash, iconv + &listendand; SPL. Installation requirements on other platforms - The extension must be built with libcurl support + 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 + 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 quessing can be enabled by - building this extension with libmagic support (--with-http-magic-mime). + building this extension with libmagic support + (--with-http-magic-mime). \ No newline at end of file