Add headers to responses

Build Status Latest Stable Version Total Downloads Code Coverage License

Install

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.

composer require wyrihaximus/react-http-middleware-with-headers

This middleware adds all the headers passed into the constructor to the responses flowing through this middleware.

Usage

use React\Http\HttpServer;
use WyriHaximus\React\Http\Middleware\Header;
use WyriHaximus\React\Http\Middleware\WithHeadersMiddleware;
use WyriHaximus\React\Http\Middleware\WithRandomHeadersMiddleware;

$server = new HttpServer([
    /** Other middleware */
    new WithHeadersMiddleware(
        'X-Powered-By' => 'wyrihaximus.net (11.0.33)',
    ),
    new WithRandomHeadersMiddleware(
        1, // Minimum header count to attach
        2,  // Maximum header count to attach
        new Header('X-nanananana', 'Batcache'),
        new Header('X-Horde', 'For the Horde!'),
        new Header('X-Picard', 'Make it so'),
    ),
    /** Other middleware */
]);

Combined with wyrihaximus-net/x-headers you'll get an ever-growing set of Nerdy headers:

use React\Http\HttpServer;
use WyriHaximus\React\Http\Middleware\Headers;
use WyriHaximus\React\Http\Middleware\WithRandomHeadersMiddleware;
use WyriHaximusNet\XHeaders;

$server = new HttpServer([
    /** Other middleware */
    new WithRandomHeadersMiddleware(
        1,
        ceil(count(XHeaders\Headers::HEADERS) / 4), // Add up to 25% of the list to it
        ...Headers::fromIterable(XHeaders\Headers::HEADERS),
    ),
    /** Other middleware */
]);

This uses the Headers helper that can transform key value iterables like the following to an iterable with Header objects:

[
    'X-Header' => 'contents',
]

License

The MIT License (MIT)

Copyright (c) 2024 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.