README

efabrica/http-client is a PHP package that provides a simple and efficient HTTP client based on Symfony's HttpClient component. It adds named arguments in constructor and methods, and provides a more statically analysable API for making HTTP requests. If Symfony changes the HttpClient component, this package's effort will be to avoid breaking changes.

Installation

You can install the package using Composer. Run the following command in your project's root directory:

composer require efabrica/http-client

⚠️ PHP >=8.1 is required.

Usage

Creating an instance

To create an instance of the HttpClient class, use the create method. This method allows you to configure various options for the HTTP client, such as base URL, headers, authentication, and more.

use Efabrica\HttpClient\HttpClient;

// Create an instance with default options
$http = new HttpClient();

// Create an instance with custom options
$http = new HttpClient(
    baseUri: 'https://api.example.com',
    authBearer: 'your-access-token',
    timeout: 10.0,
    // ... other options
);

Making Requests

The HttpClient class provides methods for making different types of HTTP requests: GET, POST, PUT, PATCH, DELETE.

use Efabrica\HttpClient\HttpClient;

$http = new HttpClient('https://api.example.com', 'example_llt');

// Send a GET request
$response = $http->get('/resource', ['offset' => 0, 'limit' => 10]);

// Send a POST request with JSON payload
$response = $http->post('/resource', json: ['key' => 'value']);

// Send a POST request with FormData payload
$response = $http->post('/resource', body: ['key' => 'value']);

// Send a PUT request
$response = $http->put('https://api.example2.com/resource', ['email' => 'admin@example.com']);

// ... other request methods

Handling Asynchronous Responses

The HttpClient class returns HttpResponse object which implements Symfony's ResponseInterface. This allows you to work with responses asynchronously without blocking until their methods are called.

use Efabrica\HttpClient\HttpClient;

$http = new HttpClient();

// Send an asynchronous request (does not block)
$response = $http->get('https://api.example.com/resource');

// Access response asynchronously
// > Exceptions are thrown when the response is read
$response->getHttpCode(); // int|null       (does not block, returns null if response code is not available yet)
$response->getStatusCode(); // int          (blocks until response headers are available)
$response->getResponseHeaders(); // array   (blocks until response headers are available)
$response->getHeaders(); // array           (blocks until response headers are available) 
$response->getContent(); // string          (blocks until response body is available)
$response->toArray(); // JSON body as array (blocks until response body is available)

Streaming Responses

You can use the stream method to yield responses chunk by chunk as they complete.

use Efabrica\HttpClient\HttpClient;

$http = new HttpClient();

// Send multiple requests and stream responses
$responses = [
    $http->get('https://api.example.com/resource1'),
    $http->get('https://api.example.com/resource2'),
    // ... add more requests
];

$stream = $http->stream($responses);

foreach ($stream as $response) {
    // Process each response asynchronously
}

Adding Decorators

You can enhance the functionality of the HttpClient by adding decorators. Decorators can modify or extend the behavior of the underlying HTTP client.

use Efabrica\HttpClient\HttpClient;
use Symfony\Component\HttpClient\Decorator\CachedHttpClient;

$http = new HttpClient();

// Add a decorator to the HTTP client
$http->setClient(new CachedHttpClient($cache, $http->getClient()));

// Create a new instance with an additional decorator
$newHttpClient = $http->withClient(new CachedHttpClient($cache, $http->getClient()));

Updating Options

use Efabrica\HttpClient\HttpClient;

// Create an instance with default options
$http = new HttpClient();

// Create a new instance with updated options
$newHttp = $http->withOptions(baseUrl: 'https://api.new-example.com', /* ... */);

// Now $newHttp is a new instance of HttpClient with the updated options

This example shows how to create a new instance of HttpClient with updated options using the withOptions method. The original HttpClient instance remains unchanged.

Contributions

Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.

efabrica / http-client

Maintainers

Details