| /vendor/guzzlehttp/guzzle/docs/index.rst |
|---|
| @@ -0,0 +1,91 @@ |
|---|
| .. title:: Guzzle | PHP HTTP client and framework for consuming RESTful web services |
| |
| ====== |
| Guzzle |
| ====== |
| |
| Guzzle is a PHP HTTP client that makes it easy to work with HTTP/1.1 and takes |
| the pain out of consuming web services. |
| |
| - Pluggable HTTP adapters that can send requests serially or in parallel |
| - Doesn't require cURL, but uses cURL by default |
| - Streams data for both uploads and downloads |
| - Provides event hooks & plugins for cookies, caching, logging, OAuth, mocks, etc. |
| - Keep-Alive & connection pooling |
| - SSL Verification |
| - Automatic decompression of response bodies |
| - Streaming multipart file uploads |
| - Connection timeouts |
| |
| .. code-block:: php |
| |
| $client = new GuzzleHttp\Client(); |
| $res = $client->get('https://api.github.com/user', [ |
| 'auth' => ['user', 'pass'] |
| ]); |
| echo $res->getStatusCode(); // 200 |
| echo $res->getHeader('content-type'); // 'application/json; charset=utf8' |
| echo $res->getBody(); // {"type":"User"...' |
| var_export($res->json()); // Outputs the JSON decoded data |
| |
| User guide |
| ---------- |
| |
| .. toctree:: |
| :maxdepth: 2 |
| |
| overview |
| quickstart |
| clients |
| http-messages |
| events |
| streams |
| adapters |
| testing |
| faq |
| |
| HTTP Components |
| --------------- |
| |
| There are a number of optional libraries you can use along with Guzzle's HTTP |
| layer to add capabilities to the client. |
| |
| `Log Subscriber <https://github.com/guzzle/log-subscriber>`_ |
| Logs HTTP requests and responses sent over the wire using customizable |
| log message templates. |
| |
| `OAuth Subscriber <https://github.com/guzzle/oauth-subscriber>`_ |
| Signs requests using OAuth 1.0. |
| |
| `Progress Subscriber <https://github.com/guzzle/progress-subscriber>`_ |
| Emits progress events when uploading and downloading data. |
| |
| `Cache Subscriber <https://github.com/guzzle/cache-subscriber>`_ |
| Implements a private transparent proxy cache that caches HTTP responses. |
| |
| `Retry Subscriber <https://github.com/guzzle/retry-subscriber>`_ |
| Retries failed requests using customizable retry strategies (e.g., retry |
| based on response status code, cURL error codes, etc.) |
| |
| `Message Integrity Subscriber <https://github.com/guzzle/message-integrity-subscriber>`_ |
| Verifies the message integrity of HTTP responses using customizable |
| validators. This plugin can be used, for example, to verify the Content-MD5 |
| headers of responses. |
| |
| Service Description Commands |
| ---------------------------- |
| |
| You can use the **Guzzle Command** library to encapsulate interaction with a |
| web service using command objects. Building on top of Guzzle's command |
| abstraction allows you to easily implement things like service description that |
| can be used to serialize requests and parse responses using a meta-description |
| of a web service. |
| |
| `Guzzle Command <https://github.com/guzzle/command>`_ |
| Provides the foundational elements used to build high-level, command based, |
| web service clients with Guzzle. |
| |
| `Guzzle Services <https://github.com/guzzle/guzzle-services>`_ |
| Provides an implementation of the *Guzzle Command* library that uses |
| Guzzle service descriptions to describe web services, serialize requests, |
| and parse responses into easy to use model structures. |
