hotaruma/pipeline

Pipeline library built on top of PSR-15, PSR-7, and PSR-11 standards for handling HTTP requests and responses with middleware support.

v0.2.3 2023-07-14 15:19 UTC

Requires

• php: >=8.1
• psr/container: ^2.0
• psr/http-server-middleware: ^1.0

Requires (Dev)

• mockery/mockery: ^1.6
• phpbench/phpbench: ^1.2
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10
• squizlabs/php_codesniffer: ^3.7

MIT

• Max Denusenko

• middleware
• pipeline
• psr-7
• PSR-11
• psr-15

README

Pipeline library for handling HTTP requests and responses with middleware.

Features

• Integration with PSR-7 HTTP messages and PSR-11 container.
• Support for middleware/pipeline chaining to process HTTP requests in a flexible way.

Installation

You can install the library using Composer. Run the following command:

composer require hotaruma/pipeline

Usage

Simple example of how you can use Pipeline to process an HTTP request:

use Hotaruma\Pipeline\Pipeline;

$pipeline = new Pipeline();

$pipeline->pipe(
    ErrorMiddleware::class,
    LogMiddleware::class,
    RouteMiddleware::class,
);

$response = $pipeline->process($serverRequest, RouteNotFoundMiddleware::class);

By nesting pipelines within one another, it becomes possible to compose more complex and reusable middleware structures, providing flexibility and modularity in application development.

$authPipeline = new Pipeline();

$authPipeline->pipe(
    AccessLogMiddleware::class,
    AuthMiddleware::class,
);

$pipeline->pipe(
    ErrorMiddleware::class,
    LogMiddleware::class,
    $authPipeline,
);

$response = $pipeline->process($serverRequest, RequestHandler::class);

Using a pipeline as a request handler.

$requestHandlerPipeline = new Pipeline();

$requestHandlerPipeline->pipe(
    LogMiddleware::class,
    RouteNotFoundMiddleware::class
);
$response = $pipeline->process($serverRequest, $requestHandlerPipeline);

Pipeline can be rewound.

$pipeline->rewind();

We can pass request handler as a callable.

use Zend\Diactoros\Response;
use GuzzleHttp\Psr7\Utils;

$response = $pipeline->process($serverRequest, function (ServerRequestInterface $request): ResponseInterface {
    return (new Response())
        ->withStatus(404)
        ->withHeader('Content-Type', 'text/plain')
        ->withBody(Utils::streamFor('Not Found'));
});

Resolvers are responsible for resolving middleware and request handler classes, allowing for dynamic retrieval and instantiation of these components within the pipeline. By default, pipelines usually use a specific resolver implementation.

use Hotaruma\Pipeline\Resolver\{MiddlewareResolver, RequestHandlerResolver};

$pipeline->middlewareResolver(new MiddlewareResolver());
$pipeline->handlerResolver(new RequestHandlerResolver());

$pipeline->getMiddlewareResolver()->container($container);
$pipeline->getRequestHandlerResolver()->container($container);

The middleware store is responsible for managing and storing the middleware that is added to the pipeline. It provides the necessary functionality to add, retrieve, and execute the middleware in the desired order.

use Hotaruma\Pipeline\MiddlewareStore\MiddlewareStore;

$pipeline->middlewareStore(new MiddlewareStore());

Contributing

Contributions are welcome! If you find a bug or have an idea for a new feature, please open an issue or submit a pull request.