request-interop/impl

Reference implementations of the RequestInterop interfaces.

1.x-dev 2025-03-16 16:59 UTC

Requires

• php: ^8.4
• request-interop/interface: 1.x@dev
• stream-interop/impl: 1.x@dev
• stream-interop/interface: 1.x@dev
• uri-interop/impl: 1.x@dev
• uri-interop/interface: 1.x@dev

Requires (Dev)

• nyholm/psr7: ^1.0
• pds/skeleton: ^1.0
• phpstan/phpstan: ^2.0
• phpunit/phpunit: ^11.0

MIT

• Paul M. Jones

README

This package includes two RequestInterop implementations: one readonly, and one mutable. It also includes an abstract RequestFactory class with the elements needed for creating your own implementations.

Notes

• No user or password in URL properties (deprecated in RFC 3986; sent by clients as Authorization: Basic header so not in URL anyway)

Readonly

The Readonly implementations cannot be modified after construction, and provide idempotent readonly access to the request body (but no access to the upload bodies).

use RequestInterop\Impl\Readonly\ReadonlyRequest;
use RequestInterop\Impl\Readonly\ReadonlyRequestFactory;

$factory = new ReadonlyRequestFactory();
$request = $factory->newRequest();
assert($request instanceof ReadonlyRequest::class);

Mutable

The Mutable implementations can be modified after construction, and provide non-idempotent readable access to the request body and each upload body.

use RequestInterop\Impl\Mutable\MutableRequest;
use RequestInterop\Impl\Mutable\MutableRequestFactory;

$factory = new MutableRequestFactory();
$request = $factory->newRequest();
assert($request instanceof MutableRequest::class);