berlioz/http-client

Berlioz HTTP Client is a PHP library to request HTTP server with continuous navigation, including cookies, sessions...

v2.1.0 2024-04-19 07:33 UTC

Requires

• php: ^8.0
• ext-mbstring: *
• ext-zlib: *
• berlioz/http-message: ^2.1
• elgigi/har-parser: ^1.0
• psr/http-client: ^1.0
• psr/log: ^1.0 || ^2.0 || ^3.0

Requires (Dev)

• phpunit/phpunit: ^9.5
• symfony/process: ^5.0

Suggests

• ext-curl: To use CURL adapter
• berlioz/html-selector: To query HTML result like jQuery in JavaScript.

Provides

• psr/http-client-implementation: ^1.0
• psr/log-implementation: ^1.0

MIT

• Ronan Giron

README

Berlioz HTTP Client is a PHP library to request HTTP server with continuous navigation, including cookies, sessions... Implements PSR-18 (HTTP Client), PSR-7 (HTTP message interfaces) and PSR-17 (HTTP Factories) standards.

Installation

Composer

You can install Berlioz HTTP Client with Composer, it's the recommended installation.

$ composer require berlioz/http-client

Dependencies

• PHP ^8.0
• PHP libraries:
  • curl
  • mbstring
  • zlib
• Packages:
  • berlioz/http-message
  • elgigi/har-parser
  • psr/http-client
  • psr/log

Usage

Requests

With RequestInterface

You can construct your own request object whose implements RequestInterface interface (PSR-7).

use Berlioz\Http\Client\Client;
use Berlioz\Http\Message\Request;

/** @var \Psr\Http\Message\RequestInterface $request */
$request = new Request(...);

$client = new Client();
$response = $client->sendRequest($request);

print $response->getBody();

Get/Post/Patch/Put/Delete/Options/Head/Connect/Trace

Methods are available to do request with defined HTTP method:

• Client::get(...)
• Client::post(...)
• Client::patch(...)
• Client::put(...)
• Client::delete(...)
• Client::options(...)
• Client::head(...)
• Client::connect(...)
• Client::trace(...)

Example with Client::get():

use Berlioz\Http\Client\Client;

$client = new Client();
$response = $client->get('https://getberlioz.com');

print $response->getBody();

You also can pass HTTP method in argument to Client::request(...) method:

use Berlioz\Http\Client\Client;

$client = new Client();
$response = $client->request('get', 'https://getberlioz.com');

print $response->getBody();

Each method accept an array of options with $options argument. List of options:

• baseUri (string): Base of URI if not given in requests
• followLocation (bool): Follow redirections (default: true)
• followLocationLimit (int): Limit location to follow
• sleepTime (int): Sleep time between requests (ms) (default: 0)
• logFile (string): Log file name (only file name, not path)
• exceptions (bool): Throw exceptions on error (default: true)
• cookies (null|false|CookiesManager): NULL: to use default cookie manager; FALSE: to not use cookies; a CookieManager object to use
• callback (callable): Callback after each request
• headers (array): Default headers

Options passed in argument replace default options of client.

Session

The session is accessible with method Client::getSession().

History

The browsing history is saved in the session. If you serialize the object Session, the history is preserve.

The method Session::getHistory() returns an History object:

use Berlioz\Http\Client\Client;

$client = new Client();
$history = $client->getSession()->getHistory();

Cookies

A cookie manager is available to manage cookies of session and between requests. The manager is available with Session::getCookies() method.

If you serialize the object Session, the cookies are preserves.

HAR file

HAR file of session is accessible with method Session::getHar().

If you serialize the object Session, the HAR is preserved.

Refers to the documentation of elgigi/har-parser library: https://github.com/ElGigi/HarParser

Adapters

Usage

Default adapter used by library is CurlAdapter (if CURL extension is installed), else the StreamAdapter is used.

You can specify adapters to the client constructor, with argument adapter:

use Berlioz\Http\Client\Client;
use Berlioz\Http\Client\Adapter;

$client = new Client(adapter: new Adapter\CurlAdapter(), adapter: new Adapter\StreamAdapter());

The first specified adapter is the default adapter.

If you want force an adapter for a request, you can pass is name in the request options:

use Berlioz\Http\Client\Client;
use Berlioz\Http\Client\Adapter;

$client = new Client(adapter: new Adapter\CurlAdapter(), adapter: new Adapter\StreamAdapter());
$client->get('https://getberlioz.com', options: ['adapter' => 'stream']);

List

List of adapters:

• curl: Berlioz\Http\Client\Adapter\CurlAdapter
• stream: Berlioz\Http\Client\Adapter\StreamAdapter
• har: Berlioz\Http\Client\Adapter\HarAdapter

HarAdapter

The HarAdapter is specially made to simulate a navigation, coming from a desktop browser for example.

It's very useful for test units. You only need to store your cleaned HAR file into your repository to launch tests with simulated HTTP dialogs.

use Berlioz\Http\Client\Client;
use Berlioz\Http\Client\Adapter\HarAdapter;
use ElGigi\HarParser\Parser;

// Create HAR object from library `elgigi/har-parser`
$har = (new Parser())->parse('/path/of/my/file.har', contentIsFile: true);

$client = new Client(adapter: new HarAdapter(har: $har));
$client->get('https://getberlioz.com'); // Get response from HAR object, without making an HTTP request

Har adapter accept an option strict (default: false) to force the way of navigation.

Create an adapter

You can create an adapter for your project. You must implement the interface Berlioz\Http\Client\Adapter\AdapterInterface.