www.aleph1.co.uk Git - yaffs-website/blob - vendor/guzzlehttp/guzzle/README.md

   1 Guzzle, PHP HTTP client
   2 =======================
   3
   4 [![Build Status](https://travis-ci.org/guzzle/guzzle.svg?branch=master)](https://travis-ci.org/guzzle/guzzle)
   5
   6 Guzzle is a PHP HTTP client that makes it easy to send HTTP requests and
   7 trivial to integrate with web services.
   8
   9 - Simple interface for building query strings, POST requests, streaming large
  10   uploads, streaming large downloads, using HTTP cookies, uploading JSON data,
  11   etc...
  12 - Can send both synchronous and asynchronous requests using the same interface.
  13 - Uses PSR-7 interfaces for requests, responses, and streams. This allows you
  14   to utilize other PSR-7 compatible libraries with Guzzle.
  15 - Abstracts away the underlying HTTP transport, allowing you to write
  16   environment and transport agnostic code; i.e., no hard dependency on cURL,
  17   PHP streams, sockets, or non-blocking event loops.
  18 - Middleware system allows you to augment and compose client behavior.
  19
  20 ```php
  21 $client = new \GuzzleHttp\Client();
  22 $res = $client->request('GET', 'https://api.github.com/repos/guzzle/guzzle');
  23 echo $res->getStatusCode();
  24 // 200
  25 echo $res->getHeaderLine('content-type');
  26 // 'application/json; charset=utf8'
  27 echo $res->getBody();
  28 // '{"id": 1420053, "name": "guzzle", ...}'
  29
  30 // Send an asynchronous request.
  31 $request = new \GuzzleHttp\Psr7\Request('GET', 'http://httpbin.org');
  32 $promise = $client->sendAsync($request)->then(function ($response) {
  33     echo 'I completed! ' . $response->getBody();
  34 });
  35 $promise->wait();
  36 ```
  37
  38 ## Help and docs
  39
  40 - [Documentation](http://guzzlephp.org/)
  41 - [Stack Overflow](http://stackoverflow.com/questions/tagged/guzzle)
  42 - [Gitter](https://gitter.im/guzzle/guzzle)
  43
  44
  45 ## Installing Guzzle
  46
  47 The recommended way to install Guzzle is through
  48 [Composer](http://getcomposer.org).
  49
  50 ```bash
  51 # Install Composer
  52 curl -sS https://getcomposer.org/installer | php
  53 ```
  54
  55 Next, run the Composer command to install the latest stable version of Guzzle:
  56
  57 ```bash
  58 php composer.phar require guzzlehttp/guzzle
  59 ```
  60
  61 After installing, you need to require Composer's autoloader:
  62
  63 ```php
  64 require 'vendor/autoload.php';
  65 ```
  66
  67 You can then later update Guzzle using composer:
  68
  69  ```bash
  70 composer.phar update
  71  ```
  72
  73
  74 ## Version Guidance
  75
  76 | Version | Status     | Packagist           | Namespace    | Repo                | Docs                | PSR-7 | PHP Version |
  77 |---------|------------|---------------------|--------------|---------------------|---------------------|-------|-------------|
  78 | 3.x     | EOL        | `guzzle/guzzle`     | `Guzzle`     | [v3][guzzle-3-repo] | [v3][guzzle-3-docs] | No    | >= 5.3.3    |
  79 | 4.x     | EOL        | `guzzlehttp/guzzle` | `GuzzleHttp` | [v4][guzzle-4-repo] | N/A                 | No    | >= 5.4      |
  80 | 5.x     | Maintained | `guzzlehttp/guzzle` | `GuzzleHttp` | [v5][guzzle-5-repo] | [v5][guzzle-5-docs] | No    | >= 5.4      |
  81 | 6.x     | Latest     | `guzzlehttp/guzzle` | `GuzzleHttp` | [v6][guzzle-6-repo] | [v6][guzzle-6-docs] | Yes   | >= 5.5      |
  82
  83 [guzzle-3-repo]: https://github.com/guzzle/guzzle3
  84 [guzzle-4-repo]: https://github.com/guzzle/guzzle/tree/4.x
  85 [guzzle-5-repo]: https://github.com/guzzle/guzzle/tree/5.3
  86 [guzzle-6-repo]: https://github.com/guzzle/guzzle
  87 [guzzle-3-docs]: http://guzzle3.readthedocs.org/en/latest/
  88 [guzzle-5-docs]: http://guzzle.readthedocs.org/en/5.3/
  89 [guzzle-6-docs]: http://guzzle.readthedocs.org/en/latest/