art4/requests-psr18-adapter

Use WordPress/Requests as a PSR-18 HTTP client

1.3.0 2024-10-14 08:08 UTC

Requires

• php: ^7.2 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0
• psr/http-client: ^1.0
• psr/http-factory: ^1.0
• psr/http-message: ^1.1 || ^2.0
• rmccue/requests: ^1.8 || ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.4
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^8 || ^9 || ^10
• yoast/phpunit-polyfills: ^2

Provides

• psr/http-client-implementation: ^1.0

GPL-3.0-or-later

• Art4

• http
• wordpress
• response
• request
• requests
• psr
• psr-7
• http-message
• http-client
• psr-18

README

Use WordPress/Requests as a PSR-18 HTTP client adapter.

• Requires PHP 7.2+
• Supports Requests v1.8+ and v2

Why?

Requests is a HTTP library written in PHP, that lacks of support for PSR-7 and also for PSR-18 because of the compatability with PHP 5.6+.

I've created a PR in Requests to add PSR-7 support but this would add new direct dependencies to Requests. So I created this library as an optional wrapper for Requests. If one day Requests nativly supports PSR-7 and PSR-18, this library might become obsolete.

How to use

Installation with Composer

WordPress/Requests PSR-18 Adapter is available on Packagist and can be installed using Composer.

composer require art4/requests-psr18-adapter

If you want to use WordPress/Requests PSR-18 Adapter in context of a WordPress instance (e.g. in a plugin or theme) you should add "rmccue/requests": "*" as a replace package link. This will prevent composer from installing rmccue/requests two times, leading to fatal errors.

Example composer.json:

{
    "require": {
        "art4/requests-psr18-adapter": "^1.1"
    },
    "replace": {
        "rmccue/requests": "*"
    }
}

Examples

Take a look at the examples directory for more examples.

<?php

// First, include the Composer autoload.php
require_once dirname(__DIR__) . '/vendor/autoload.php';

// Define Requests options
$options = [
    'proxy' => '127.0.0.1:8080',
    'transport' => $customTransport,
    // other Requests options
];

// Create the HTTP client
$httpClient = new \Art4\Requests\Psr\HttpClient($options);

// Create a PSR-7 request and optional set other headers
$request = $httpClient->createRequest('GET', 'http://httpbin.org/get');
$request = $request->withHeader('Accept', 'application/json');

try {
    // Send the request
    $response = $httpClient->sendRequest($request);
} catch (\Psr\Http\Client\ClientExceptionInterface $th) {
    // Handle errors
    throw $th;
}

// Use the PSR-7 Response
var_dump($response->getBody()->__toString());