HTTPlug: HTTP client abstraction
HTTPlug allows you to write reusable libraries and applications that need an HTTP client without binding to a specific implementation. When all packages used in an application only specify HTTPlug, the application developers can choose the client that best fits their project and use the same client with all packages.
HTTPlug defines two HTTP client interfaces that we kept as simple as possible:
PSR-18 defines the
sendRequestmethod that accepts a PSR-7
RequestInterfaceand either returns a PSR-7
ResponseInterfaceor throws an exception that implements
HTTPlug has the compatible interface
HttpClientwhich now extends the PSR-18 interface to allow migrating to PSR-18.
sendAsyncRequestmethod that sends a PSR-7 request asynchronously and always returns a
Http\Client\Promise. See :doc:`../components/promise` for more information.
PHP-HTTP offers two types of clients that implement the above interfaces:
Standalone clients that directly implement the interfaces.
Adapters that wrap existing HTTP clients, such as Guzzle. These adapters act as a bridge between the HTTPlug interfaces and the clients that do not (yet) implement these interfaces.
More and more clients implement PSR-18 directly. If that is all you need, we recommend not using HTTPlug as it would only add overhead. However, as there is no PSR for asynchronous requests yet, you can use the adapters to do such requests without binding yourself to a specific implementation.
Ideally, there will be a PSR for asynchronous requests and all HTTP client libraries out there will implement PSR-18 and the not yet existing PSR. At that point, our adapters will no longer be necessary.
There are two main use cases for HTTPlug:
- Usage in an application that executes HTTP requests (see :doc:`tutorial` and :doc:`../integrations/index`);
- Usage in a reusable package that executes HTTP requests (see :doc:`library-developers`).
This project has been started by Eric Geloen as Ivory Http Adapter. It never made it to a stable release, but it relied on PSR-7 which was not stable either that time. Because of the constantly changing PSR-7, Eric had to rewrite the library over and over again (at least the message handling part, which in most cases affected every adapter as well).
In 2015, a decision has been made to move the library to its own organization, so PHP-HTTP was born.
See :doc:`migrating` for a guide how to migrate your code from the Ivory adapter.