README

PSR-17 http-factories implementation

The PSR-17 specification is about HTTP factories.

There are many PSR-17 interfaces and the purpose of this package is to regroup them all in one single interface: PSR17Interface.

This package also implements a PSR17 class which implements this interface and provide a basic implementation.

Requirements

PHP >= 7.4

Installation

composer require loophp/psr17

This package requires also a psr/http-factory-implementation. I advise to use nyholm/psr7 from Tobias Nyholm.

Usage

<?php

declare(strict_types=1);

namespace App;

use loophp\psr17\Psr17;
use Nyholm\Psr7\Factory\Psr17Factory;

include __DIR__ . '/vendor/autoload.php';

// In this example, I used nyholm/psr7
// But you could any another library of your choice.
$requestFactory = $responseFactory = $streamFactory = $uploadedFileFactory = $uriFactory = $serverRequestFactory = new Psr17Factory();

$psr17 = new Psr17($requestFactory, $responseFactory, $streamFactory, $uploadedFileFactory, $uriFactory, $serverRequestFactory);

$request = $psr17->createRequest('GET', 'https://github.com');
$response = $psr17->createResponse(200, 'hello');
$stream = $psr17->createStream('foobar');
$uploadedFile = $psr17->createUploadedFile($stream);
$uri = $psr17->createUri('https://github.com/loophp/psr17');
$serverRequest = $psr17->createServerRequest('GET', 'https://github.com/');

Integration with Symfony

Since the 29 of July, a Symfony recipe has been published for this package.

Therefore, if you're using Symfony Flex, then you don't have anything to do. When the package will be installed by Composer, Symfony Flex will install the configuration file in your application and automatically do the necessary services and interfaces wiring.

If you're not using Flex, add in services.yaml:

services:
  # Register loophp/psr17/Psr17 class and autowire/autoconfigure it.
  loophp\psr17\Psr17:
    autowire: true
    autoconfigure: true

  # Alias the service to the Psr17 interface.
  loophp\psr17\Psr17Interface: '@loophp\psr17\Psr17'

Once again, you will need to have proper wiring for the dependencies of the Psr17 class.

This is left up to the user but if you want a default implementation, you can use nyholm/psr7 which provides also a Symfony recipe with the required dependencies so the container will be able to autowire the Psr17 service.

Code quality, tests and benchmarks

Every time changes are introduced into the library, Github run the tests and the benchmarks.

The library has tests written with PHPSpec. Feel free to check them out in the spec directory. Run composer phpspec to trigger the tests.

Before each commit some inspections are executed with GrumPHP, run ./vendor/bin/grumphp run to check manually.

PHPInfection is used to ensure that your code is properly tested, run composer infection to test your code.

Contributing

Feel free to contribute by sending Github pull requests. I'm quite responsive :-)

Changelog

See CHANGELOG.md for a changelog based on git commits.

For more detailed changelogs, please check the release changelogs.

loophp / psr17

Maintainers

Details