X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=http.md;h=0f395412ef749c53860b30609a40fe11ce602c0e;hb=08aadf818178f22708060ccac7ff7c9bb8e079dd;hp=bf651e2003b9de25efad5113eab990764002e2d1;hpb=a9966e91a49824155b1d9b3b3a580d43b20e3662;p=mdref%2Fmdref-http diff --git a/http.md b/http.md index bf651e2..0f39541 100644 --- a/http.md +++ b/http.md @@ -1,20 +1,62 @@ # pecl/http v2 -> **Note:** This documentation is work-in-progress. - ## About: -Extended HTTP support. Again. Keep in mind that it's got the major version 2, because it's incompatible with pecl_http v1. +Extended HTTP support. Again. * Introduces the http namespace. -* Message bodies have been remodeled to use PHP temporary streams instead of in-memory buffers. -* The utterly misunderstood HttpResponse class has been reimplemented as http\Env\Response inheriting http\Message. -* Currently, there's only one Exception class left, http\Exception. -* Errors triggered by the extension can be configured statically by http\Object::$defaultErrorHandling or inherited http\Object->errorHandling. -* The request ecosystem has been modularized to support different libraries, though for the moment only libcurl is supported. +* PHP stream based message bodies. +* Encapsulated env request/response. +* Modular client support. + +## Installation: + +This extension is hosted at [PECL](http://pecl.php.net) and can be installed with [PEAR](http://pear.php.net)'s pecl command: + + # pecl install pecl_http + +## Dependencies: + +This extension unconditionally depends on the pre-loaded presence of the following PHP extensions: + +* raphf +* propro +* spl + + +If configured ```--with-http-shared-deps``` (default) it depends on the pre-loaded presence of the following extensions, as long as they were available at build time: + +* hash +* iconv +* json + +## Conflicts: + +pecl/http-v2 conflicts with the following extensions: + +* http-v1 +* event (only until <= 2.0.3) ## INI Directives: * http.etag.mode = "crc32b" Default hash method for dynamic response payloads to generate an ETag. +## Stream Filters: + +The http extension registers the ```http.*``` namespace for its stream filters. Provided stream filters are: + +* http.chunked_decode + Decode a stream encoded with chunked transfer encoding. +* http.chunked_encode + Encode a stream with chunked transfer encoding. +* http.inflate + Decode a stream encoded with deflate/zlib/gzip encoding. +* http.deflate + Encode a stream with deflate/zlib/gzip encoding. + +## Changelog: + +Version | Change +--------|------- +2.0.4 | Dropped the pecl/event conflict.